API Reference & Guides

Developer Documentation

Last Updated: July 3, 2026

Overview

The Atlas Revenue AI platform exposes a RESTful API that lets developers programmatically access revenue forecasts, account intelligence, deal war rooms, and executive briefings. All endpoints are versioned (/v1/) and return JSON.

The API is organized around predictable, resource-oriented URLs, uses standard HTTP response codes, and supports both API key authentication and signed webhooks for real-time event delivery.

Base URL

text
https://api.atlasrevenueai.com/v1

Authentication

Atlas uses Bearer token authentication. Include your API key in theAuthorizationheader of every request. API keys can be generated from the Atlas admin dashboard under Settings → API Keys.

bash
curl https://api.atlasrevenueai.com/v1/executive-briefing \
  -H "Authorization: Bearer $ATLAS_API_KEY"

Never expose your secret API key in client-side code. Use a backend proxy for browser-based calls.

Quickstart

Make your first request in under a minute. Choose your preferred language:

cURL
curl -X POST https://api.atlasrevenueai.com/v1/revenue/forecast \
  -H "Authorization: Bearer $ATLAS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "timeframe": "quarterly",
    "segments": ["enterprise", "mid_market"]
  }'

A successful response returns the forecast ID, predicted revenue, and confidence score.

SDKs

Official SDKs are available to accelerate integration. Install the one matching your stack:

JavaScript / TypeScript
bash
npm install @atlasrevenueai/sdk
Python
bash
pip install atlas-revenue-ai

API Reference

Generate a revenue forecast for a given timeframe and segment set.

Parameters

NameTypeRequiredDescription
timeframestringYesOne of: monthly, quarterly, annual.
segmentsarray[string]NoFilter by revenue segment IDs.

Example Response

json
{
  "forecast_id": "fc_8x2k9",
  "predicted": 4280000,
  "confidence": 0.92,
  "currency": "USD",
  "breakdown": [
    { "segment": "enterprise", "predicted": 3100000 },
    { "segment": "mid_market", "predicted": 1180000 }
  ]
}

Webhooks

Atlas can push real-time events to your endpoint whenever revenue-critical changes occur. Register a webhook via the API, then verify theAtlas-Signatureheader on every delivery using your webhook secret.

deal.stage_changeFired when a deal moves to a new stage.
risk.detectedFired when Atlas AI flags a new revenue risk.
forecast.updatedFired when the revenue forecast is recalculated.
account.health_changedFired when an account health score crosses a threshold.
war_room.readyFired when a Deal War Room finishes its initial analysis.

Signature Verification

javascript
import crypto from "crypto";

function verifyWebhook(rawBody, signatureHeader, secret) {
  const expected = crypto
    .createHmac("sha256", secret)
    .update(rawBody)
    .digest("hex");
  return crypto.timingSafeEqual(
    Buffer.from(expected),
    Buffer.from(signatureHeader)
  );
}

Rate Limits

API requests are rate-limited to 1,000 requests per minute per organization. Rate limit headers are included on every response:

X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-Reset

If you exceed the limit, you'll receive a 429 Too Many Requests response.

Errors

Atlas uses conventional HTTP status codes. Errors return a structured body:

json
{
  "error": {
    "code": "invalid_request",
    "message": "The 'timeframe' parameter must be one of: monthly, quarterly, annual.",
    "type": "validation_error"
  }
}
400Bad Request — invalid parameters
401Unauthorized — missing or invalid API key
404Not Found — resource does not exist
429Rate Limited — too many requests
500Server Error — try again or contact support

Security

All API traffic is encrypted via TLS 1.2+. API keys are scoped per-environment (production, sandbox). For security details and data handling policies, see ourSecurity page.

Versioning

The API is versioned via the URL path (e.g. /v1/). Breaking changes will increment the version. Deprecation notices are sent via email and dashboard alerts at least 90 days before a version is sunset.

Support

For integration help, reach out todeveloper@atlasrevenueai.comor use the in-app developer chat. Our team typically responds within one business day.