> 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/models.md).

# Models

## The ChatPayload object

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"components":{"schemas":{"ChatPayload":{"type":"object","properties":{"message":{"type":"string","description":"The message to send to the agent"},"session_id":{"type":"string","description":"The session id of the chat. Use the session_id to send a message to an existing conversation. If not present, a new session will be created after sending the first message."},"inputs":{"type":"object","additionalProperties":true,"description":"Optional inputs to send along with the message."}}}}}}
```

## The ChatResponse object

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"components":{"schemas":{"ChatResponse":{"type":"object","properties":{"result":{"type":"object","additionalProperties":true,"description":"The result from calling the agent"}}}}}}
```

## The App object

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"components":{"schemas":{"App":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"background_color":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"active_version_id":{"type":"integer"},"emoji":{"type":"string"},"public":{"type":"boolean"},"uuid":{"type":"string","maxLength":36,"minLength":36},"readme":{"type":"string"}}}}}}
```

## The Execution object

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"components":{"schemas":{"Execution":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","running","error","success","cancelled","review_needed"]},"airops_apps_version_id":{"type":"integer"},"conversation_id":{"type":"string"},"credits_used":{"type":"integer"},"error_code":{"type":"string"},"error_message":{},"feedback":{"type":"string","enum":["positive","neutral","negative"]},"inputs":{"type":"object"},"output":{"type":"object"},"runtime":{"type":"integer","description":"The time it took to execute the app in seconds"},"source":{"type":"string"},"uuid":{"type":"string","maxLength":36,"minLength":36},"workspace_id":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","status","createdAt","updatedAt"]}}}}
```

## The MemoryStoreSearchResultItem object

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"components":{"schemas":{"MemoryStoreSearchResultItem":{"type":"object","properties":{"id":{"type":"string"},"score":{"type":"number"},"content":{"type":"string"},"document_name":{"type":"string"},"metadata":{"type":"object"}},"required":["id","score","content","document_name","metadata"]}}}}
```

## The MemoryStoreDocument object

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"components":{"schemas":{"MemoryStoreDocument":{"type":"object","properties":{"id":{"type":"number"},"document_type":{"type":"string"},"name":{"type":"string"},"source":{"type":"string"},"status":{"type":"string"},"sync_progress_percentage":{"type":"number"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"vector_store_id":{"type":"number"}}}}}}
```

## The WorkflowStep object

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"components":{"schemas":{"WorkflowStep":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["llm","conditional","app","text","web_scrape","fetch_api","code","iteration"]},"config":{"anyOf":[{"$ref":"#/components/schemas/LLMConfig"},{"$ref":"#/components/schemas/ConditionalConfig"},{"$ref":"#/components/schemas/AppConfig"},{"$ref":"#/components/schemas/TextConfig"},{"$ref":"#/components/schemas/WebScrapeConfig"},{"$ref":"#/components/schemas/FetchAPIConfig"},{"$ref":"#/components/schemas/CodeConfig"},{"$ref":"#/components/schemas/IterationConfig"}]}},"required":["name","type","config"]},"LLMConfig":{"type":"object","properties":{"model":{"type":"string"},"soft_fail":{"type":"boolean"},"config":{"type":"object","properties":{"prompt":{"type":"string","description":"Use `prompt` if the model is gpt-3.5-turbo-instruct. Otherwise, use `messages``."},"messages":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["user","system","assistant"]},"content":{"type":"string"},"id":{"type":"string"},"images":{"type":"array","nullable":true,"items":{"type":"string"}}},"required":["role","content"]}},"request_consistent_results":{"type":"boolean"},"response_format":{"type":"string","nullable":true,"enum":["text","json_object"]},"stream":{"type":"boolean"},"temperature":{"type":"number","minimum":0,"maximum":1},"note":{"type":"string"},"model_source":{"type":"string","enum":["airops"]},"max_tokens":{"type":"integer","nullable":true,"minimum":1},"json_schema":{"type":"object","nullable":true,"properties":{"schema":{"type":"object","properties":{"type":{"type":"object","properties":{"type":{"type":"object"}}}}},"strict":{"type":"boolean"},"name":{"type":"string"}},"required":["schema","strict","name"]}},"required":["prompt","messages","request_consistent_results","response_format","stream","temperature","note","model_source","max_tokens"]}},"required":["model","soft_fail","config"]},"ConditionalConfig":{"type":"object","properties":{"condition":{"type":"string","description":"The condition to evaluate. Must be javascript compatible code."},"if_branch":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowStep"}},"else_branch":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowStep"}}},"required":["condition","if_branch","else_branch"]},"AppConfig":{"type":"object","properties":{"app_id":{"type":"integer"},"app_version":{"type":"integer","nullable":true},"inputs":{"type":"object"},"soft_fail":{"type":"boolean"}},"required":["app_id","inputs"]},"TextConfig":{"type":"object","properties":{"template":{"type":"string"}},"required":["template"]},"WebScrapeConfig":{"type":"object","properties":{"config":{"type":"object","properties":{"url":{"type":"string"},"max_length":{"type":"integer","nullable":true,"minimum":0},"hard_fail":{"type":"boolean","nullable":true},"render_js":{"type":"boolean","nullable":true},"proxy_type":{"type":"string","enum":["auto","datacenter","residential"]},"output_type":{"type":"string","nullable":true,"enum":["text","html","markdown"]},"timeout":{"type":"integer","nullable":true,"minimum":5000,"maximum":150000},"remove_boilerplate":{"type":"boolean","nullable":true},"optimize_for":{"type":"string","enum":["custom","speed","accuracy"]},"soft_fail":{"type":"boolean","nullable":true},"auto_scroll":{"type":"boolean","nullable":true}},"required":["url"]}}},"FetchAPIConfig":{"type":"object","properties":{"body":{"type":"string","description":"The jsonified body of the request"},"headers":{"type":"string","description":"The jsonified headers of the request"},"method":{"type":"string","enum":["get","post"]},"retries":{"type":"integer","minimum":0,"maximum":3},"url":{"type":"string"},"soft_fail":{"type":"boolean"}},"required":["method","url"]},"CodeConfig":{"type":"object","properties":{"config":{"type":"object","properties":{"language":{"type":"string","enum":["python","javascript"]},"function":{"type":"string"},"soft_fail":{"type":"boolean"},"lambda_function":{"type":"string"}},"required":["language","function"]}}},"IterationConfig":{"type":"object","properties":{"config":{"type":"object","properties":{"iterator":{"type":"string"},"step_function":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowStep"}}},"required":["iterator","step_function"]}}}}}}
```

## The LLMConfig object

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"components":{"schemas":{"LLMConfig":{"type":"object","properties":{"model":{"type":"string"},"soft_fail":{"type":"boolean"},"config":{"type":"object","properties":{"prompt":{"type":"string","description":"Use `prompt` if the model is gpt-3.5-turbo-instruct. Otherwise, use `messages``."},"messages":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["user","system","assistant"]},"content":{"type":"string"},"id":{"type":"string"},"images":{"type":"array","nullable":true,"items":{"type":"string"}}},"required":["role","content"]}},"request_consistent_results":{"type":"boolean"},"response_format":{"type":"string","nullable":true,"enum":["text","json_object"]},"stream":{"type":"boolean"},"temperature":{"type":"number","minimum":0,"maximum":1},"note":{"type":"string"},"model_source":{"type":"string","enum":["airops"]},"max_tokens":{"type":"integer","nullable":true,"minimum":1},"json_schema":{"type":"object","nullable":true,"properties":{"schema":{"type":"object","properties":{"type":{"type":"object","properties":{"type":{"type":"object"}}}}},"strict":{"type":"boolean"},"name":{"type":"string"}},"required":["schema","strict","name"]}},"required":["prompt","messages","request_consistent_results","response_format","stream","temperature","note","model_source","max_tokens"]}},"required":["model","soft_fail","config"]}}}}
```

## The ConditionalConfig object

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"components":{"schemas":{"ConditionalConfig":{"type":"object","properties":{"condition":{"type":"string","description":"The condition to evaluate. Must be javascript compatible code."},"if_branch":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowStep"}},"else_branch":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowStep"}}},"required":["condition","if_branch","else_branch"]},"WorkflowStep":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["llm","conditional","app","text","web_scrape","fetch_api","code","iteration"]},"config":{"anyOf":[{"$ref":"#/components/schemas/LLMConfig"},{"$ref":"#/components/schemas/ConditionalConfig"},{"$ref":"#/components/schemas/AppConfig"},{"$ref":"#/components/schemas/TextConfig"},{"$ref":"#/components/schemas/WebScrapeConfig"},{"$ref":"#/components/schemas/FetchAPIConfig"},{"$ref":"#/components/schemas/CodeConfig"},{"$ref":"#/components/schemas/IterationConfig"}]}},"required":["name","type","config"]},"LLMConfig":{"type":"object","properties":{"model":{"type":"string"},"soft_fail":{"type":"boolean"},"config":{"type":"object","properties":{"prompt":{"type":"string","description":"Use `prompt` if the model is gpt-3.5-turbo-instruct. Otherwise, use `messages``."},"messages":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["user","system","assistant"]},"content":{"type":"string"},"id":{"type":"string"},"images":{"type":"array","nullable":true,"items":{"type":"string"}}},"required":["role","content"]}},"request_consistent_results":{"type":"boolean"},"response_format":{"type":"string","nullable":true,"enum":["text","json_object"]},"stream":{"type":"boolean"},"temperature":{"type":"number","minimum":0,"maximum":1},"note":{"type":"string"},"model_source":{"type":"string","enum":["airops"]},"max_tokens":{"type":"integer","nullable":true,"minimum":1},"json_schema":{"type":"object","nullable":true,"properties":{"schema":{"type":"object","properties":{"type":{"type":"object","properties":{"type":{"type":"object"}}}}},"strict":{"type":"boolean"},"name":{"type":"string"}},"required":["schema","strict","name"]}},"required":["prompt","messages","request_consistent_results","response_format","stream","temperature","note","model_source","max_tokens"]}},"required":["model","soft_fail","config"]},"AppConfig":{"type":"object","properties":{"app_id":{"type":"integer"},"app_version":{"type":"integer","nullable":true},"inputs":{"type":"object"},"soft_fail":{"type":"boolean"}},"required":["app_id","inputs"]},"TextConfig":{"type":"object","properties":{"template":{"type":"string"}},"required":["template"]},"WebScrapeConfig":{"type":"object","properties":{"config":{"type":"object","properties":{"url":{"type":"string"},"max_length":{"type":"integer","nullable":true,"minimum":0},"hard_fail":{"type":"boolean","nullable":true},"render_js":{"type":"boolean","nullable":true},"proxy_type":{"type":"string","enum":["auto","datacenter","residential"]},"output_type":{"type":"string","nullable":true,"enum":["text","html","markdown"]},"timeout":{"type":"integer","nullable":true,"minimum":5000,"maximum":150000},"remove_boilerplate":{"type":"boolean","nullable":true},"optimize_for":{"type":"string","enum":["custom","speed","accuracy"]},"soft_fail":{"type":"boolean","nullable":true},"auto_scroll":{"type":"boolean","nullable":true}},"required":["url"]}}},"FetchAPIConfig":{"type":"object","properties":{"body":{"type":"string","description":"The jsonified body of the request"},"headers":{"type":"string","description":"The jsonified headers of the request"},"method":{"type":"string","enum":["get","post"]},"retries":{"type":"integer","minimum":0,"maximum":3},"url":{"type":"string"},"soft_fail":{"type":"boolean"}},"required":["method","url"]},"CodeConfig":{"type":"object","properties":{"config":{"type":"object","properties":{"language":{"type":"string","enum":["python","javascript"]},"function":{"type":"string"},"soft_fail":{"type":"boolean"},"lambda_function":{"type":"string"}},"required":["language","function"]}}},"IterationConfig":{"type":"object","properties":{"config":{"type":"object","properties":{"iterator":{"type":"string"},"step_function":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowStep"}}},"required":["iterator","step_function"]}}}}}}
```

## The AppConfig object

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"components":{"schemas":{"AppConfig":{"type":"object","properties":{"app_id":{"type":"integer"},"app_version":{"type":"integer","nullable":true},"inputs":{"type":"object"},"soft_fail":{"type":"boolean"}},"required":["app_id","inputs"]}}}}
```

## The TextConfig object

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"components":{"schemas":{"TextConfig":{"type":"object","properties":{"template":{"type":"string"}},"required":["template"]}}}}
```

## The WebScrapeConfig object

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"components":{"schemas":{"WebScrapeConfig":{"type":"object","properties":{"config":{"type":"object","properties":{"url":{"type":"string"},"max_length":{"type":"integer","nullable":true,"minimum":0},"hard_fail":{"type":"boolean","nullable":true},"render_js":{"type":"boolean","nullable":true},"proxy_type":{"type":"string","enum":["auto","datacenter","residential"]},"output_type":{"type":"string","nullable":true,"enum":["text","html","markdown"]},"timeout":{"type":"integer","nullable":true,"minimum":5000,"maximum":150000},"remove_boilerplate":{"type":"boolean","nullable":true},"optimize_for":{"type":"string","enum":["custom","speed","accuracy"]},"soft_fail":{"type":"boolean","nullable":true},"auto_scroll":{"type":"boolean","nullable":true}},"required":["url"]}}}}}}
```

## The FetchAPIConfig object

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"components":{"schemas":{"FetchAPIConfig":{"type":"object","properties":{"body":{"type":"string","description":"The jsonified body of the request"},"headers":{"type":"string","description":"The jsonified headers of the request"},"method":{"type":"string","enum":["get","post"]},"retries":{"type":"integer","minimum":0,"maximum":3},"url":{"type":"string"},"soft_fail":{"type":"boolean"}},"required":["method","url"]}}}}
```

## The CodeConfig object

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"components":{"schemas":{"CodeConfig":{"type":"object","properties":{"config":{"type":"object","properties":{"language":{"type":"string","enum":["python","javascript"]},"function":{"type":"string"},"soft_fail":{"type":"boolean"},"lambda_function":{"type":"string"}},"required":["language","function"]}}}}}}
```

## The IterationConfig object

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"components":{"schemas":{"IterationConfig":{"type":"object","properties":{"config":{"type":"object","properties":{"iterator":{"type":"string"},"step_function":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowStep"}}},"required":["iterator","step_function"]}}},"WorkflowStep":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["llm","conditional","app","text","web_scrape","fetch_api","code","iteration"]},"config":{"anyOf":[{"$ref":"#/components/schemas/LLMConfig"},{"$ref":"#/components/schemas/ConditionalConfig"},{"$ref":"#/components/schemas/AppConfig"},{"$ref":"#/components/schemas/TextConfig"},{"$ref":"#/components/schemas/WebScrapeConfig"},{"$ref":"#/components/schemas/FetchAPIConfig"},{"$ref":"#/components/schemas/CodeConfig"},{"$ref":"#/components/schemas/IterationConfig"}]}},"required":["name","type","config"]},"LLMConfig":{"type":"object","properties":{"model":{"type":"string"},"soft_fail":{"type":"boolean"},"config":{"type":"object","properties":{"prompt":{"type":"string","description":"Use `prompt` if the model is gpt-3.5-turbo-instruct. Otherwise, use `messages``."},"messages":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["user","system","assistant"]},"content":{"type":"string"},"id":{"type":"string"},"images":{"type":"array","nullable":true,"items":{"type":"string"}}},"required":["role","content"]}},"request_consistent_results":{"type":"boolean"},"response_format":{"type":"string","nullable":true,"enum":["text","json_object"]},"stream":{"type":"boolean"},"temperature":{"type":"number","minimum":0,"maximum":1},"note":{"type":"string"},"model_source":{"type":"string","enum":["airops"]},"max_tokens":{"type":"integer","nullable":true,"minimum":1},"json_schema":{"type":"object","nullable":true,"properties":{"schema":{"type":"object","properties":{"type":{"type":"object","properties":{"type":{"type":"object"}}}}},"strict":{"type":"boolean"},"name":{"type":"string"}},"required":["schema","strict","name"]}},"required":["prompt","messages","request_consistent_results","response_format","stream","temperature","note","model_source","max_tokens"]}},"required":["model","soft_fail","config"]},"ConditionalConfig":{"type":"object","properties":{"condition":{"type":"string","description":"The condition to evaluate. Must be javascript compatible code."},"if_branch":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowStep"}},"else_branch":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowStep"}}},"required":["condition","if_branch","else_branch"]},"AppConfig":{"type":"object","properties":{"app_id":{"type":"integer"},"app_version":{"type":"integer","nullable":true},"inputs":{"type":"object"},"soft_fail":{"type":"boolean"}},"required":["app_id","inputs"]},"TextConfig":{"type":"object","properties":{"template":{"type":"string"}},"required":["template"]},"WebScrapeConfig":{"type":"object","properties":{"config":{"type":"object","properties":{"url":{"type":"string"},"max_length":{"type":"integer","nullable":true,"minimum":0},"hard_fail":{"type":"boolean","nullable":true},"render_js":{"type":"boolean","nullable":true},"proxy_type":{"type":"string","enum":["auto","datacenter","residential"]},"output_type":{"type":"string","nullable":true,"enum":["text","html","markdown"]},"timeout":{"type":"integer","nullable":true,"minimum":5000,"maximum":150000},"remove_boilerplate":{"type":"boolean","nullable":true},"optimize_for":{"type":"string","enum":["custom","speed","accuracy"]},"soft_fail":{"type":"boolean","nullable":true},"auto_scroll":{"type":"boolean","nullable":true}},"required":["url"]}}},"FetchAPIConfig":{"type":"object","properties":{"body":{"type":"string","description":"The jsonified body of the request"},"headers":{"type":"string","description":"The jsonified headers of the request"},"method":{"type":"string","enum":["get","post"]},"retries":{"type":"integer","minimum":0,"maximum":3},"url":{"type":"string"},"soft_fail":{"type":"boolean"}},"required":["method","url"]},"CodeConfig":{"type":"object","properties":{"config":{"type":"object","properties":{"language":{"type":"string","enum":["python","javascript"]},"function":{"type":"string"},"soft_fail":{"type":"boolean"},"lambda_function":{"type":"string"}},"required":["language","function"]}}}}}}
```

## The BrandKit object

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"components":{"schemas":{"BrandKit":{"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"}}}}}}}
```

## The BrandKitListResponse object

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"components":{"schemas":{"BrandKitListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BrandKit"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","meta"]},"BrandKit":{"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"}}}},"PaginationMeta":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Items per page"},"total_count":{"type":"integer","description":"Total number of items"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}
```

## The BrandKitShowResponse object

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"components":{"schemas":{"BrandKitShowResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BrandKit"}},"required":["data"]},"BrandKit":{"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"}}}}}}}
```

## The PaginationMeta object

```json
{"openapi":"3.0.1","info":{"title":"API V1","version":"v1"},"components":{"schemas":{"PaginationMeta":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Items per page"},"total_count":{"type":"integer","description":"Total number of items"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}
```


---

# 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/models.md?ask=<question>&goal=<user_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.