API Reference

The API behind the in-site editor — sessions, shared drafts, publishing, and AI generation.

Everything the docs.dev editor does — signing in, autosaving shared drafts, publishing to GitHub, generating content with AI — goes through this same-origin API, documented here from its OpenAPI schema. Each endpoint page includes an interactive playground.

Auth

Sign in with a PIN

Exchanges the team PIN for a sealed session cookie.

Sign in with GitHub

Starts the GitHub App OAuth flow.

Inspect the current session

Sign out

Clears the session cookie.

Drafts

Shared drafts visible to every editor, with a last-writer conflict guard.

Read a draft, or list all drafts

With slug, returns that page's shared draft (or null).

Delete a draft

Save a draft

Saves the shared draft for a page.

Publish

Commit a page (and its uploaded assets) to GitHub.

Publish a page

Commits the page's MDX (and any uploaded assets) to the docs repository.

AI

Workers AI documentation writing and image generation.

Check AI availability

Whether this deployment can generate content (Workers AI binding present).

Generate documentation or an image

With kind: "doc" (the default), writes markdown for the editor to splice in as editable blocks — optionally grounded in web search results, which are cited inline.