Developer reference

SuperPlane API

Use the OpenAPI 3 specification to explore endpoints and generate clients for SuperPlane.

Authentication and access

Downloading this specification does not require authentication. API requests still require the credentials and permissions configured for your SuperPlane workspace. Consult the interactive API reference for authorization instructions.

Schema source

Generated from the application protobuf definitions for v1.0.0-rc7 and validated during the website build.

Self-hosted installations use their own base URL. Set the server URL in your generated client to match your installation.

Read the SuperPlane documentation