Cloud API Docs logo Cloud API Docs
Start building

Documentation

CLOUD API · DEVELOPER DOCS

Build with a cloud API that stays predictable.

A reliable, clearly documented API for getting integrations into production with confidence.

Start building See authentication
  • Secure authentication
  • Predictable endpoints
  • Fast integration
A request, through to response HTTPS · JSON

01 / REQUEST

POST /v1/jobs

02 / RESPONSE

202 Accepted 
POST /v1/jobs
Authorization: Bearer $API_TOKEN
Content-Type: application/json

{"name":"daily-sync"}

→ 202 Accepted
{"id":"job_8f2","status":"queued"}

Authenticate once, send a clear request, and get a structured response.

Platform overview

A clear path from API access to working integrations

Cloud API gives your team straightforward tools to authenticate, work with resources, and build dependable integrations.

Secure access

Authenticate requests with a bearer token and keep credentials out of client code.

Focused endpoints

Work with clearly organized resource routes and familiar HTTP methods.

Predictable responses

Use consistent response structures to make handling results more straightforward.

Integration-ready payloads

Send and receive JSON with examples that help you shape requests quickly.

  • Clear request patterns
  • Security-conscious access
  • Practical implementation guidance

Continue to authentication

GUIDE / AUTHENTICATION

Authenticate your first request

Use a bearer token to authenticate each request over HTTPS. Your API key identifies your workspace, and the server checks it before returning data.

  1. Get your credentials

    Create an API key in your developer console. Use a test key while building and grant it only the access your integration needs.

  2. Send the authorization header

    Include the key as a bearer token in the Authorization header on every HTTPS request—not in the URL.

  3. Verify the first response

    A successful request returns 200 OK with JSON. For 401 or 403, check the key and its permissions.

REQUEST EXAMPLE GET /v1/projects 
curl --request GET \
  --url https://api.cloud.example/v1/projects \
  --header "Authorization: Bearer ${CLOUD_API_KEY}" \
  --header "Accept: application/json"

Keep keys secure. Store API keys in environment variables or a secrets manager. Never commit them to source control or expose them in client-side code.

Replace the example host with the API base URL for your workspace.

API reference / Operations

Endpoints

Six practical endpoint groups cover the most common ways to work with the platform.

Projects

GETPOST

/v1/projects

Create projects and retrieve the projects available to your account.

API keys

GETPOSTDELETE

/v1/keys

Create, list, and revoke the API keys used by your integrations.

Events

GETPOST

/v1/events

Submit events for processing and inspect previously accepted events.

Usage

GET

/v1/usage

Review request totals and usage metrics for a selected time range.

Webhooks

GETPOSTPATCHDELETE

/v1/webhooks

Configure webhook destinations and manage event delivery settings.

Files

GETPOSTDELETE

/v1/files

Upload, retrieve, and remove files associated with your API resources.

Example request

GET /v1/projects?limit=20

Questions about limits, errors, or edge cases? Browse the FAQ about API edge cases.

FAQ

Practical answers to help you move from setup to a reliable integration.

How are rate limits applied?

Limits can vary by credential, plan, or endpoint. When you receive a 429 response, honor Retry-After if present; otherwise retry with capped exponential backoff and jitter.

How should I handle API versions?

Pin an explicit API version for each integration. Before changing it, review the release notes and migration guidance; do not assume a newer version is backward-compatible.

Is there a sandbox or test environment?

Use sandbox credentials to test without affecting live data. Keep test and production credentials separate, and verify which environment your requests target before troubleshooting results.

What should I do when a request fails?

Check the HTTP status and structured error code. Retry transient 429 or 5xx responses with backoff; fix validation or authentication errors before retrying. Include the request ID in logs, but never log credentials.

What information should I include when contacting support?

Share the request ID, endpoint, UTC timestamp, environment, and a minimal reproduction through your account’s support channel. Remove secrets and sensitive data; response times depend on your support plan.