# Brand Kits

Endpoints for managing brand kits and their associated resources.

## List Brand Kits

> Brand Kits for AEO operations — provides the brand\_kit\_id required by all AEO tools (analytics, prompts, pages, citations, reports, grids, topics, personas).

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"tags":[{"name":"Brand Kits","description":"Endpoints for managing brand kits and their associated resources."}],"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/list":{"post":{"summary":"List Brand Kits","description":"Brand Kits for AEO operations — provides the brand_kit_id required by all AEO tools (analytics, prompts, pages, citations, reports, grids, topics, personas).","tags":["Brand Kits"],"operationId":"listBrandKits","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 Brand Kit"},"workspace_name":{"nullable":true,"type":"string","description":"Name of the workspace this Brand Kit belongs to"},"brand_name":{"nullable":true,"type":"string","description":"Name of the brand"},"brand_url":{"nullable":true,"type":"string","description":"URL of the brand website"},"brand_about":{"nullable":true,"type":"string","description":"Description/overview of the brand"},"brand_customer":{"nullable":true,"type":"string","description":"Description of the target customer"},"brand_competitors":{"nullable":true,"type":"string","description":"Information about brand competitors"},"brand_point_of_view":{"nullable":true,"type":"string","description":"The brand's unique perspective or stance"},"writing_persona":{"nullable":true,"type":"string","description":"The persona/voice used in brand writing"},"writing_tone":{"nullable":true,"type":"string","description":"The tone of voice for brand content"},"writing_cta":{"nullable":true,"type":"string","description":"Default call-to-action text"},"writing_cta_url":{"nullable":true,"type":"string","description":"URL for call-to-action links"},"writing_rules":{"nullable":true,"type":"string","description":"Writing rules and guidelines"},"writing_sample_title":{"nullable":true,"type":"string","description":"Title of the writing sample"},"writing_sample_outline":{"nullable":true,"type":"string","description":"Outline of the writing sample"},"writing_sample_body":{"nullable":true,"type":"string","description":"Body content of the writing sample"},"writing_sample_url":{"nullable":true,"type":"string","description":"URL reference for the writing sample"},"primary_color":{"nullable":true,"type":"string","description":"Primary brand color (hex format, e.g., #FF5733)"},"secondary_color":{"nullable":true,"type":"string","description":"Secondary brand color (hex format)"},"accent_color":{"nullable":true,"type":"string","description":"Accent brand color (hex format)"},"header_case":{"nullable":true,"type":"string","description":"Header case style (title_case, sentence_case, or custom)"},"header_case_custom_value":{"nullable":true,"type":"string","description":"Custom header case rules (when header_case is custom)"},"countries":{"nullable":true,"type":"array","items":{"type":"string"},"description":"Array of country codes for brand targeting (e.g., [\"US\", \"GB\", \"CA\"])"},"aeo_enabled":{"nullable":true,"type":"boolean","description":"Whether AEO is enabled for the Brand Kit"},"prompts_count":{"nullable":true,"type":"integer","description":"Number of prompts/questions associated with this Brand Kit"},"created_at":{"nullable":true,"type":"string","description":"When the Brand Kit was created"},"updated_at":{"nullable":true,"type":"string","description":"When the Brand Kit was last updated"},"product_lines":{"nullable":true,"type":"array","description":"Included product_lines collection (when requested via includes param)","items":{"type":"object"}},"competitors":{"nullable":true,"type":"array","description":"Included competitors collection (when requested via includes param)","items":{"type":"object"}},"audiences":{"nullable":true,"type":"array","description":"Included audiences collection (when requested via includes param)","items":{"type":"object"}},"content_types":{"nullable":true,"type":"array","description":"Included content_types collection (when requested via includes param)","items":{"type":"object"}}},"required":["id","brand_name","workspace_name"]}},"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"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"workspace_id":{"type":"integer","description":"ID of the workspace to retrieve brand kits from. If not provided, returns brand kits from all workspaces the user belongs to."},"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- **workspace_name** (EQUALS, CONTAINS): Filter by workspace name\n- **brand_name** (EQUALS, CONTAINS): Filter by brand name\n- **brand_url** (EQUALS, CONTAINS): Filter by brand URL\n- **created_at** (EQ, GT, LT, GEQ, LEQ): Filter by creation date\n- **aeo_enabled** (EQ): Filter by whether AEO is enabled for the Brand Kit","items":{"type":"object","properties":{"field":{"type":"string","enum":["workspace_name","brand_name","brand_url","created_at","aeo_enabled"],"description":"Field to filter on. workspace_name: Filter by workspace name; brand_name: Filter by brand name; brand_url: Filter by brand URL; created_at: Filter by creation date; aeo_enabled: Filter by whether AEO is enabled for the Brand Kit"},"operator":{"type":"string","enum":["EQUALS","CONTAINS","EQ","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"},"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- **product_lines**: Include product lines for this Brand Kit\n- **competitors**: Include competitor analysis\n- **audiences**: Include target audiences for this Brand Kit\n- **content_types**: Include content types configuration","items":{"type":"string","enum":["product_lines","competitors","audiences","content_types"]}},"fields":{"type":"array","description":"Select additional fields to return.\n\nDefault fields (id, brand_name, workspace_name) are always included.\n\n**Optional fields:**\n- **brand_url**: URL of the brand website\n- **brand_about**: Description/overview of the brand\n- **brand_customer**: Description of the target customer\n- **brand_competitors**: Information about brand competitors\n- **brand_point_of_view**: The brand's unique perspective or stance\n- **writing_persona**: The persona/voice used in brand writing\n- **writing_tone**: The tone of voice for brand content\n- **writing_cta**: Default call-to-action text\n- **writing_cta_url**: URL for call-to-action links\n- **writing_rules**: Writing rules and guidelines\n- **writing_sample_title**: Title of the writing sample\n- **writing_sample_outline**: Outline of the writing sample\n- **writing_sample_body**: Body content of the writing sample\n- **writing_sample_url**: URL reference for the writing sample\n- **primary_color**: Primary brand color (hex format, e.g., #FF5733)\n- **secondary_color**: Secondary brand color (hex format)\n- **accent_color**: Accent brand color (hex format)\n- **header_case**: Header case style (title_case, sentence_case, or custom)\n- **header_case_custom_value**: Custom header case rules (when header_case is custom)\n- **countries**: Array of country codes for brand targeting (e.g., [\"US\", \"GB\", \"CA\"])\n- **aeo_enabled**: Whether AEO is enabled for the Brand Kit\n- **prompts_count**: Number of prompts/questions associated with this Brand Kit\n- **created_at**: When the Brand Kit was created\n- **updated_at**: When the Brand Kit was last updated","items":{"type":"string","enum":["brand_url","brand_about","brand_customer","brand_competitors","brand_point_of_view","writing_persona","writing_tone","writing_cta","writing_cta_url","writing_rules","writing_sample_title","writing_sample_outline","writing_sample_body","writing_sample_url","primary_color","secondary_color","accent_color","header_case","header_case_custom_value","countries","aeo_enabled","prompts_count","created_at","updated_at"]}},"sort":{"type":"string","enum":["brand_name","-brand_name","created_at","-created_at","prompts_count","-prompts_count"],"description":"Sort field. Prefix with - for descending.\n\n**Available sort fields:**\n- **brand_name/-brand_name**: Sort alphabetically by brand name\n- **created_at/-created_at**: Sort by creation date\n- **prompts_count/-prompts_count**: Sort by number of prompts/questions"},"page":{"type":"integer","default":1,"description":"Page number"},"per_page":{"type":"integer","default":25,"maximum":100,"description":"Items per page"}}}}}}}}}}
```

## Get Brand Kit

> Brand Kits for AEO operations — provides the brand\_kit\_id required by all AEO tools (analytics, prompts, pages, citations, reports, grids, topics, personas).

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"tags":[{"name":"Brand Kits","description":"Endpoints for managing brand kits and their associated resources."}],"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/{id}":{"get":{"summary":"Get Brand Kit","description":"Brand Kits for AEO operations — provides the brand_kit_id required by all AEO tools (analytics, prompts, pages, citations, reports, grids, topics, personas).","tags":["Brand Kits"],"operationId":"getBrandKit","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 Brand Kit"},"workspace_name":{"nullable":true,"type":"string","description":"Name of the workspace this Brand Kit belongs to"},"brand_name":{"nullable":true,"type":"string","description":"Name of the brand"},"brand_url":{"nullable":true,"type":"string","description":"URL of the brand website"},"brand_about":{"nullable":true,"type":"string","description":"Description/overview of the brand"},"brand_customer":{"nullable":true,"type":"string","description":"Description of the target customer"},"brand_competitors":{"nullable":true,"type":"string","description":"Information about brand competitors"},"brand_point_of_view":{"nullable":true,"type":"string","description":"The brand's unique perspective or stance"},"writing_persona":{"nullable":true,"type":"string","description":"The persona/voice used in brand writing"},"writing_tone":{"nullable":true,"type":"string","description":"The tone of voice for brand content"},"writing_cta":{"nullable":true,"type":"string","description":"Default call-to-action text"},"writing_cta_url":{"nullable":true,"type":"string","description":"URL for call-to-action links"},"writing_rules":{"nullable":true,"type":"string","description":"Writing rules and guidelines"},"writing_sample_title":{"nullable":true,"type":"string","description":"Title of the writing sample"},"writing_sample_outline":{"nullable":true,"type":"string","description":"Outline of the writing sample"},"writing_sample_body":{"nullable":true,"type":"string","description":"Body content of the writing sample"},"writing_sample_url":{"nullable":true,"type":"string","description":"URL reference for the writing sample"},"primary_color":{"nullable":true,"type":"string","description":"Primary brand color (hex format, e.g., #FF5733)"},"secondary_color":{"nullable":true,"type":"string","description":"Secondary brand color (hex format)"},"accent_color":{"nullable":true,"type":"string","description":"Accent brand color (hex format)"},"header_case":{"nullable":true,"type":"string","description":"Header case style (title_case, sentence_case, or custom)"},"header_case_custom_value":{"nullable":true,"type":"string","description":"Custom header case rules (when header_case is custom)"},"countries":{"nullable":true,"type":"array","items":{"type":"string"},"description":"Array of country codes for brand targeting (e.g., [\"US\", \"GB\", \"CA\"])"},"aeo_enabled":{"nullable":true,"type":"boolean","description":"Whether AEO is enabled for the Brand Kit"},"prompts_count":{"nullable":true,"type":"integer","description":"Number of prompts/questions associated with this Brand Kit"},"created_at":{"nullable":true,"type":"string","description":"When the Brand Kit was created"},"updated_at":{"nullable":true,"type":"string","description":"When the Brand Kit was last updated"},"product_lines":{"nullable":true,"type":"array","description":"Included product_lines collection (when requested via includes param)","items":{"type":"object"}},"competitors":{"nullable":true,"type":"array","description":"Included competitors collection (when requested via includes param)","items":{"type":"object"}},"audiences":{"nullable":true,"type":"array","description":"Included audiences collection (when requested via includes param)","items":{"type":"object"}},"content_types":{"nullable":true,"type":"array","description":"Included content_types 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":"id","in":"path","required":true,"schema":{"type":"integer"},"description":"The resource ID"}]}}}}
```


---

# Agent Instructions: 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:

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

The question should be specific, self-contained, and written in natural language.
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.