Skip to main content

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.

​
Prerequisites

ChatAds is currently Amazon-only. You’ll need an Amazon Associates account and your Associate ID (tracking tag) to earn commissions. Add it in Offer Catalog > Amazon Affiliate Tag in your dashboard.

​
Step 1: Get Your API Key

  1. Log into app.getchatads.com
  2. Navigate to Settings → API Keys
  3. Click Create API Key
  4. Copy your new API key (starts with cak_)
Keep your API key secure. Never expose it in client-side code or public repositories.

​
Step 2: Make Your First Request

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."
  }'
See the API Reference for examples in Python, TypeScript, Go, and more — plus full request/response documentation.

​
Step 3: Handle the Response

Check error == null to determine success, then access the offers array: 
{
  "data": {
    "status": "filled",
    "offers": [
      {
        "link_text": "Bose QuietComfort Ultra earbuds",
        "url": "https://www.amazon.com/dp/B0CD2FSRDD/?tag=yourtag-20",
        "products": [
          {
            "title": "Bose QuietComfort Ultra Bluetooth Earbuds...",
            "stars": 3.8,
            "reviews": 9765
          }
        ]
      }
    ],
    "requested": 1,
    "returned": 1,
    "billed": true
  },
  "error": null,
  "meta": {
    "request_id": "bda67e29-a38a-47e0-b459-40a38475cf91"
  }
}

​
Next Steps

Authentication

Learn about API key management and security.

Rate Limits

Understand usage quotas and limits.