API reference · Posts

Publish or schedule post

POST /v1/posts

Publish or schedule a post

Request

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

curl -X POST https://api.postlake.dev/v1/posts \
  -H "Authorization: Bearer $POSTLAKE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"…","profile":"…","platforms":["…"],"accounts":["…"]}'

Parameters

FieldTypeRequiredWhat it is
Idempotency-KeystringNoIdempotency Key

Body

FieldTypeRequiredWhat it is
textstringYes
profilestringNoA profile name. Resolves to every account it owns. The simple way to address accounts; combine with `platforms` to narrow it. Provide `profile`, `accounts`, or both.
platformsarrayNoOptional filter. Keeps only these networks from the resolved set (e.g. profile "my-brand" + platforms ["bluesky"]).
accountsarray of stringNoConnected account ids (acc_…). An alternative (or addition) to `profile`.
mediaarray of stringNo
scheduledAtstringNoUTC with a trailing Z, or a naive local time together with timezone.
timezonestringNoIANA timezone (e.g. Europe/London). Interprets a naive scheduledAt as wall time in that zone.
platformOptionsobjectNo
platformOptions.pinterestobjectNo
platformOptions.tiktokobjectNoSee GET /v1/platforms/tiktok for the full option set and valid values.

Response

Created (201).

Example

"…"

What it costs

One credit per network the post actually reaches. X costs more, because X is the only network that charges us per post: six credits for text and seventy-two with a link. Nothing is charged for a target that fails, and a post refused by pre-flight never touches the ledger at all.

Publishing endpoints are limited to 60 requests a minute per account, inside a wider ceiling of 600 a minute across the whole API. Every response carries X-RateLimit-Remaining and X-RateLimit-Reset.

Calling this from an agent

Agents do not call REST. They call tools. Over the hosted MCP server this operation is create_post, and the agent authorises with OAuth so your API key is never pasted into a chat or seen by the model. The reply comes back in the same normalised shape you see above, which is what lets an agent reason about it without a per-network branch.

You control what any one agent may do with it: which brands it may act for, which networks it may reach, how much it may do in a day, and whether it may spend credits you bought up front. See the MCP server.

Errors

Every failure uses one shape: a stable type, a granular code, the field at fault in param, and a plain-language fix. An agent can act on it without a person reading the message. See Errors and retries.

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

Common questions

Can an AI agent do this without the REST API?

Yes. Over MCP the same job is the create_post tool. The agent authorises with OAuth, so no API key is pasted into a chat or seen by the model, and the answer comes back in the same normalised shape.

Is it safe to retry this call?

Yes. Send the same Idempotency-Key and a call that already succeeded returns its original result instead of repeating the work. That is what makes it safe to hand to an agent that retries on its own.

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.

Related