Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dev.ranked.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
API Keys

All API requests require a Bearer token in the Authorization header.

Create an API Key

Go to Settings > API in your dashboard to create and manage API keys.
curl https://app.ranked.ai/api/v1/projects \
  -H "Authorization: Bearer rk_live_your_api_key"

​
Key types

ScopePermissions
Read Only (default)Fetch all data: keywords, audits, backlinks, prompts, content, reports
Read + WriteEverything above, plus: create reports, manage webhooks, update content preferences

​
Key format

API keys follow the format rk_live_ followed by a random string. Example: 
rk_live_PJcyKvCPW1lSdCtC0-Gh0MrwCv3poWF5
Keys are shown only once when created. Store them securely — you cannot retrieve a key after closing the creation dialog.

​
Response format

All responses follow a consistent envelope:

​
Success

{
  "success": true,
  "data": { ... },
  "meta": {
    "request_id": "req_abc123",
    "rate_limit": {
      "limit": 100,
      "remaining": 99,
      "reset": 1778891947
    },
    "pagination": {
      "total": 20,
      "limit": 50,
      "offset": 0,
      "has_more": false
    }
  }
}

​
Error

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

​
Error codes

CodeHTTP StatusDescription
UNAUTHORIZED401Missing or invalid API key
FORBIDDEN403Valid key but insufficient permissions (e.g., read-only key attempting a write)
NOT_FOUND404Resource not found
VALIDATION_ERROR400Invalid request parameters
RATE_LIMITED429Too many requests
INTERNAL_ERROR500Server error

​
Pagination

List endpoints support limit and offset query parameters: 
# Get 20 keywords starting from the 40th
curl "https://app.ranked.ai/api/v1/projects/{id}/rankings/keywords?limit=20&offset=40" \
  -H "Authorization: Bearer rk_live_..."
  • Default limit: 50
  • Maximum limit: 1000 (keywords), 200 (prompts), 500 (projects)
  • Offset: 0-based
The meta.pagination object indicates total count and has_more flag.

​
Rate limits

WindowLimit
Per minute100 requests
Per hour2,000 requests
Per day20,000 requests
Rate limit headers are included in every response via meta.rate_limit: 
{
  "limit": 100,
  "remaining": 97,
  "reset": 1778891947
}
When rate limited, you’ll receive a 429 response. Wait until reset (Unix timestamp) before retrying.