Scans
Start a bulk AI visibility scan
Runs a grid of prompts × engines as a background job. Returns a scan id immediately (status 'pending'); poll GET /v1/scans/:id until 'completed'. Costs 5 credits per check (prompts × engines), +1 per check with sentiment. Charged upfront.
POST
/v1/scans/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
curl -X POST "https://example.com/v1/scans/" \ -H "Content-Type: application/json" \ -d '{ "brand": "string", "prompts": [ "string" ] }'{
"success": true,
"credits": {
"charged": 0,
"remaining": 0
},
"data": {
"id": "string",
"brandId": null,
"brand": "string",
"domain": null,
"status": "string",
"progress": {
"total": 0,
"completed": 0,
"failed": 0,
"pending": 0
},
"done": true,
"prompts": [
"string"
],
"engines": [
"string"
],
"results": [
{
"prompt": "string",
"engine": "string",
"status": "string",
"mentioned": null,
"position": null,
"competitors_found": [
"string"
],
"sentiment": null,
"sources_count": 0,
"error": null
}
],
"createdAt": "string",
"completedAt": null
}
}{
"success": false,
"message": "string"
}{
"success": false,
"message": "string"
}{
"success": false,
"message": "string"
}{
"success": false,
"message": "string"
}