Browse the documentation

Add Prompts to Track

Add prompts to track for a brand across the chosen AI platforms and queue the first crawl. Requires a write-enabled API key.

POST /prompts

Request body

Send as application/json. This endpoint needs a write-enabled API key.

Field	Type	Description
brand required	string	Tracked brand name.
prompts required	array of string	The prompts to track (max 50).
llms required	array of string	Platform slugs, e.g. ['openai', 'claude']. Must be allowed by the account's plan.
country	string	ISO alpha-2 code; 'ZZ' = Global.
tags	array of string	Tags to attach (max 10).

Example request

curl -X POST -H "Authorization: Bearer $MENTIONBIRD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "brand": "Acme",
  "prompts": [
    "best crm software"
  ],
  "llms": [
    "openai"
  ]
}' \
  "https://app.mentionbird.ai/api/v1/prompts"

Responses

200: Prompts added and crawl queued.
400: Validation error — check the message in `error.message`.
401: Unauthorized — missing, invalid or revoked bearer token.
403: Forbidden — plan lacks API access, or key is read-only.
404: Not found — the brand, prompt or resource does not exist.
405: Method not allowed.
500: Internal error — logged; retry is safe for reads.