Documentation (Preview).

Getting Started

The Atlas API is in Early Access. The interface described here is conceptual and marked as Preview. No live endpoints are published until the underlying functionality exists.

When the API becomes available, the typical workflow will be:

1. Create an Atlas account.
2. Generate an API key from the developer settings.
3. Send authenticated requests to api.atlasdigitalsystems.co/v1/… (Preview — not a live endpoint).
4. Handle responses and errors as described below.

Authentication

Authentication will use API keys sent as a bearer token in the Authorization header:

# Example — Preview (not a live endpoint)
curl https://api.atlasdigitalsystems.co/v1/chat \
  -H "Authorization: Bearer $ATLAS_API_KEY"

Treat API keys as secrets. Do not embed them in client-side code or commit them to source control. Use environment variables or a secrets manager.

Rate Limits

API requests will be subject to rate limits. Exact limits will be published when the API is live. When rate-limited, responses will return HTTP 429 with a Retry-After header.

Errors

Errors will be returned with a consistent JSON shape and a meaningful HTTP status code. The planned shape:

// Example — Preview (not a live endpoint)
{
  "error": {
    "type": "invalid_request_error",
    "message": "Missing required field: messages",
    "code": "missing_field"
  }
}

Pagination

List endpoints will support cursor-based pagination. Responses will include next_cursor when more results are available. Pass it as the cursor query parameter on the next request.