Skip to main content

​
Overview

The Atomic AGI API provides programmatic access to your AI search visibility data, allowing you to build custom integrations, dashboards, and automated workflows.

​
Base URL

All API requests should be made to: 
https://api.atomicagi.com/v1

​
Authentication

All API endpoints require authentication using Bearer tokens. Include your API key in the Authorization header: 
curl -X GET "https://api.atomicagi.com/v1/projects" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Getting Your API Key

  1. Log in to your Atomic AGI dashboard
  2. Navigate to Settings > API
  3. Generate a new API key
  4. Store it securely (you won’t be able to see it again)
Keep your API key secure. Never expose it in client-side code or public repositories.

​
Rate Limits

API requests are rate-limited to ensure fair usage:
PlanRequests per minuteRequests per day
Free10100
Pro605,000
Enterprise30050,000
Rate limit information is included in response headers: 
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1640000000

​
Response Format

All responses are returned in JSON format.

​
Success Response

{
  "success": true,
  "data": {
    // Response data
  }
}

​
Error Response

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  }
}

​
Common Error Codes

CodeDescription
UNAUTHORIZEDInvalid or missing API key
FORBIDDENNo access to this resource
NOT_FOUNDResource not found
RATE_LIMITEDToo many requests
VALIDATION_ERRORInvalid request parameters
SERVER_ERRORInternal server error

​
Available Endpoints

​
Reports

Retrieve aggregated analytics data:
  • GET /reports/visibility - Get visibility metrics
  • GET /reports/sentiment - Get sentiment analysis
  • GET /reports/position - Get position data

​
Projects

Manage your projects:
  • GET /projects - List all projects
  • GET /projects/{id} - Get project details
  • GET /projects/{id}/prompts - Get project prompts
  • GET /projects/{id}/competitors - Get project competitors

​
Chats

Access individual AI responses:
  • GET /chats - List collected chats
  • GET /chats/{id} - Get chat details

​
Pagination

List endpoints support pagination: 
GET /chats?page=1&limit=50
Response includes pagination metadata: 
{
  "success": true,
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 1250,
    "totalPages": 25
  }
}

​
Filtering

Many endpoints support filtering: 
GET /chats?platform=chatgpt&startDate=2024-01-01&endDate=2024-01-31
Common filter parameters:
ParameterDescription
platformFilter by AI platform
startDateStart of date range
endDateEnd of date range
promptFilter by prompt ID
mentionedFilter by mention status

​
Webhooks

Subscribe to real-time events via webhooks: 
POST /webhooks
{
  "url": "https://your-server.com/webhook",
  "events": ["audit.completed", "visibility.changed"]
}

​
SDKs

We provide official SDKs for popular languages:
  • JavaScript/TypeScript: npm install @atomicagi/sdk
  • Python: pip install atomicagi

API Reference

View detailed endpoint documentation