Prerequisites
Step 1: Get Your API Key
- Log into getchatads.com
- Navigate to Settings → API Keys
- Click Create API Key
- 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": "What are the best noise-cancelling headphones?"
}'
Step 3: Handle the Response
A successful response looks like this:
{
"data": {
"status": "filled",
"offers": [
{
"link_text": "noise-cancelling headphones",
"url": "https://www.amazon.com/dp/B0XXXXXXXXX?tag=yourtag-20",
"confidence_level": "high"
}
],
"requested": 1,
"returned": 1
},
"error": null,
"meta": {
"request_id": "d6a8f6f2-3b5a-4f0a-81ab-1b4a4c9dd5ea",
"country": "US",
"usage": {
"monthly_requests": 150,
"daily_requests": 25,
"daily_limit": 1000,
"is_free_tier": false
}
}
}
Response Fields
| Field | Description |
|---|
data.status | Response status: “filled”, “partial_fill”, “no_offers_found”, or “internal_error” |
data.offers | Array of affiliate offers (only contains filled offers) |
data.requested | Number of offers requested |
data.returned | Number of offers returned |
error | Error details (null on success) - check error == null to determine success |
meta.request_id | Unique ID for debugging and support |
Offer Fields
| Field | Description |
|---|
link_text | Text to use for the affiliate link |
url | The affiliate URL (always populated) |
confidence_level | Purchase intent classification |
Next Steps
