> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tryprofound.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> An overview of the REST API and its capabilities

<Warning>
  This API is currently in beta phase, so there may be changes to endpoints and data structure. We appreciate your understanding and patience as we work to improve the API.
</Warning>

<Note>
  This feature is only available upon request. To request access, please contact [support](mailto:support@tryprofound.com).

  If you already have access, view the [documentation](/rest-api/authentication) to learn how to manage your API keys.
</Note>

## 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:

```
https://api.tryprofound.com
```

**Key capabilities:**

* Automate data retrieval and processing tasks
* Create integrations with third-party applications
* Generate custom reports and analytics
* Access both processed and raw data from our prompt system

## 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 Data Access

Access unprocessed data within specific categories, giving you the flexibility to build custom reports and perform your own analysis using all available platform data.

### 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:

* [Authentication](/rest-api/authentication) - How to authenticate your requests
* [Date Ranges & Timezones](/rest-api/date-ranges) - Understanding date parameters and timezone handling
* [Example Requests](/rest-api/examples) - Sample API calls and responses
  * [Answer Engine Insights](/rest-api/examples/answer-engine-insights)
  * [Agent Analytics](/rest-api/examples/agent-analytics)
  * [Agents](/rest-api/examples/agents)

## 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

All report endpoints require:

* A **category identifier**, which you can retrieve from `/v1/org/categories`
* **Date range parameters** (`start_date` and `end_date`) - See [Date Ranges & Timezones](/rest-api/date-ranges) for proper formatting

### API Versioning

The API currently has both `v1` and `v2` endpoints:

* `v1` remains the default for most APIs, including report endpoints
* `v2` was recently introduced for Agent Analytics report endpoints under `/v2/reports/*` to support hourly granularity

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.