AI questions

Manage the questions a workspace asks ChatGPT and Google AI Overviews each month, and read which of its brands the answers mention and recommend.

Authentication required

All endpoints require a Bearer token in the Authorization header. See the Authentication guide for setup instructions.

GET /v1/ai-questions

List the questions a workspace asks ChatGPT and Google AI Overviews each month, with the latest answers and which of its brand and competitors each answer mentions or recommends, in order.

bash
GET /v1/ai-questions?workspace_id=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01
Authorization: Bearer {token}

Parameters

NameTypeRequiredDescription
workspaceIdstring (UUID)RequiredWorkspace identifier.

Response

Returns { items, totalCount, facets, _meta } with paginated results.

POST /v1/ai-questions

Add a question for Brandwave to ask ChatGPT and Google AI Overviews every month, such as "What is the best PDF editor?", to track whether the answers mention or recommend the brand and its competitors.

bash
POST /v1/ai-questions
Authorization: Bearer {token}
Content-Type: application/json

{
  "workspace_id": "1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01",
  "question": "..."
}

Parameters

NameTypeRequiredDescription
workspaceIdstring (UUID)RequiredWorkspace identifier.
questionstringRequiredThe question as a buyer would ask ChatGPT or search Google, such as "What is the best PDF editor for Mac?".

Response

Returns { data, _meta } with the result.

DELETE /v1/ai-questions/:id

Remove an AI question so Brandwave stops asking it each month. Its past answers are no longer listed with the workspace.

bash
DELETE /v1/ai-questions/:id
Authorization: Bearer {token}

Parameters

NameTypeRequiredDescription
idstring (UUID)RequiredAI question identifier.

Response

Returns { data, _meta } with the result.