Cloud API Platform Docs

Developer-first documentation for a fast, reliable Cloud API

Concise references, clear examples, and predictable endpoints to help you integrate quickly and scale with confidence.

Overview

Cloud API Platform provides a fast, reliable interface for integrating compute, storage, and messaging services into your applications. This documentation focuses on clear, consistent endpoints and predictable behaviors to streamline development and reduce integration time.

Unified API surface. Access core services with a single authentication model and consistent request patterns.
Low-latency responses. Optimized routing and edge caching for predictable performance.
Structured error model. Clear error codes and trace identifiers to simplify debugging.
Versioned endpoints. Backward-compatible upgrades with explicit version control.

Docs • Authentication

Authentication

All requests to the Cloud API Platform must be authenticated with an API key and access token. Provide the key using the x-api-key header and the token using the Authorization: Bearer header. Tokens are short-lived and should be refreshed using your client credentials flow.

Example request

Send your API key and token on every request.

cURL POST /v1/compute/jobs

curl -X POST "https://api.cloudplatform.dev/v1/compute/jobs" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "region": "us-east-1",
    "image": "python:3.12",
    "command": "python main.py"
  }'

Endpoints

Example endpoints for common operations. Use HTTPS and include your API key in the Authorization header.

Method	Path	Description
GET	/v1/projects	List projects accessible to the API key.
POST	/v1/projects	Create a new project.
GET	/v1/projects/{projectId}	Retrieve a single project by ID.
POST	/v1/tokens	Create a short-lived access token.
DELETE	/v1/tokens/{tokenId}	Revoke an access token.

Sample response

Response for GET /v1/projects

{
  "data": [
    {
      "id": "proj_4b21",
      "name": "Billing Service",
      "region": "us-east-1",
      "createdAt": "2026-03-06T11:18:00Z"
    },
    {
      "id": "proj_9f82",
      "name": "Webhooks",
      "region": "eu-west-1",
      "createdAt": "2026-03-01T09:42:00Z"
    }
  ],
  "next": null
}

Frequently asked questions

Can’t find the answer you’re looking for? Reach out to our support team.

How do I authenticate requests to the API?: Send your API key in the Authorization header using the Bearer scheme. Keys are scoped per workspace.
What are the default rate limits?: The default limit is 600 requests per minute per key. Burst traffic is allowed within a short window and may return 429 responses.
How do I paginate list endpoints?: Use page and page_size query parameters. The response includes next_page and prev_page metadata.
Why am I getting a 401 or 403 error?: Verify the API key is active, has access to the target workspace, and that the request is sent over HTTPS.
How can I troubleshoot timeouts?: Retry with exponential backoff, confirm the endpoint path and region, and check the status page for incident reports.