Analyze AI visibility
analyze_ai_visibilityInspect provider-observed ChatGPT or Google AI Overview mentions and citations for a brand or domain to assess AI visibility under a cost cap.
Instructions
Inspect provider-observed ChatGPT or Google AI Overview mentions and citations. This is a limited provider dataset, not all user conversations. Requires BYOK or deployment credits, an explicit cost cap, and project write scope.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| brand | Yes | Brand name to inspect. | |
| fresh | No | Bypass the stored result and issue a new paid request when admitted. | |
| limit | No | Maximum mention rows. | |
| domain | Yes | Local citation-matching hostname, without a scheme or path. Domain searches remove a leading www. only from the provider filter and require at most 63 characters after removal; local matching keeps the full hostname. Brand searches and prompt comparisons allow up to 253. | |
| platform | No | Provider observed dataset: ChatGPT or Google AI Overview. | chat_gpt |
| project_id | Yes | The public project ID. Project membership and token scopes are enforced. | |
| target_type | No | Match a brand name or a domain. | domain |
| estimate_only | No | Return the cost estimate without paid provider I/O. | |
| language_code | No | Dataset language. | en |
| location_code | No | Provider location code. | |
| max_cost_cents | Yes | Maximum accepted provider cost in cents. Estimates and cache reads do not spend credits. | |
| idempotency_key | No | Optional stable retry key, forwarded as the REST Idempotency-Key header. |