Skip to content
sign in

==> call the api

A project's own API document

GET /v1/p/{slug}/openapi.json

The OpenAPI document of one of the account's projects, built from its routes with its live release (?format=md for the Markdown rendering). Someone else's project is a 404.

Needs a personal access token: Authorization: Bearer <token>.

Parameters

nameintypewhat
slugpathstringrequired

Answer

200 Success.

Refusals

Each answers { "error": "...", "code"?: "..." } with its status.

statuswhen
401No valid token.
404No such project, or it has no document yet (a release from before routes were described).

Example

curl 'https://api.clusterstuck.sh/v1/p/{slug}/openapi.json' \
  -H 'Authorization: Bearer <your token>'