Skip to main content
This feature is only available upon request. To request access, please contact support.If you already have access, view the documentation to learn how to manage your API keys.

​
Overview

Our API allows developers to interact with the data displayed on our platform programmatically. All API responses are returned in JSON format, making it easy to integrate with modern applications and tools.

​
Base URL

All API requests should be made to:
Key capabilities:
  • Automate data retrieval and processing tasks
  • Create integrations with third-party applications
  • Generate custom reports and analytics
  • Access processed reports and raw per-execution prompt-answer data

​
API Features

​
Report Generation

Create comprehensive reports with processed data from our prompt system. Compare performance metrics across different companies, time periods, or evaluation criteria to gain insights into your data.

​
Raw Per-Execution Data

Access raw per-execution prompt-answer rows through POST /v2/prompts/answers, including model responses, mentions, citations, and search queries.

​
Organization-Scoped Data

Each API key provides access to data belonging to its associated organization, ensuring proper data isolation and security.

​
Getting Started

To begin using the API, you’ll need an API key from your user profile on our platform. This key authenticates your requests and grants access to your organization’s data. For authentication details and request examples, see:

​
API Fundamentals

​
Data Organization

Each organization has access to specific categories and datasets. Use the /v1/org endpoints to:
  • Discover available data categories
  • Obtain identifiers for filtering
  • Understand your data scope and permissions

​
Required Parameters

Answer Engine Insights reports require a category identifier and date range parameters (start_date and end_date). Traffic reports for bots and referrals are domain-scoped instead. See Date Ranges & Timezones for proper formatting.

​
API Versioning

The API currently has both v1 and v2 endpoints:
  • v1 endpoints remain active, including the existing V1 report endpoints
  • v2 now spans Answer Engine Insights reports under /v2/reports/visibility, /v2/reports/citations, /v2/reports/sentiment, /v2/reports/query-fanouts, /v2/reports/factcheck, and /v2/reports/factcheck/claims, as well as /v2/prompts/answers. Each has a /stream SSE variant.
Versioned paths ensure compatibility as the API evolves.

​
Rate Limits

Default limits: 600 requests per hour per API key.

​
Rate Limit Headers

Every API response includes these headers:
  • X-RateLimit-Limit: Your total request limit
  • X-RateLimit-Remaining: Remaining requests in current period
  • X-RateLimit-Reset: When the limit resets (Unix timestamp)

​
Handling Rate Limits

When you exceed the limit, you’ll receive a 429 Too Many Requests error. The response includes a Retry-After header indicating how long to wait before retrying. Need higher limits? Contact our support team to discuss your requirements.

​
Response Format

All API responses use JSON format with consistent structure for errors and successful responses.