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

# API Introduction

> Overview of the ChatAds API

## Base URL

All API requests should be made to:

```
https://api.getchatads.com
```

## Authentication

All API endpoints require authentication via the `x-api-key` header.

```bash theme={null}
curl -H "x-api-key: YOUR_API_KEY" \
  https://api.getchatads.com/v1/chatads/messages
```

Get your API key from [app.getchatads.com/api/keys](https://app.getchatads.com/api/keys).

## Request Format

All requests should:

* Use `Content-Type: application/json`
* Include the `x-api-key` header
* Send data in JSON format

### Example Request

```bash theme={null}
curl -X POST 'https://api.getchatads.com/v1/chatads/messages' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY' \
  -d '{
    "message": "The Bose QuietComfort Ultra earbuds are great for commuting. They have solid noise cancellation and a comfortable fit. Battery life is around six hours, which is enough for most people."
  }'
```

## Response Format

All responses follow this structure. Check `error == null` to determine success.

```json theme={null}
{
  "data": {
    "status": "filled",
    "offers": [
      {
        "link_text": "Bose QuietComfort Ultra earbuds",
        "is_branded": true,
        "term_brand": "Bose",
        "products": [
          {
            "title": "Bose QuietComfort Ultra Bluetooth Earbuds...",
            "url": "https://www.amazon.com/dp/B0CD2FSRDD/?tag=yourtag-20",
            "brand_name": "Bose",
            "stars": 3.8,
            "reviews": 9765
          }
        ]
      }
    ],
    "requested": 1,
    "returned": 1,
    "billed": true
  },
  "error": null,
  "meta": {
    "request_id": "0f04eb2e-820a-460a-8427-ccc1a6233b6a",
    "timestamp": "2026-03-11T13:57:42.074Z",
    "version": "1.0.0",
    "usage": {
      "monthly_requests": 13,
      "daily_requests": 3,
      "daily_limit": 10000,
      "is_free_tier": false
    }
  }
}
```

## Endpoints

<Card title="POST /v1/chatads/messages" icon="paper-plane" href="/api-reference/messages">
  Analyze a message for affiliate opportunities
</Card>

## Error Handling

See [Error Handling](/chatads_api/error-handling) for details on error codes and responses.

## Rate Limits

See [Rate Limits](/chatads_api/rate-limits) for information about request quotas.

## Response Times

Our API is designed for low-latency inline processing, with response times optimized for different use cases.

<CardGroup cols={2}>
  <Card title="Extraction Only" icon="bolt">
    **\~75-200ms**

    Set `resolution_mode=none` to extract keywords without resolving affiliate URLs.
  </Card>

  <Card title="Standard" icon="gauge">
    **\~200ms**

    Thorough analysis of input text + multi-source affiliate URL discovery for higher match rates.
  </Card>
</CardGroup>