Skip to main content
POST
/
api
/
agent
/
tools
/
brand-scan
Start async AI brand visibility scan
curl --request POST \
  --url https://www.citedy.com/api/agent/tools/brand-scan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "brandName": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "processing",
  "brand_name": "<string>",
  "credits_charged": 1
}

Authorizations

​
Authorization
string
header
required

Bearer citedy_agent_* key

Body

application/json
​
brandName
string
required
Required string length: 1 - 100

Response

Scan accepted. Poll GET /api/agent/tools/brand-scan/{id} with the same Authorization: Bearer <AGENT_API_KEY> header for status.

​
id
string<uuid>
required
​
status
enum<string>
required
Available options:
processing
​
brand_name
string
required
​
credits_charged
integer
required
Required range: x >= 0