Ataiva API Documentation
Version: v1 · Base URL: https://ataiva.com/api/v1/
ENDPOINTS
Authentication
Authenticated endpoints require a Bearer token in the Authorization header. Get your API key from /settings/.
Authorization: Bearer YOUR_API_KEY
Rate Limits
All authenticated endpoints: 60 requests/minute. The instant report endpoint is limited to 3 requests/hour per IP.
GET /api/v1/brands/
List all brands associated with your account.
Authentication: Required (Bearer token)
Parameters
| Name | Type | Description |
|---|---|---|
| No parameters | ||
Request
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://ataiva.com/api/v1/brands/
Response
{
"brands": [
{
"name": "Acme",
"slug": "acme",
"domain": "acme.com",
"overall": 72.5
}
]
}
GET /api/v1/brand/{slug}/scores/
Get visibility scores for a specific brand across all AI engines.
Authentication: Required (Bearer token)
Parameters
| Name | Type | Description |
|---|---|---|
slug | string | Brand slug (URL path) |
Request
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://ataiva.com/api/v1/brand/acme/scores/
Response
{
"brand": "Acme",
"scores": [
{
"engine": "ChatGPT",
"score": 80.0,
"period": "weekly",
"checked_at": "2026-04-20T12:00:00Z"
}
]
}
POST /api/track/
Track AI-referred traffic. Used by the JavaScript snippet.
Authentication: API key in request body
Parameters
| Name | Type | Description |
|---|---|---|
key | string | Your API key |
brand | string | Brand slug |
referrer | string | Page referrer URL |
page | string | Current page URL |
ua | string | User agent string |
sid | string | Session ID |
Request
curl -X POST https://ataiva.com/api/track/ \
-H "Content-Type: application/json" \
-d '{
"key": "your-api-key",
"brand": "acme",
"referrer": "https://chat.openai.com",
"page": "/pricing/",
"ua": "Mozilla/5.0...",
"sid": "abc123"
}'
Response
{
"ok": true,
"tracked": true
}
POST /api/instant-report/
Generate a free AI visibility report. No authentication required.
Authentication: None (rate limited to 3/hour per IP)
Parameters
| Name | Type | Description |
|---|---|---|
brand_name | string | Brand name |
domain | string | Brand domain |
Request
curl -X POST https://ataiva.com/api/instant-report/ \
-H "Content-Type: application/json" \
-d '{
"brand_name": "Acme",
"domain": "acme.com"
}'
Response
{
"report_id": "550e8400-e29b-41d4-a716-446655440000",
"report_url": "/report/550e8400-e29b-41d4-a716-446655440000/",
"status": "complete"
}