Skip to main content

​
Base URL

​
Authentication

All authenticated endpoints require an API key:
API keys are project-scoped. All queries are automatically filtered by the API key’s project. Keys are returned once (the raw tc_... value); only a hash and the tc_xxxxxxxx prefix are stored.

​
Platform credential

The two bootstrap endpoints — POST /v1/projects and POST /v1/api-keys — sit before any API key exists, so they are gated by a single platform credential instead:
The header must match the server’s PLATFORM_API_KEY setting. The gate fails closed: if PLATFORM_API_KEY is unset, every bootstrap call is rejected. This identifies a privileged caller (the platform builder), not a user — everything after bootstrap uses project-scoped tc_... keys.

​
Roles

​
Resource Lifecycle

The typical setup order — each resource is scoped to the project of the API key that creates it:

​
Response Format

​
Success

​
Error

code is a stable machine-readable string; error is the human-readable message. details and request_id are included when available.

​
Pagination

​
Error Codes