Visibility
Check whether AI models mention a brand for a prompt
Runs a prompt across the selected AI engines (ChatGPT, Claude, Gemini, Perplexity) and reports whether the brand is mentioned, its position, competitors named alongside it, and a coverage / share-of-voice / sentiment rollup. Costs 3 credits per engine (+1 per engine when sentiment is enabled).
POST
/v1/visibility/Authorization
accessKey x-access-key<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/visibility/" \ -H "Content-Type: application/json" \ -d '{ "brand": "string", "prompt": "string" }'{
"success": true,
"credits": {
"charged": 0,
"remaining": 0
},
"data": {
"brand": "string",
"prompt": "string",
"mentioned_in": [
"string"
],
"summary": {
"coverage_pct": 0,
"avg_position": null,
"share_of_voice": null,
"sentiment": null
},
"results": [
{
"engine": "string",
"model": "string",
"mentioned": true,
"position": null,
"competitors_found": [
"string"
],
"competitor_candidates_found": [
"string"
],
"sentiment": null,
"sources": [
"string"
],
"answer": "string",
"error": null
}
]
}
}{
"success": false,
"message": "string"
}{
"success": false,
"message": "string"
}{
"success": false,
"message": "string"
}{
"success": false,
"message": "string"
}{
"success": false,
"message": "string"
}