Skip to main content
POST
Start async AI brand visibility scan

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