API explorer

The full API surface is browseable through an embedded Scalar UI: authentication, request bodies, response codes, and a “Try it” panel for every endpoint.

It opens in a dedicated, full-viewport page (the docs layout’s sidebar + max-width container fights with Scalar’s own overlays, so we host the explorer separately).

Launch API explorer →

OpenAPI document

The same spec the explorer renders is served by the control plane at GET /api/v1/openapi.yaml and mirrored from the docs site at openapi/gocdnext.yaml. Point any OpenAPI 3.1 generator at either URL to mint a typed client.

npx @hey-api/openapi-ts -i https://gocdnext.example.com/api/v1/openapi.yaml -o ./src/client

oapi-codegen -package gocdnext https://gocdnext.example.com/api/v1/openapi.yaml > client.go

openapi-python-client generate --url https://gocdnext.example.com/api/v1/openapi.yaml