For AI agents: a documentation index is available at /llms.txt. Every guide and example is also available as markdown by adding .md to its URL.

Authentication

Schedulin authenticates API requests with an API key passed in the x-api-key header.

curl https://api.schedulin.app/v0/posts \
  -H "x-api-key: $SCHEDULIN_API_KEY"

IMPORTANT

API keys go in , . The header is reserved for issued to app clients — an API key sent as a bearer token is rejected with .

API keys

Create and revoke keys under Settings → API & Apps → Personal Keys.
Keys are workspace-scoped — a key can only read and write the workspace it was created in.
A key is a 64-character random string with no fixed prefix. The full secret is shown once at creation. If you lose it, delete the key and create a new one.

WARNING

Treat API keys like passwords. Never commit them to source control or ship them in client-side code. Load them from an environment variable (the examples in these docs use ) or a secret manager.

Unauthenticated requests

Requests with a missing, malformed, or revoked key return 401 Unauthorized:

{
  "defined": false,
  "code": "UNAUTHORIZED",
  "status": 401,
  "message": "Unauthorized",
  "data": { "message": "UNAUTHORIZED" }
}

See Error Handling for the full error model.