Brand discoveries
Discover starter prompts for a saved brand
Starts an asynchronous, review-first setup job from the saved brand's domain. Returned competitor candidates are an internal SEO watchlist: they are not saved as competitors until later AI answers provide evidence. Poll the returned discovery URL. A useful completed job costs 20 credits; failed jobs cost 0.
POST
/v1/brand-discoveries/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
application/json
curl -X POST "https://example.com/v1/brand-discoveries/" \ -H "Content-Type: application/json" \ -d '{ "brand_id": "string" }'{
"success": true,
"credits": {
"charged": 0,
"remaining": 0
},
"cost": 0,
"reused": true,
"data": {
"id": "string",
"brandId": "string",
"status": "pending",
"done": true,
"maxPrompts": 0,
"maxCompetitors": 0,
"profile": null,
"prompts": [
{
"text": "string",
"topic": "string",
"intent": "category",
"provenance": "seo_data",
"confidence": 0,
"reason_codes": [
"string"
]
}
],
"competitors": [
{
"name": "string",
"domain": null,
"type": "direct",
"provenance": "seo_data",
"confidence": 0,
"intersections": null,
"reason_codes": [
"string"
]
}
],
"warnings": [
"string"
],
"error": null,
"creditsCharged": 0,
"createdAt": "string",
"startedAt": null,
"completedAt": null
}
}{
"success": false,
"message": "string"
}{
"success": false,
"message": "string"
}{
"success": false,
"message": "string"
}{
"success": false,
"message": "string"
}{
"success": false,
"message": "string"
}{
"success": false,
"message": "string"
}