> For the complete documentation index, see [llms.txt](https://docs.airops.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.airops.com/api-reference/api-reference/brand-kits/answers.md).

# Answers

## List Answers

> Individual AI answers with their cited URLs and brand/competitor mentions.

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"tags":[{"name":"Answers"}],"servers":[{"url":"https://api.airops.com","variables":{"defaultHost":{"default":"api.airops.com"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/public_api/brand_kits/{brand_kit_id}/answers/list":{"post":{"summary":"List Answers","description":"Individual AI answers with their cited URLs and brand/competitor mentions.","tags":["Answers"],"operationId":"listBrandKitsAnswers","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"nullable":true,"type":"integer","description":"Answer ID"},"date":{"nullable":true,"type":"string","description":"Analysis date (YYYY-MM-DD)"},"text":{"nullable":true,"type":"string","description":"Answer text. Truncated to 200 chars with ellipsis on list; full on show."},"prompt":{"nullable":true,"type":"string","description":"Prompt (question) text"},"citations":{"nullable":true,"type":"array","items":{"type":"string"},"description":"URLs cited by the answer (deduped)"},"mentions":{"nullable":true,"type":"array","items":{"type":"string"},"description":"Brand names mentioned in the answer (self brand + competitors)"},"persona":{"nullable":true,"type":"string","description":"Persona name or \"default\""},"provider":{"nullable":true,"type":"string","description":"AI provider","enum":["chat_gpt","gemini","perplexity","google_ai_mode","google_ai_overview","claude","grok","microsoft_copilot",null]},"country":{"nullable":true,"type":"string","description":"ISO alpha-2 country code","enum":["AE","AR","AT","AU","BE","BR","CA","CH","CL","CN","CO","CZ","DE","DK","ES","FI","FR","GB","GR","HR","HU","ID","IE","IL","IN","IS","IT","JP","KR","MX","MY","NL","NO","NZ","PE","PH","PL","PT","SE","SG","TH","TR","US","VN",null]},"web_search_triggered":{"nullable":true,"type":"boolean","description":"Whether the AI performed a web search for this answer"},"brand_mentioned":{"nullable":true,"type":"boolean","description":"Whether the brand was mentioned in this answer"}}}},"meta":{"type":"object","properties":{"page":{"type":"integer"},"per_page":{"type":"integer"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}}}},"required":["data","meta"]}}}},"400":{"description":"Bad request - invalid parameters, filters, or sort options"},"401":{"description":"Unauthorized - invalid or missing authentication token"},"404":{"description":"Not found - resource does not exist"},"412":{"description":"Precondition failed - AEO not configured for this brand kit"}},"parameters":[{"name":"brand_kit_id","in":"path","required":true,"schema":{"type":"integer"},"description":"The Brand Kit ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"brand_kit_id":{"type":"integer","description":"The ID of the Brand Kit"},"start_date":{"type":"string","description":"Start date (ISO 8601) on aeo_analyses.created_at. Defaults to 30 days ago."},"end_date":{"type":"string","description":"End date (ISO 8601) on aeo_analyses.created_at. Defaults to today."},"prompt_id":{"type":"integer","description":"Filter answers by a single prompt (question) ID."},"providers":{"type":"array","description":"Filter by AI providers.","items":{"type":"string","enum":["chat_gpt","gemini","perplexity","google_ai_mode","google_ai_overview","claude","grok","microsoft_copilot"]}},"countries":{"type":"array","description":"Filter by ISO alpha-2 country codes.","items":{"type":"string","enum":["AE","AR","AT","AU","BE","BR","CA","CH","CL","CN","CO","CZ","DE","DK","ES","FI","FR","GB","GR","HR","HU","ID","IE","IL","IN","IS","IT","JP","KR","MX","MY","NL","NO","NZ","PE","PH","PL","PT","SE","SG","TH","TR","US","VN"]}},"brand_mentioned":{"type":"boolean","description":"When set, filter to answers where the brand was (or was not) mentioned."},"fields":{"type":"array","description":"Select additional fields to return.\n\n**Optional fields:**\n- **id**: Answer ID\n- **date**: Analysis date (YYYY-MM-DD)\n- **text**: Answer text. Truncated to 200 chars with ellipsis on list; full on show.\n- **prompt**: Prompt (question) text\n- **citations**: URLs cited by the answer (deduped)\n- **mentions**: Brand names mentioned in the answer (self brand + competitors)\n- **persona**: Persona name or \"default\"\n- **provider**: AI provider\n- **country**: ISO alpha-2 country code\n- **web_search_triggered**: Whether the AI performed a web search for this answer\n- **brand_mentioned**: Whether the brand was mentioned in this answer","items":{"type":"string","enum":["id","date","text","prompt","citations","mentions","persona","provider","country","web_search_triggered","brand_mentioned"]}},"page":{"type":"integer","default":1,"description":"Page number"},"per_page":{"type":"integer","default":25,"maximum":100,"description":"Items per page"}},"required":["brand_kit_id"]}}}}}}}}
```

## Get Answer

> Individual AI answers with their cited URLs and brand/competitor mentions.

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"tags":[{"name":"Answers"}],"servers":[{"url":"https://api.airops.com","variables":{"defaultHost":{"default":"api.airops.com"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/public_api/brand_kits/{brand_kit_id}/answers/show":{"post":{"summary":"Get Answer","description":"Individual AI answers with their cited URLs and brand/competitor mentions.","tags":["Answers"],"operationId":"getBrandKitsAnswer","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"nullable":true,"type":"integer","description":"Answer ID"},"date":{"nullable":true,"type":"string","description":"Analysis date (YYYY-MM-DD)"},"text":{"nullable":true,"type":"string","description":"Answer text. Truncated to 200 chars with ellipsis on list; full on show."},"prompt":{"nullable":true,"type":"string","description":"Prompt (question) text"},"citations":{"nullable":true,"type":"array","items":{"type":"string"},"description":"URLs cited by the answer (deduped)"},"mentions":{"nullable":true,"type":"array","items":{"type":"string"},"description":"Brand names mentioned in the answer (self brand + competitors)"},"persona":{"nullable":true,"type":"string","description":"Persona name or \"default\""},"provider":{"nullable":true,"type":"string","description":"AI provider","enum":["chat_gpt","gemini","perplexity","google_ai_mode","google_ai_overview","claude","grok","microsoft_copilot",null]},"country":{"nullable":true,"type":"string","description":"ISO alpha-2 country code","enum":["AE","AR","AT","AU","BE","BR","CA","CH","CL","CN","CO","CZ","DE","DK","ES","FI","FR","GB","GR","HR","HU","ID","IE","IL","IN","IS","IT","JP","KR","MX","MY","NL","NO","NZ","PE","PH","PL","PT","SE","SG","TH","TR","US","VN",null]},"web_search_triggered":{"nullable":true,"type":"boolean","description":"Whether the AI performed a web search for this answer"},"brand_mentioned":{"nullable":true,"type":"boolean","description":"Whether the brand was mentioned in this answer"}}}},"required":["data"]}}}},"400":{"description":"Bad request - invalid parameters, filters, or sort options"},"401":{"description":"Unauthorized - invalid or missing authentication token"},"404":{"description":"Not found - resource does not exist"},"412":{"description":"Precondition failed - AEO not configured for this brand kit"}},"parameters":[{"name":"brand_kit_id","in":"path","required":true,"schema":{"type":"integer"},"description":"The Brand Kit ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"brand_kit_id":{"type":"integer","description":"The ID of the Brand Kit"},"start_date":{"type":"string","description":"Start date (ISO 8601) on aeo_analyses.created_at. Defaults to 30 days ago."},"end_date":{"type":"string","description":"End date (ISO 8601) on aeo_analyses.created_at. Defaults to today."},"prompt_id":{"type":"integer","description":"Filter answers by a single prompt (question) ID."},"providers":{"type":"array","description":"Filter by AI providers.","items":{"type":"string","enum":["chat_gpt","gemini","perplexity","google_ai_mode","google_ai_overview","claude","grok","microsoft_copilot"]}},"countries":{"type":"array","description":"Filter by ISO alpha-2 country codes.","items":{"type":"string","enum":["AE","AR","AT","AU","BE","BR","CA","CH","CL","CN","CO","CZ","DE","DK","ES","FI","FR","GB","GR","HR","HU","ID","IE","IL","IN","IS","IT","JP","KR","MX","MY","NL","NO","NZ","PE","PH","PL","PT","SE","SG","TH","TR","US","VN"]}},"brand_mentioned":{"type":"boolean","description":"When set, filter to answers where the brand was (or was not) mentioned."},"id":{"type":"integer","description":"Resource ID"},"fields":{"type":"array","description":"Select specific fields to return.\n\n**Available fields:**\n- **id**: Answer ID\n- **date**: Analysis date (YYYY-MM-DD)\n- **text**: Answer text. Truncated to 200 chars with ellipsis on list; full on show.\n- **prompt**: Prompt (question) text\n- **citations**: URLs cited by the answer (deduped)\n- **mentions**: Brand names mentioned in the answer (self brand + competitors)\n- **persona**: Persona name or \"default\"\n- **provider**: AI provider\n- **country**: ISO alpha-2 country code\n- **web_search_triggered**: Whether the AI performed a web search for this answer\n- **brand_mentioned**: Whether the brand was mentioned in this answer","items":{"type":"string","enum":["id","date","text","prompt","citations","mentions","persona","provider","country","web_search_triggered","brand_mentioned"]}}},"required":["brand_kit_id","id"]}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.airops.com/api-reference/api-reference/brand-kits/answers.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.