> 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-1/brand-kits/prompts.md). # Prompts ## List Prompts > Questions are the AI prompts that can be asked about a brand. They are used to get AI answers with citations and mentions. ```json {"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"tags":[{"name":"Prompts"}],"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}/prompts/list":{"post":{"summary":"List Prompts","description":"Questions are the AI prompts that can be asked about a brand. They are used to get AI answers with citations and mentions.","tags":["Prompts"],"operationId":"listBrandKitsPrompts","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":"Unique identifier for the prompt"},"text":{"nullable":true,"type":"string","description":"The prompt text"},"keyword":{"nullable":true,"type":"string","description":"Associated keyword for the prompt"},"brand_mentioned":{"nullable":true,"type":"boolean","description":"Whether the brand is mentioned in the prompt"},"prompt_volume":{"nullable":true,"type":"string","description":"Prompt volume level","enum":["very_low","low","medium","high",null]},"search_volume":{"nullable":true,"type":"number","description":"Actual search volume behind the prompt_volume level"},"topic_id":{"nullable":true,"type":"integer","description":"ID of the associated topic"},"created_at":{"nullable":true,"type":"string","description":"When the prompt was created"},"updated_at":{"nullable":true,"type":"string","description":"When the prompt was last updated"},"mention_rate":{"nullable":true,"type":"number","description":"Percentage of AI answers mentioning the brand (0-100)"},"positive_answer_rate":{"nullable":true,"type":"number","description":"Percentage of answers where your brand is positively mentioned, out of all answers where you have been mentioned and sentiment is determined"},"citation_rate":{"nullable":true,"type":"number","description":"Percentage of AI answers with at least one citation that cite the brand (0-100)"},"mention_rate_trend":{"nullable":true,"type":"number","description":"Change in mention_rate vs previous period"},"positive_answer_rate_trend":{"nullable":true,"type":"number","description":"Change in positive_answer_rate vs previous period"},"citation_rate_trend":{"nullable":true,"type":"number","description":"Change in citation_rate vs previous period"},"query_fanouts":{"nullable":true,"type":"array","items":{"type":"object"},"description":"Search queries the AI ran internally when answering this question. Each entry has text (the raw query), normalized_text (lowercase/trimmed), and observations_count (how many times it appeared — higher = stronger signal). Empty if query fanout capture is not enabled for your workspace or if we do not support it for this provider."},"countries":{"nullable":true,"type":"array","items":{"type":"string"},"description":"ISO alpha-2 country codes currently assigned to the prompt (live)."},"persona_ids":{"nullable":true,"type":"array","items":{"type":"integer"},"description":"IDs of personas currently assigned to the prompt (live). Use `list_personas` to resolve to titles."},"platforms":{"nullable":true,"type":"array","items":{"type":"string"},"description":"AI platforms currently assigned to the prompt (live)."},"est_answers_mo":{"nullable":true,"type":"integer","description":"Estimated monthly answer credits this prompt will consume given its current live country, persona, and platform assignments."},"topic":{"nullable":true,"type":"object","description":"Included topic - all model attributes"},"tags":{"nullable":true,"type":"array","description":"Included tags collection (when requested via includes param)","items":{"type":"object"}}}}},"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"},"tags":{"type":"object","description":"Filter by tags. Object form { \"operator\": \"IN\" | \"HAS_ALL\" | \"NOT_IN\", \"value\": [tag ids] }. IN matches items tagged with ANY of the tags; HAS_ALL matches only items tagged with ALL; NOT_IN matches only items tagged with NONE.","properties":{"operator":{"type":"string","description":"IN matches items tagged with ANY of the tags; HAS_ALL matches only items tagged with ALL of them; NOT_IN matches only items tagged with NONE of them.","enum":["IN","HAS_ALL","NOT_IN"]},"value":{"type":"array","description":"Tag IDs to filter by.","items":{"type":"integer"}}},"required":["operator","value"]},"start_date":{"type":"string","description":"Start date for metrics (ISO 8601). Defaults to 1 month ago."},"end_date":{"type":"string","description":"End date for metrics (ISO 8601). Defaults to today."},"providers":{"type":"array","description":"Filter metrics by AI providers","items":{"type":"string","enum":["chat_gpt","gemini","perplexity","google_ai_mode","google_ai_overview","claude","grok","microsoft_copilot","claude_code","codex","muse_spark"]}},"countries":{"type":"array","description":"Filter metrics by 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","KE","KR","MX","MY","NG","NL","NO","NZ","PE","PH","PL","PT","SA","SE","SG","TH","TR","TW","US","VN","ZA"]}},"personas":{"type":"array","description":"Filter metrics by persona IDs","items":{"type":"integer"}},"filters":{"type":"array","description":"Filter results. Nested fields (e.g. `writing_rules.text`) filter within an included association and require that association in `includes`.\n\n**Available fields:**\n- **text** (EQUALS, CONTAINS): Filter by prompt text\n- **strategy** (EQ, IN): Filter by strategy: 0 = manual, 1 = deep_research\n- **brand_mentioned** (EQ): Filter by whether the brand is mentioned in the prompt. Use operator EQ with value true or false. Not a 'brand'/'category' field.\n- **topic_id** (EQ, IN): Filter by topic ID\n- **prompt_volume** (EQUALS, IN): Filter by prompt volume level\n- **mention_rate** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by mention rate percentage (0-100)\n- **positive_answer_rate** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by positive answer rate percentage (0-100)\n- **citation_rate** (EQ, NEQ, GT, LT, GEQ, LEQ): Filter by citation rate percentage (0-100)\n- **country** (EQ, IN): Filter prompts by an assigned country (ISO alpha-2). EQ matches a single code; IN matches any in the list.\n- **persona_id** (EQ, IN): Filter prompts by an assigned persona ID. Use `list_personas` to discover persona IDs.\n- **platform** (EQ, IN): Filter prompts by an assigned AI platform.","items":{"type":"object","properties":{"field":{"type":"string","enum":["text","strategy","brand_mentioned","topic_id","prompt_volume","mention_rate","positive_answer_rate","citation_rate","country","persona_id","platform"],"description":"Field to filter on. text: Filter by prompt text; strategy: Filter by strategy: 0 = manual, 1 = deep_research; brand_mentioned: Filter by whether the brand is mentioned in the prompt. Use operator EQ with value true or false. Not a 'brand'/'category' field.; topic_id: Filter by topic ID; prompt_volume: Filter by prompt volume level (values: very_low, low, medium, high); mention_rate: Filter by mention rate percentage (0-100); positive_answer_rate: Filter by positive answer rate percentage (0-100); citation_rate: Filter by citation rate percentage (0-100); country: Filter prompts by an assigned country (ISO alpha-2). EQ matches a single code; IN matches any in the list. (values: 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, KE, KR, MX, MY, NG, NL, NO, NZ, PE, PH, PL, PT, SA, SE, SG, TH, TR, TW, US, VN, ZA); persona_id: Filter prompts by an assigned persona ID. Use `list_personas` to discover persona IDs.; platform: Filter prompts by an assigned AI platform. (values: chat_gpt, gemini, perplexity, google_ai_mode, google_ai_overview, claude, grok, microsoft_copilot, claude_code, codex, muse_spark)"},"operator":{"type":"string","enum":["EQUALS","CONTAINS","EQ","IN","NEQ","GT","LT","GEQ","LEQ"],"description":"Filter operator.\n\n- **EQ/EQUALS**: Exact match\n- **NEQ**: Not equal\n- **GT/GEQ/LT/LEQ**: Numeric/date comparisons\n- **CONTAINS**: Partial text match\n- **STARTS_WITH**: Text prefix match\n- **IN**: Match any value in array\n- **HAS_ALL**: (tags filter) match only items having every listed value\n- **NOT_IN**: (tags filter) match only items having none of the listed values"},"value":{"description":"Filter value (type depends on field and operator)"}},"required":["field","operator","value"]}},"includes":{"type":"array","description":"Include related resources.\n\n**Available includes:**\n- **topic**: Include the associated topic\n- **tags**: Include the associated tags","items":{"type":"string","enum":["topic","tags"]}},"fields":{"type":"array","description":"Select additional fields to return.\n\n**Optional fields:**\n- **id**: Unique identifier for the prompt\n- **text**: The prompt text\n- **keyword**: Associated keyword for the prompt\n- **brand_mentioned**: Whether the brand is mentioned in the prompt\n- **prompt_volume**: Prompt volume level\n- **search_volume**: Actual search volume behind the prompt_volume level\n- **topic_id**: ID of the associated topic\n- **created_at**: When the prompt was created\n- **updated_at**: When the prompt was last updated\n- **mention_rate**: Percentage of AI answers mentioning the brand (0-100)\n- **positive_answer_rate**: Percentage of answers where your brand is positively mentioned, out of all answers where you have been mentioned and sentiment is determined\n- **citation_rate**: Percentage of AI answers with at least one citation that cite the brand (0-100)\n- **mention_rate_trend**: Change in mention_rate vs previous period\n- **positive_answer_rate_trend**: Change in positive_answer_rate vs previous period\n- **citation_rate_trend**: Change in citation_rate vs previous period\n- **query_fanouts**: Search queries the AI ran internally when answering this question. Each entry has text (the raw query), normalized_text (lowercase/trimmed), and observations_count (how many times it appeared — higher = stronger signal). Empty if query fanout capture is not enabled for your workspace or if we do not support it for this provider.\n- **countries**: ISO alpha-2 country codes currently assigned to the prompt (live).\n- **persona_ids**: IDs of personas currently assigned to the prompt (live). Use `list_personas` to resolve to titles.\n- **platforms**: AI platforms currently assigned to the prompt (live).\n- **est_answers_mo**: Estimated monthly answer credits this prompt will consume given its current live country, persona, and platform assignments.","items":{"type":"string","enum":["id","text","keyword","brand_mentioned","prompt_volume","search_volume","topic_id","created_at","updated_at","mention_rate","positive_answer_rate","citation_rate","mention_rate_trend","positive_answer_rate_trend","citation_rate_trend","query_fanouts","countries","persona_ids","platforms","est_answers_mo"]}},"sort":{"type":"string","enum":["text","-text","created_at","-created_at","prompt_volume","-prompt_volume","mention_rate","-mention_rate","positive_answer_rate","-positive_answer_rate","citation_rate","-citation_rate"],"description":"Sort field. Prefix with - for descending.\n\n**Available sort fields:**\n- **text/-text**: Sort alphabetically by prompt text\n- **created_at/-created_at**: Sort by creation date\n- **prompt_volume/-prompt_volume**: Sort by prompt volume level\n- **mention_rate/-mention_rate**: Sort by mention rate\n- **positive_answer_rate/-positive_answer_rate**: Sort by positive answer rate\n- **citation_rate/-citation_rate**: Sort by citation rate"},"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 Prompt > Questions are the AI prompts that can be asked about a brand. They are used to get AI answers with citations and mentions. ```json {"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"tags":[{"name":"Prompts"}],"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}/prompts/{id}":{"get":{"summary":"Get Prompt","description":"Questions are the AI prompts that can be asked about a brand. They are used to get AI answers with citations and mentions.","tags":["Prompts"],"operationId":"getBrandKitsPrompt","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"nullable":true,"type":"integer","description":"Unique identifier for the prompt"},"text":{"nullable":true,"type":"string","description":"The prompt text"},"keyword":{"nullable":true,"type":"string","description":"Associated keyword for the prompt"},"brand_mentioned":{"nullable":true,"type":"boolean","description":"Whether the brand is mentioned in the prompt"},"prompt_volume":{"nullable":true,"type":"string","description":"Prompt volume level","enum":["very_low","low","medium","high",null]},"search_volume":{"nullable":true,"type":"number","description":"Actual search volume behind the prompt_volume level"},"topic_id":{"nullable":true,"type":"integer","description":"ID of the associated topic"},"created_at":{"nullable":true,"type":"string","description":"When the prompt was created"},"updated_at":{"nullable":true,"type":"string","description":"When the prompt was last updated"},"mention_rate":{"nullable":true,"type":"number","description":"Percentage of AI answers mentioning the brand (0-100)"},"positive_answer_rate":{"nullable":true,"type":"number","description":"Percentage of answers where your brand is positively mentioned, out of all answers where you have been mentioned and sentiment is determined"},"citation_rate":{"nullable":true,"type":"number","description":"Percentage of AI answers with at least one citation that cite the brand (0-100)"},"mention_rate_trend":{"nullable":true,"type":"number","description":"Change in mention_rate vs previous period"},"positive_answer_rate_trend":{"nullable":true,"type":"number","description":"Change in positive_answer_rate vs previous period"},"citation_rate_trend":{"nullable":true,"type":"number","description":"Change in citation_rate vs previous period"},"query_fanouts":{"nullable":true,"type":"array","items":{"type":"object"},"description":"Search queries the AI ran internally when answering this question. Each entry has text (the raw query), normalized_text (lowercase/trimmed), and observations_count (how many times it appeared — higher = stronger signal). Empty if query fanout capture is not enabled for your workspace or if we do not support it for this provider."},"countries":{"nullable":true,"type":"array","items":{"type":"string"},"description":"ISO alpha-2 country codes currently assigned to the prompt (live)."},"persona_ids":{"nullable":true,"type":"array","items":{"type":"integer"},"description":"IDs of personas currently assigned to the prompt (live). Use `list_personas` to resolve to titles."},"platforms":{"nullable":true,"type":"array","items":{"type":"string"},"description":"AI platforms currently assigned to the prompt (live)."},"est_answers_mo":{"nullable":true,"type":"integer","description":"Estimated monthly answer credits this prompt will consume given its current live country, persona, and platform assignments."},"topic":{"nullable":true,"type":"object","description":"Included topic - all model attributes"},"tags":{"nullable":true,"type":"array","description":"Included tags collection (when requested via includes param)","items":{"type":"object"}}}}},"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"},{"name":"id","in":"path","required":true,"schema":{"type":"integer"},"description":"The resource 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 by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.airops.com/api-reference-1/brand-kits/prompts.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.