Cloud API Docs logo Cloud API Docs Start Building
Documentation01 / Overview

Build on a cloud API designed for fast integration

Authenticate quickly, explore predictable endpoints, and ship faster with a straightforward request-response API.

  • Token-based authentication
  • Consistent JSON responses
  • Clear endpoint reference
Start Building Read Authentication
Your integration path: Overview → Authentication → Endpoints → FAQ

Integration guide / 02

Authentication

Authenticate each request with a bearer token to access the API securely.

  1. Obtain your credentials

    Create an API token in your platform's developer console. Store it in a server-side environment variable, not in your application code.

  2. Send the authorization header

    Include Authorization: Bearer <token> with every request. Send credentials only over HTTPS.

  3. Validate the response

    Check the HTTP status and response body. For a 401 Unauthorized response, verify the token and header before retrying.

API reference / 03

Endpoints

The API is organized around four core resources; use the patterns below to find the operations you need.

Core resource groups

Read the Authentication section

Projects

  • GET
  • POST
  • PATCH
  • DELETE

/v1/projects · /v1/projects/{project_id}

Create, list, and manage projects that organize your application resources and deployments.

Deployments

  • GET
  • POST
  • DELETE

/v1/projects/{project_id}/deployments

Create deployments within a project, inspect their status, and remove deployments you no longer need.

Usage

  • GET

/v1/projects/{project_id}/usage

Retrieve resource consumption for a project to track activity and understand usage over time.

Keys

  • GET
  • POST
  • DELETE

/v1/keys · /v1/keys/{key_id}

List and create API keys for integrations, or revoke a key to remove its access.

Documentation / 04

FAQ

Practical answers to keep your integration moving.

How do I handle rate limits?
If you receive a 429 response, pause requests and honor the Retry-After header when provided. Otherwise, retry with exponential backoff and jitter. Check your account’s limits before increasing request volume.
Why am I getting an authentication error?
For a 401, check that your credential is valid and sent in the required authorization header. For a 403, verify its permissions. Follow the Authentication guide to confirm your setup. Never include secrets in logs or support requests.
How should I manage API versions?
Use the version specified in the endpoint reference and keep it consistent across your integration. Before upgrading, review migration guidance and test changes in a non-production environment. Avoid assuming different versions have identical behavior.
What response formats should I expect?
Use each endpoint’s documented response schema and check the Content-Type header before parsing. Handle non-success status codes explicitly and allow for empty responses. See the endpoint reference for payload examples.
What should I expect when contacting support?
Include the endpoint, status code, request ID if available, and a minimal reproduction with secrets removed. Support availability and response commitments depend on your plan; check your agreement for applicable service levels.

Ready to make your first request?

Start Building