> 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/personas.md). # Personas ## List Personas > Personas are the characters that can be used to ask questions 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":"Personas"}],"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}/personas/list":{"post":{"summary":"List Personas","description":"Personas are the characters that can be used to ask questions about a brand. They are used to get AI answers with citations and mentions.","tags":["Personas"],"operationId":"listBrandKitsPersonas","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 persona"},"title":{"nullable":true,"type":"string","description":"The persona title"},"description":{"nullable":true,"type":"string","description":"The persona description"},"created_at":{"nullable":true,"type":"string","description":"When the persona was created"},"updated_at":{"nullable":true,"type":"string","description":"When the persona was last updated"}}}},"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"},"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- **title** (EQUALS, CONTAINS): Filter by persona title","items":{"type":"object","properties":{"field":{"type":"string","enum":["title"],"description":"Field to filter on. title: Filter by persona title"},"operator":{"type":"string","enum":["EQUALS","CONTAINS"],"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"]}},"fields":{"type":"array","description":"Select additional fields to return.\n\n**Optional fields:**\n- **id**: Unique identifier for the persona\n- **title**: The persona title\n- **description**: The persona description\n- **created_at**: When the persona was created\n- **updated_at**: When the persona was last updated","items":{"type":"string","enum":["id","title","description","created_at","updated_at"]}},"sort":{"type":"string","enum":["title","-title","created_at","-created_at"],"description":"Sort field. Prefix with - for descending.\n\n**Available sort fields:**\n- **title/-title**: Sort alphabetically by persona title\n- **created_at/-created_at**: Sort by creation date"},"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 Persona > Personas are the characters that can be used to ask questions 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":"Personas"}],"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}/personas/{id}":{"get":{"summary":"Get Persona","description":"Personas are the characters that can be used to ask questions about a brand. They are used to get AI answers with citations and mentions.","tags":["Personas"],"operationId":"getBrandKitsPersona","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 persona"},"title":{"nullable":true,"type":"string","description":"The persona title"},"description":{"nullable":true,"type":"string","description":"The persona description"},"created_at":{"nullable":true,"type":"string","description":"When the persona was created"},"updated_at":{"nullable":true,"type":"string","description":"When the persona was last updated"}}}},"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 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/personas.md?ask=&goal= ``` `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.