# API reference

Request and response contracts generated from Postdot's server routes.

URL: /docs/reference

Browse operations by domain in the sidebar. Each page describes one HTTP operation,
including its parameters, request body, declared responses and authentication.
These pages are generated from the same Elysia route definitions as the server.

## Start with a workflow [#start-with-a-workflow]

For a complete draft workflow, follow the [CLI guide](/docs/automation/).
For direct HTTP access, read [authentication](/docs/reference/authentication/), then
inspect the operations you need:

- [List your projects](/docs/reference/projects/listProjects/).
- [List project channels](/docs/reference/channels/listProjectChannels/).
- [Create a post and its destination drafts](/docs/reference/posts/createPost/).

API-key permissions and project roles still apply. The authentication guide
explains [how to read security declarations](/docs/reference/authentication/#read-authentication-in-the-reference),
including operations that accept only a human session.

## Use your instance [#use-your-instance]

Code examples use `https://postbot.example` as a placeholder. Replace it with your
instance's origin. The public documentation does not execute requests or store
credentials; request playgrounds are disabled.

[Download the OpenAPI JSON](/reference/postbot-openapi.json) for this source
revision. A deployed instance also exposes its own schema at `/openapi/json` and
an interactive explorer at `/openapi`. For the default local installation, open
`http://127.0.0.1:3000/openapi`.

A deployed instance may run a different version. Use its own schema when matching
an integration to that installation. The generated reference covers the domain
routes and signed media delivery; it does not enumerate Better Auth's dynamically
mounted endpoints or optional monitoring routes. Where a route declares no
response schema, the reference says so rather than inventing one.