Automate canvases, executions, and org workflows the same way the platform does.

Use the SuperPlane API to provision canvases, ship configuration-as-code updates, trigger runs, inspect execution state, manage API keys, and control organization-level settings from CI, internal tooling, or your own platform workflows.

Canvases Create, version, update, delete, and inspect canvases and related runtime state.
Executions Trigger workflows, inspect outputs, invoke actions, resolve failures, and cancel in-flight work.
Organizations Manage integrations, invitations, usage, roles, groups, users, and other org-scoped settings.
Automation identities Use API keys for CI/CD and non-human access with scoped org or app permissions.

Quickstart Bearer auth

# Verify the token
$ curl -X GET "$API_BASE/api/v1/me" \
  -H "Authorization: Bearer $SUPERPLANE_API_TOKEN" \
  -H "Accept: application/json"

# List canvases
$ curl -X GET "$API_BASE/api/v1/canvases" \
  -H "Authorization: Bearer $SUPERPLANE_API_TOKEN" \
  -H "Accept: application/json"

In the reference below, click Authorize and paste either a raw token or Bearer <token>. If you need more context on what a resource, workflow concept, or integration means, see docs.superplane.com.

Personal access

Create a personal API token

Use this for local development, manual scripts, and workflows tied to a human user.

Open Settings > Profile in the SuperPlane app.
Select Generate Token or Regenerate Token.
Copy the token immediately. It is shown only once.

API keys

Create an API key token

Use this for CI/CD, platform automation, and machine-to-machine access.

Open Settings > API Keys.
Create an API key and assign it the correct role, access scope, and optional expiration.
Generate or regenerate its token and store it securely. It is shown only once.

Reference flow

Use Swagger without the UI chrome

The reference below stays generated from the OpenAPI document, but the presentation is cleaned up for public use.

Use Authorize in the Swagger toolbar to set your token.
Empty plural service tags are removed from the rendered reference.
The raw OpenAPI JSON remains unchanged for generators and SDK consumers.

API Reference

Click Authorize to authenticate requests. If you paste a raw token, the docs automatically send it as Bearer <token>.

Raw JSON