Cloud API platform

Build against the API with confidence.

Clear reference patterns for authentication, REST endpoints, and dependable JSON responses.

Start building Go to Authentication
  • Secure auth
  • Predictable endpoints
  • JSON responses
POST /v1/projects
201

Request

curl -X POST \
  /v1/projects \
  -H "Authorization: Bearer …" \
  -d '{
    "name": "edge-service"
  }'

Response

{
  "id": "prj_7z4…",
  "status": "active",
  "created_at": "2026-10-07…"
}

Platform overview

A predictable path from request to response.

The platform is organized around secure access, stable REST resources, and implementation-ready examples.

  • Resource-oriented REST endpoints
  • Scoped access for every request
  • Consistent request conventions
  • Structured JSON output
  • REST-based
  • Token auth
  • JSON responses
Request flow v1
Client
Auth
API
Authorization: Bearer … 200 application/json

Security setup

Authentication

Send your API key as a bearer token with every request to the Cloud API.

Implementation flow

3 steps

  1. Create an API key

    Generate a key in your project settings and copy it once.

  2. Store it outside your source code

    Load the key from a server-side environment variable at runtime.

  3. Authorize each request

    Pass the key in the Authorization header.

Token request cURL 
curl https://api.cloudplatform.dev/v1/projects \
  -H "Authorization: Bearer $CLOUD_API_KEY" \
  -H "Accept: application/json"

API reference

Endpoints

Predictable REST resources, concise request shapes, and JSON responses designed for quick integration.

GET Collection

/v1/projects

List projects available to the authenticated workspace.

Response · 200 OK with a project array and cursor metadata.

POST Create

/v1/projects

Create a project with its initial configuration and ownership settings.

Response · 201 Created with the new project resource.

GET Resource

/v1/projects/{project_id}

Retrieve one project by its stable identifier.

Response · 200 OK with the full project object; 404 if it is unavailable.

Implementation support

Frequently asked questions

Practical answers to common setup questions before you ship your first integration.

Why am I receiving 401 or 403 responses?

A 401 usually means the bearer token is missing, expired, or malformed. A 403 means the token is valid but does not include the scope required by the requested resource. Verify the Authorization header and the token scopes assigned to your project.

What are the API rate limits?

Limits are applied per project and endpoint group. Every response includes rate-limit headers so your client can track the remaining quota and reset window. On a 429 response, retry with exponential backoff and honor the Retry-After header.

What response format does the API use?

All successful and error responses are UTF-8 JSON. Resource data is returned under a data field, while errors include a stable code, a readable message, and an optional details object for field-level context.

How does API versioning work?

Versions are specified in the URL, such as /v1/. Additive changes may ship within a version; breaking changes are released in a new version and announced before deprecation windows begin.

How can I test my integration safely?

Create a test project to receive isolated credentials and sample data. Use test mode for development, validate webhooks with the supplied signing secret, and switch to production credentials only after your integration passes end-to-end checks.

Ready to make your first authenticated request?

Start building