Cloud API Docs logo Cloud API Docs
Cloud API Docs logo Cloud API Docs
Start building

Cloud API documentation

Your fastest path to a successful API call.

Clear guides, structured endpoints, and practical examples to take you from first read to first response.

Start building: set up authentication Read overview
  • Clear auth flowGet credentials and make your first request.
  • Structured endpointsFind methods, parameters, and responses fast.
  • Quick answersResolve common questions without detours.

Request flow

A clear path to your response

Ready to build
01

AUTHENTICATION

Bearer token

Setup
02

ENDPOINT

GET /v1/resources

200 OK
03

RESPONSE

Useful data, clearly documented

docsguidesfirst-request

Authentication → endpoint → response

01 / Platform overview

A clear path from API reference to your first request.

Cloud API gives your application a consistent way to access platform services. Use these docs to understand the surface area, authenticate, and make a working request.

  • Platform overview

    Learn the core concepts and API boundaries.

  • Authentication

    Configure credentials before calling an endpoint.

  • Endpoint reference

    Find methods, parameters, and response details.

  • Request examples

    Adapt working patterns for your integration.

Authentication

Make your first authorized request

Create an API key, keep it private, then send it as a bearer token with each request.

  1. Create a key

    Generate an API key in your project settings and copy it once.

  2. Store it securely

    Load the key from a server-side environment variable. Never expose it in browser code.

  3. Send a bearer token

    Include the key in the Authorization header on each API call.

Example request HTTP 
curl https://api.cloud.example/v1/projects \
  -H "Authorization: Bearer $CLOUD_API_KEY" \
  -H "Content-Type: application/json"

API reference Endpoints

Explore the endpoint groups

Find the capability you need, then use its routes to shape your first request.

Projects

Core

Create and manage the projects that organize your cloud resources.

GET POST DELETE

Route/v1/projects

Use for: setting up a workspace for your integration.

Resources

Data

Read and update the records connected to a project.

GET PATCH DELETE

Route/v1/resources/{id}

Use for: retrieving or changing a specific resource.

Jobs

Async

Submit long-running work and check its processing status.

GET POST

Route/v1/jobs

Use for: tracking work that completes asynchronously.

Help & troubleshooting

Frequently asked questions

Quick answers to common questions as you get your first requests running.

Why is my request returning an authentication error?

Check that your API key is active and sent in the Authorization: Bearer header. Keep keys out of query strings and client-side code.

What happens when I reach a rate limit?

限Rate-limited requests return 429. Use the response’s Retry-After value and retry with exponential backoff.

How are API versions handled?

Requests use the version configured for your project. Pin a version in production and review the changelog before upgrading.

Can I test without affecting live data?

Use your sandbox credentials to make test requests. Sandbox activity is isolated from live data; switch to live credentials only when you are ready.

Where can I get help if I’m stuck?

Contact support with the request ID, endpoint, and approximate time. Never include secret keys or other credentials in your message.