# OpenAPI Specification

> Markdown version of https://docs.postlake.dev/api/get-openapi-json . The canonical page for humans.
> PostLake is the social media API for AI agents: https://postlake.dev/llms.txt

`GET /openapi.json`

Returns this OpenAPI specification

## Request

Authenticate with a bearer API key. Agents calling over MCP authorise with OAuth instead and never handle the key.

```bash
curl -X GET https://api.postlake.dev/openapi.json \
  -H "Authorization: Bearer $POSTLAKE_API_KEY"
```


## Response

Success (`200`).



### Example

```json
{}
```


## Calling this from an agent

Agents working over the hosted MCP server reach the same product through tools rather than REST, and authorise with OAuth so your API key is never pasted into a chat.

## Errors

Every failure uses one shape: a stable `type`, a granular `code`, the field at fault in `param`, and a plain-language `fix`. See https://docs.postlake.dev/errors.md .

Retries are safe: send the same `Idempotency-Key` and a call that already succeeded returns its original result rather than repeating it.

## Common questions

**How often can I call this?**

Reads are rate limited per account and every response carries X-RateLimit-Remaining and X-RateLimit-Reset. On a 429 the Retry-After header tells you how long to wait.

**What happens when it fails?**

You get one error shape: a stable type, a granular code you can branch on, the offending field in param, and a fix written so an agent can correct itself rather than stop. Full list on Errors and retries.