Cloud API Docs logo Cloud API Docs
Cloud API Docs logo Cloud API Docs

Cloud API · Developer documentation

Build with a cloud API that stays clear.

A reliable, predictable API—and practical docs to get your first request working faster.

Start Building View Authentication
  • Secure access
  • Predictable endpoints
  • Clear responses

Request flow

200 OK

Your app

Create a project

POST /v1/projects

Cloud API

Structured response

{ "id": "prj_…",  "status": "ready" }
Authenticated · JSON · predictable

A request in. A useful response out.

Platform fundamentals

Overview

A dependable cloud API for connecting your product to the services and data it needs.

One API, practical building blocks

Use a consistent interface to access platform capabilities, integrate them into your application, and build workflows around your product needs.

A clear path through the docs

Start with authentication, find the operation you need in the endpoint reference, then use the examples and response details to shape your integration.

Predictable responses

Requests return structured JSON, with consistent status codes and error details to help you handle success and failure cases confidently.

Base URL

https://api.example.com/v1

Use this root for API requests.

Response format

application/json

Responses use JSON unless noted.

Error handling

Status code + error details

Check both to identify and handle failures.

Access & security

Authentication

Authenticate each request with an API token. Set it up once, then keep the secret on your server.

  1. Obtain credentials

    Create an API token in your Cloud API dashboard. Use a separate token for each environment.

  2. Authorize each request

    Send the token in the Authorization header using the Bearer scheme.

  3. Keep it server-side

    Load the token from a server-side environment variable. Never expose it in browser code or a public repository.

Authorization header HTTP 
Authorization: Bearer <YOUR_API_TOKEN>

Replace the placeholder with your server-side token.

Continue to Endpoints

API reference

Endpoints

Explore the core API areas and choose a starting point for your integration.

Projects

Create and manage the projects that organize your API resources.

GET POST DELETE

Deployments

Submit deployments and inspect their current state and details.

GET POST

Usage

Retrieve usage summaries to understand activity over a selected period.

GET

Webhooks

Configure event destinations and review webhook delivery records.

GET POST PUT DELETE

Need help choosing an integration path?

Visit the FAQ

Support

Frequently asked questions

Quick answers to common questions about integrating with the Cloud API.

How do I get an API key?

Create a project in the dashboard, then generate a key in its API credentials settings. Keep secret keys on your server and out of client-side code.

What happens when I reach the rate limit?

Requests over your limit receive a 429 response. Check the rate-limit headers and retry after the indicated interval, using backoff for repeated retries.

How are API versions handled?

Requests use the version specified in the API version header. Pin a version in production and review the migration notes before upgrading.

How should I handle error responses?

Use the HTTP status code to classify the failure, then inspect the response body’s error code and message. Retry transient server errors with backoff; correct client errors before retrying.

Can I test integrations in a sandbox?

Yes. Use sandbox credentials to send test requests without affecting production data. Switch to live credentials only after validating your integration.

Ready to integrate?

Put the API to work in your project.

Start Building