> For the complete documentation index, see [llms.txt](https://docs.360dialog.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.360dialog.com/docs/mba/api-ref/models.md).

# Models

## The knowledge\_bi.BizAIOmniChannelKnowledgeBusinessInfoRequest object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_bi.BizAIOmniChannelKnowledgeBusinessInfoRequest":{"description":"Create or fully replace the business information for an entity","properties":{"business_description":{"type":"string"},"contact_info":{"$ref":"#/components/schemas/knowledge_bi.BizAIOmniChannelKnowledgeContactInfo"},"delivery_and_shipping":{"type":"string"},"payment_method":{"type":"string"},"purchase_info":{"type":"string"},"return_policy":{"type":"string"}},"type":"object"},"knowledge_bi.BizAIOmniChannelKnowledgeContactInfo":{"description":"Contact and location details for the business. Null if not configured","properties":{"address":{"type":"string"},"email":{"type":"string"},"hours_of_operation":{"type":"string"}},"type":"object"}}}}
```

## The knowledge\_bi.BizAIOmniChannelKnowledgeBusinessInfoResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_bi.BizAIOmniChannelKnowledgeBusinessInfoResponse":{"description":"The business information configured for an entity","properties":{"business_description":{"type":"string"},"contact_info":{"$ref":"#/components/schemas/knowledge_bi.BizAIOmniChannelKnowledgeContactInfo"},"delivery_and_shipping":{"type":"string"},"payment_method":{"type":"string"},"purchase_info":{"type":"string"},"return_policy":{"type":"string"}},"type":"object"},"knowledge_bi.BizAIOmniChannelKnowledgeContactInfo":{"description":"Contact and location details for the business. Null if not configured","properties":{"address":{"type":"string"},"email":{"type":"string"},"hours_of_operation":{"type":"string"}},"type":"object"}}}}
```

## The knowledge\_bi.BizAIOmniChannelKnowledgeContactInfo object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_bi.BizAIOmniChannelKnowledgeContactInfo":{"description":"Contact and location details for the business. Null if not configured","properties":{"address":{"type":"string"},"email":{"type":"string"},"hours_of_operation":{"type":"string"}},"type":"object"}}}}
```

## The knowledge\_bi.StandardError object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_bi.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"type":"string"},"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"}}}}
```

## The knowledge\_connector\_tools.BizAIOmniChannelConnectorToolBodyNode object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connector_tools.BizAIOmniChannelConnectorToolBodyNode":{"description":"Schema for a request body field or container","properties":{"binding":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterBinding"},"description":{"type":"string"},"items":{"type":"string"},"properties":{"additionalProperties":{"type":"string"},"type":"object"},"required":{"items":{"type":"string"},"type":"array","uniqueItems":false},"type":{"enum":["object","array","string","integer","number","boolean"],"type":"string"}},"required":["type"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterBinding":{"description":"Meta Business Agent-owned binding for this node; omitted means agent/runtime input. Cannot be provided for an \"object\" or \"array\" type node.","properties":{"kind":{"enum":["default","macro"],"type":"string"},"macro":{"enum":["WHATSAPP_PHONE_NUMBER","WHATSAPP_IDENTITY_HASH","WHATSAPP_CURRENT_STATUS_ID"],"type":"string"},"value":{"type":"string"}},"required":["kind"],"type":"object"}}}}
```

## The knowledge\_connector\_tools.BizAIOmniChannelConnectorToolParameterBinding object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterBinding":{"description":"Meta Business Agent-owned binding for this node; omitted means agent/runtime input. Cannot be provided for an \"object\" or \"array\" type node.","properties":{"kind":{"enum":["default","macro"],"type":"string"},"macro":{"enum":["WHATSAPP_PHONE_NUMBER","WHATSAPP_IDENTITY_HASH","WHATSAPP_CURRENT_STATUS_ID"],"type":"string"},"value":{"type":"string"}},"required":["kind"],"type":"object"}}}}
```

## The knowledge\_connector\_tools.BizAIOmniChannelConnectorToolParameterNode object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterNode":{"description":"Schema for a single path, query, or header parameter","properties":{"binding":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterBinding"},"description":{"type":"string"},"required":{"type":"boolean"},"type":{"enum":["string","integer","number","boolean"],"type":"string"}},"required":["type"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterBinding":{"description":"Meta Business Agent-owned binding for this node; omitted means agent/runtime input. Cannot be provided for an \"object\" or \"array\" type node.","properties":{"kind":{"enum":["default","macro"],"type":"string"},"macro":{"enum":["WHATSAPP_PHONE_NUMBER","WHATSAPP_IDENTITY_HASH","WHATSAPP_CURRENT_STATUS_ID"],"type":"string"},"value":{"type":"string"}},"required":["kind"],"type":"object"}}}}
```

## The knowledge\_connector\_tools.BizAIOmniChannelConnectorToolRequest object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connector_tools.BizAIOmniChannelConnectorToolRequest":{"description":"Create or update a connector tool","properties":{"description":{"type":"string"},"name":{"type":"string"},"request_definition":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolRequestDefinition"},"user_auth_action_config":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolUserAuthToolConfig"},"user_auth_required":{"type":"boolean"}},"required":["description","name","request_definition","user_auth_required"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolRequestDefinition":{"description":"Roundtripped outbound HTTP request definition","properties":{"body":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolRequestBodyDefinition"},"headers":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterNode"},"type":"object"},"method":{"enum":["GET","POST","PUT","DELETE","PATCH"],"type":"string"},"path":{"type":"string"},"path_parameters":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterNode"},"type":"object"},"query_parameters":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterNode"},"type":"object"}},"required":["method","path"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolRequestBodyDefinition":{"description":"Request body definition; omit or set to null when the request has no body","properties":{"content_type":{"enum":["application/json"],"type":"string"},"params":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolBodyNode"},"type":"object"},"required":{"items":{"type":"string"},"type":"array","uniqueItems":false}},"required":["content_type","params"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolBodyNode":{"description":"Schema for a request body field or container","properties":{"binding":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterBinding"},"description":{"type":"string"},"items":{"type":"string"},"properties":{"additionalProperties":{"type":"string"},"type":"object"},"required":{"items":{"type":"string"},"type":"array","uniqueItems":false},"type":{"enum":["object","array","string","integer","number","boolean"],"type":"string"}},"required":["type"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterBinding":{"description":"Meta Business Agent-owned binding for this node; omitted means agent/runtime input. Cannot be provided for an \"object\" or \"array\" type node.","properties":{"kind":{"enum":["default","macro"],"type":"string"},"macro":{"enum":["WHATSAPP_PHONE_NUMBER","WHATSAPP_IDENTITY_HASH","WHATSAPP_CURRENT_STATUS_ID"],"type":"string"},"value":{"type":"string"}},"required":["kind"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterNode":{"description":"Schema for a single path, query, or header parameter","properties":{"binding":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterBinding"},"description":{"type":"string"},"required":{"type":"boolean"},"type":{"enum":["string","integer","number","boolean"],"type":"string"}},"required":["type"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolUserAuthToolConfig":{"description":"Response extraction config for login/refresh user-auth actions","properties":{"expires_at_path":{"type":"string"},"expires_at_type":{"enum":["absolute","relative_seconds"],"type":"string"},"refresh_token_path":{"type":"string"},"user_action_tool_type":{"enum":["auth","refresh"],"type":"string"},"user_auth_token_path":{"type":"string"}},"required":["user_action_tool_type","user_auth_token_path"],"type":"object"}}}}
```

## The knowledge\_connector\_tools.BizAIOmniChannelConnectorToolRequestBodyDefinition object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connector_tools.BizAIOmniChannelConnectorToolRequestBodyDefinition":{"description":"Request body definition; omit or set to null when the request has no body","properties":{"content_type":{"enum":["application/json"],"type":"string"},"params":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolBodyNode"},"type":"object"},"required":{"items":{"type":"string"},"type":"array","uniqueItems":false}},"required":["content_type","params"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolBodyNode":{"description":"Schema for a request body field or container","properties":{"binding":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterBinding"},"description":{"type":"string"},"items":{"type":"string"},"properties":{"additionalProperties":{"type":"string"},"type":"object"},"required":{"items":{"type":"string"},"type":"array","uniqueItems":false},"type":{"enum":["object","array","string","integer","number","boolean"],"type":"string"}},"required":["type"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterBinding":{"description":"Meta Business Agent-owned binding for this node; omitted means agent/runtime input. Cannot be provided for an \"object\" or \"array\" type node.","properties":{"kind":{"enum":["default","macro"],"type":"string"},"macro":{"enum":["WHATSAPP_PHONE_NUMBER","WHATSAPP_IDENTITY_HASH","WHATSAPP_CURRENT_STATUS_ID"],"type":"string"},"value":{"type":"string"}},"required":["kind"],"type":"object"}}}}
```

## The knowledge\_connector\_tools.BizAIOmniChannelConnectorToolRequestDefinition object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connector_tools.BizAIOmniChannelConnectorToolRequestDefinition":{"description":"Roundtripped outbound HTTP request definition","properties":{"body":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolRequestBodyDefinition"},"headers":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterNode"},"type":"object"},"method":{"enum":["GET","POST","PUT","DELETE","PATCH"],"type":"string"},"path":{"type":"string"},"path_parameters":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterNode"},"type":"object"},"query_parameters":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterNode"},"type":"object"}},"required":["method","path"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolRequestBodyDefinition":{"description":"Request body definition; omit or set to null when the request has no body","properties":{"content_type":{"enum":["application/json"],"type":"string"},"params":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolBodyNode"},"type":"object"},"required":{"items":{"type":"string"},"type":"array","uniqueItems":false}},"required":["content_type","params"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolBodyNode":{"description":"Schema for a request body field or container","properties":{"binding":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterBinding"},"description":{"type":"string"},"items":{"type":"string"},"properties":{"additionalProperties":{"type":"string"},"type":"object"},"required":{"items":{"type":"string"},"type":"array","uniqueItems":false},"type":{"enum":["object","array","string","integer","number","boolean"],"type":"string"}},"required":["type"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterBinding":{"description":"Meta Business Agent-owned binding for this node; omitted means agent/runtime input. Cannot be provided for an \"object\" or \"array\" type node.","properties":{"kind":{"enum":["default","macro"],"type":"string"},"macro":{"enum":["WHATSAPP_PHONE_NUMBER","WHATSAPP_IDENTITY_HASH","WHATSAPP_CURRENT_STATUS_ID"],"type":"string"},"value":{"type":"string"}},"required":["kind"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterNode":{"description":"Schema for a single path, query, or header parameter","properties":{"binding":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterBinding"},"description":{"type":"string"},"required":{"type":"boolean"},"type":{"enum":["string","integer","number","boolean"],"type":"string"}},"required":["type"],"type":"object"}}}}
```

## The knowledge\_connector\_tools.BizAIOmniChannelConnectorToolResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connector_tools.BizAIOmniChannelConnectorToolResponse":{"description":"A single connector tool","properties":{"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"request_definition":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolRequestDefinition"},"user_auth_action_config":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolUserAuthActionConfig"},"user_auth_required":{"type":"boolean"}},"required":["description","id","name","request_definition","user_auth_required"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolRequestDefinition":{"description":"Roundtripped outbound HTTP request definition","properties":{"body":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolRequestBodyDefinition"},"headers":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterNode"},"type":"object"},"method":{"enum":["GET","POST","PUT","DELETE","PATCH"],"type":"string"},"path":{"type":"string"},"path_parameters":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterNode"},"type":"object"},"query_parameters":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterNode"},"type":"object"}},"required":["method","path"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolRequestBodyDefinition":{"description":"Request body definition; omit or set to null when the request has no body","properties":{"content_type":{"enum":["application/json"],"type":"string"},"params":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolBodyNode"},"type":"object"},"required":{"items":{"type":"string"},"type":"array","uniqueItems":false}},"required":["content_type","params"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolBodyNode":{"description":"Schema for a request body field or container","properties":{"binding":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterBinding"},"description":{"type":"string"},"items":{"type":"string"},"properties":{"additionalProperties":{"type":"string"},"type":"object"},"required":{"items":{"type":"string"},"type":"array","uniqueItems":false},"type":{"enum":["object","array","string","integer","number","boolean"],"type":"string"}},"required":["type"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterBinding":{"description":"Meta Business Agent-owned binding for this node; omitted means agent/runtime input. Cannot be provided for an \"object\" or \"array\" type node.","properties":{"kind":{"enum":["default","macro"],"type":"string"},"macro":{"enum":["WHATSAPP_PHONE_NUMBER","WHATSAPP_IDENTITY_HASH","WHATSAPP_CURRENT_STATUS_ID"],"type":"string"},"value":{"type":"string"}},"required":["kind"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterNode":{"description":"Schema for a single path, query, or header parameter","properties":{"binding":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterBinding"},"description":{"type":"string"},"required":{"type":"boolean"},"type":{"enum":["string","integer","number","boolean"],"type":"string"}},"required":["type"],"type":"object"},"knowledge_connector_tools.BizAIOmniChannelConnectorToolUserAuthActionConfig":{"description":"Response extraction config for login/refresh user-auth actions","properties":{"expires_at_path":{"type":"string"},"expires_at_type":{"enum":["absolute","relative_seconds"],"type":"string"},"refresh_token_path":{"type":"string"},"user_action_tool_type":{"enum":["auth","refresh"],"type":"string"},"user_auth_token_path":{"type":"string"}},"required":["user_action_tool_type","user_auth_token_path"],"type":"object"}}}}
```

## The knowledge\_connector\_tools.BizAIOmniChannelConnectorToolRunRequest object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connector_tools.BizAIOmniChannelConnectorToolRunRequest":{"description":"Execute a tool action","properties":{"input":{"type":"string"}},"type":"object"}}}}
```

## The knowledge\_connector\_tools.BizAIOmniChannelConnectorToolRunResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connector_tools.BizAIOmniChannelConnectorToolRunResponse":{"description":"The result of executing a tool action","properties":{"output":{"type":"string"},"status":{"type":"string"}},"required":["output","status"],"type":"object"}}}}
```

## The knowledge\_connector\_tools.BizAIOmniChannelConnectorToolUserAuthActionConfig object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connector_tools.BizAIOmniChannelConnectorToolUserAuthActionConfig":{"description":"Response extraction config for login/refresh user-auth actions","properties":{"expires_at_path":{"type":"string"},"expires_at_type":{"enum":["absolute","relative_seconds"],"type":"string"},"refresh_token_path":{"type":"string"},"user_action_tool_type":{"enum":["auth","refresh"],"type":"string"},"user_auth_token_path":{"type":"string"}},"required":["user_action_tool_type","user_auth_token_path"],"type":"object"}}}}
```

## The knowledge\_connector\_tools.BizAIOmniChannelConnectorToolUserAuthToolConfig object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connector_tools.BizAIOmniChannelConnectorToolUserAuthToolConfig":{"description":"Response extraction config for login/refresh user-auth actions","properties":{"expires_at_path":{"type":"string"},"expires_at_type":{"enum":["absolute","relative_seconds"],"type":"string"},"refresh_token_path":{"type":"string"},"user_action_tool_type":{"enum":["auth","refresh"],"type":"string"},"user_auth_token_path":{"type":"string"}},"required":["user_action_tool_type","user_auth_token_path"],"type":"object"}}}}
```

## The knowledge\_connector\_tools.StandardError object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connector_tools.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"type":"string"},"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"}}}}
```

## The knowledge\_connectors.BizAIOmniChannelConnectorApiKeyAuthConfig object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorApiKeyAuthConfig":{"description":"API key configuration. Provide only when auth_type is API_KEY.","properties":{"body_params":{"items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"headers":{"items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"query_params":{"items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false}},"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam":{"description":"A single API key field","properties":{"field_name":{"type":"string"},"prefix":{"type":"string"},"value":{"type":"string"}},"required":["field_name","value"],"type":"object"}}}}
```

## The knowledge\_connectors.BizAIOmniChannelConnectorApiKeyParam object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam":{"description":"A single API key field","properties":{"field_name":{"type":"string"},"prefix":{"type":"string"},"value":{"type":"string"}},"required":["field_name","value"],"type":"object"}}}}
```

## The knowledge\_connectors.BizAIOmniChannelConnectorAuthConfig object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorAuthConfig":{"description":"Authentication configuration for this connector","properties":{"api_key":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyAuthConfig"},"oauth2_client_credentials":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorOAuth2ClientCredentialsAuthConfig"}},"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorApiKeyAuthConfig":{"description":"API key configuration. Provide only when auth_type is API_KEY.","properties":{"body_params":{"items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"headers":{"items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"query_params":{"items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false}},"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam":{"description":"A single API key field","properties":{"field_name":{"type":"string"},"prefix":{"type":"string"},"value":{"type":"string"}},"required":["field_name","value"],"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorOAuth2ClientCredentialsAuthConfig":{"description":"OAuth 2.0 client credentials configuration. Provide only when auth_type is OAUTH2_CLIENT_CREDENTIALS.","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"scopes_to_request":{"items":{"type":"string"},"type":"array","uniqueItems":false},"token_request_content_type":{"type":"string"},"token_url":{"type":"string"}},"required":["client_id","client_secret","scopes_to_request","token_url"],"type":"object"}}}}
```

## The knowledge\_connectors.BizAIOmniChannelConnectorCertificateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorCertificateRequest":{"description":"Upload or rotate the mTLS client certificate for a connector","properties":{"ca_certificate":{"type":"string"},"client_certificate":{"type":"string"},"client_key":{"type":"string"}},"required":["client_certificate","client_key"],"type":"object"}}}}
```

## The knowledge\_connectors.BizAIOmniChannelConnectorConnectionStatus object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorConnectionStatus":{"description":"Connection status information","properties":{"error_message":{"type":"string"},"status":{"enum":["PENDING_OAUTH","ACTIVE","EXPIRED","ERROR"],"type":"string"}},"required":["status"],"type":"object"}}}}
```

## The knowledge\_connectors.BizAIOmniChannelConnectorLogEntry object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorLogEntry":{"description":"A log entry (individual mode) or failure pattern (summary_only mode)","properties":{"error_message":{"type":"string"},"event_time":{"type":"string"},"failure_code_name":{"type":"string"},"last_seen":{"type":"string"},"occurrences":{"type":"integer"},"tool_name":{"type":"string"}},"type":"object"}}}}
```

## The knowledge\_connectors.BizAIOmniChannelConnectorLogStats object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorLogStats":{"description":"Aggregate statistics for the queried time window, present when include_stats is true","properties":{"avg_latency_s":{"type":"number"},"exception_count":{"type":"integer"},"p95_latency_s":{"type":"number"},"p99_latency_s":{"type":"number"},"start_count":{"type":"integer"},"success_count":{"type":"integer"},"success_rate":{"type":"number"},"time_window_seconds":{"type":"integer"}},"required":["avg_latency_s","exception_count","p95_latency_s","p99_latency_s","start_count","success_count","success_rate","time_window_seconds"],"type":"object"}}}}
```

## The knowledge\_connectors.BizAIOmniChannelConnectorLogStatsResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorLogStatsResponse":{"description":"Log entries or failure patterns, with optional statistics","properties":{"data":{"items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorLogEntry"},"type":"array","uniqueItems":false},"stats":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorLogStats"}},"required":["data"],"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorLogEntry":{"description":"A log entry (individual mode) or failure pattern (summary_only mode)","properties":{"error_message":{"type":"string"},"event_time":{"type":"string"},"failure_code_name":{"type":"string"},"last_seen":{"type":"string"},"occurrences":{"type":"integer"},"tool_name":{"type":"string"}},"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorLogStats":{"description":"Aggregate statistics for the queried time window, present when include_stats is true","properties":{"avg_latency_s":{"type":"number"},"exception_count":{"type":"integer"},"p95_latency_s":{"type":"number"},"p99_latency_s":{"type":"number"},"start_count":{"type":"integer"},"success_count":{"type":"integer"},"success_rate":{"type":"number"},"time_window_seconds":{"type":"integer"}},"required":["avg_latency_s","exception_count","p95_latency_s","p99_latency_s","start_count","success_count","success_rate","time_window_seconds"],"type":"object"}}}}
```

## The knowledge\_connectors.BizAIOmniChannelConnectorMtlsConfig object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorMtlsConfig":{"description":"mTLS certificate metadata and PEM content (private key is never exposed)","properties":{"ca_certificate":{"type":"string"},"client_certificate":{"type":"string"},"expires_at":{"type":"integer"},"fingerprint":{"type":"string"},"has_certificate":{"type":"boolean"},"subject":{"type":"string"}},"required":["has_certificate"],"type":"object"}}}}
```

## The knowledge\_connectors.BizAIOmniChannelConnectorOAuth2ClientCredentialsAuthConfig object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorOAuth2ClientCredentialsAuthConfig":{"description":"OAuth 2.0 client credentials configuration. Provide only when auth_type is OAUTH2_CLIENT_CREDENTIALS.","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"scopes_to_request":{"items":{"type":"string"},"type":"array","uniqueItems":false},"token_request_content_type":{"type":"string"},"token_url":{"type":"string"}},"required":["client_id","client_secret","scopes_to_request","token_url"],"type":"object"}}}}
```

## The knowledge\_connectors.BizAIOmniChannelConnectorRequest object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorRequest":{"description":"Create or update a connector","properties":{"auth_config":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorAuthConfig"},"auth_type":{"enum":["OAUTH2","OAUTH2_CLIENT_CREDENTIALS","API_KEY","BASIC","CUSTOM","NONE"],"type":"string"},"base_url":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"requires_certificate":{"type":"boolean"},"user_auth_injection_config":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorUserAuthInjectionConfig"}},"required":["auth_type","base_url","description","name"],"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorAuthConfig":{"description":"Authentication configuration for this connector","properties":{"api_key":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyAuthConfig"},"oauth2_client_credentials":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorOAuth2ClientCredentialsAuthConfig"}},"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorApiKeyAuthConfig":{"description":"API key configuration. Provide only when auth_type is API_KEY.","properties":{"body_params":{"items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"headers":{"items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"query_params":{"items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false}},"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam":{"description":"A single API key field","properties":{"field_name":{"type":"string"},"prefix":{"type":"string"},"value":{"type":"string"}},"required":["field_name","value"],"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorOAuth2ClientCredentialsAuthConfig":{"description":"OAuth 2.0 client credentials configuration. Provide only when auth_type is OAUTH2_CLIENT_CREDENTIALS.","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"scopes_to_request":{"items":{"type":"string"},"type":"array","uniqueItems":false},"token_request_content_type":{"type":"string"},"token_url":{"type":"string"}},"required":["client_id","client_secret","scopes_to_request","token_url"],"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorUserAuthInjectionConfig":{"description":"Configuration for injecting user auth tokens into tool requests","properties":{"field_name":{"type":"string"},"location":{"enum":["body","headers","path","query"],"type":"string"},"prefix":{"type":"string"}},"required":["field_name","location","prefix"],"type":"object"}}}}
```

## The knowledge\_connectors.BizAIOmniChannelConnectorResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorResponse":{"description":"A single connector","properties":{"auth_config":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorAuthConfig"},"auth_type":{"enum":["OAUTH2","OAUTH2_CLIENT_CREDENTIALS","API_KEY","BASIC","CUSTOM","NONE"],"type":"string"},"base_url":{"type":"string"},"connection_status":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorConnectionStatus"},"description":{"type":"string"},"id":{"type":"string"},"mtls_config":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorMtlsConfig"},"name":{"type":"string"},"user_auth_injection_config":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorUserAuthInjectionConfig"}},"required":["auth_type","base_url","connection_status","description","id","name"],"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorAuthConfig":{"description":"Authentication configuration for this connector","properties":{"api_key":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyAuthConfig"},"oauth2_client_credentials":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorOAuth2ClientCredentialsAuthConfig"}},"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorApiKeyAuthConfig":{"description":"API key configuration. Provide only when auth_type is API_KEY.","properties":{"body_params":{"items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"headers":{"items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"query_params":{"items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false}},"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam":{"description":"A single API key field","properties":{"field_name":{"type":"string"},"prefix":{"type":"string"},"value":{"type":"string"}},"required":["field_name","value"],"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorOAuth2ClientCredentialsAuthConfig":{"description":"OAuth 2.0 client credentials configuration. Provide only when auth_type is OAUTH2_CLIENT_CREDENTIALS.","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"scopes_to_request":{"items":{"type":"string"},"type":"array","uniqueItems":false},"token_request_content_type":{"type":"string"},"token_url":{"type":"string"}},"required":["client_id","client_secret","scopes_to_request","token_url"],"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorConnectionStatus":{"description":"Connection status information","properties":{"error_message":{"type":"string"},"status":{"enum":["PENDING_OAUTH","ACTIVE","EXPIRED","ERROR"],"type":"string"}},"required":["status"],"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorMtlsConfig":{"description":"mTLS certificate metadata and PEM content (private key is never exposed)","properties":{"ca_certificate":{"type":"string"},"client_certificate":{"type":"string"},"expires_at":{"type":"integer"},"fingerprint":{"type":"string"},"has_certificate":{"type":"boolean"},"subject":{"type":"string"}},"required":["has_certificate"],"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorUserAuthInjectionConfig":{"description":"Configuration for injecting user auth tokens into tool requests","properties":{"field_name":{"type":"string"},"location":{"enum":["body","headers","path","query"],"type":"string"},"prefix":{"type":"string"}},"required":["field_name","location","prefix"],"type":"object"}}}}
```

## The knowledge\_connectors.BizAIOmniChannelConnectorUpsertApiKeyRequest object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorUpsertApiKeyRequest":{"description":"Set or rotate the API key credentials for a connector","properties":{"api_key_config":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyAuthConfig"}},"required":["api_key_config"],"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorApiKeyAuthConfig":{"description":"API key configuration. Provide only when auth_type is API_KEY.","properties":{"body_params":{"items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"headers":{"items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"query_params":{"items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false}},"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam":{"description":"A single API key field","properties":{"field_name":{"type":"string"},"prefix":{"type":"string"},"value":{"type":"string"}},"required":["field_name","value"],"type":"object"}}}}
```

## The knowledge\_connectors.BizAIOmniChannelConnectorUpsertOAuthRequest object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorUpsertOAuthRequest":{"description":"Set or rotate the OAuth 2.0 client credentials for a connector","properties":{"oauth_config":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorOAuth2ClientCredentialsAuthConfig"}},"required":["oauth_config"],"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorOAuth2ClientCredentialsAuthConfig":{"description":"OAuth 2.0 client credentials configuration. Provide only when auth_type is OAUTH2_CLIENT_CREDENTIALS.","properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"scopes_to_request":{"items":{"type":"string"},"type":"array","uniqueItems":false},"token_request_content_type":{"type":"string"},"token_url":{"type":"string"}},"required":["client_id","client_secret","scopes_to_request","token_url"],"type":"object"}}}}
```

## The knowledge\_connectors.BizAIOmniChannelConnectorUserAuthInjectionConfig object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorUserAuthInjectionConfig":{"description":"Configuration for injecting user auth tokens into tool requests","properties":{"field_name":{"type":"string"},"location":{"enum":["body","headers","path","query"],"type":"string"},"prefix":{"type":"string"}},"required":["field_name","location","prefix"],"type":"object"}}}}
```

## The knowledge\_connectors.StandardError object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_connectors.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"type":"string"},"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"}}}}
```

## The knowledge\_faq.BizAIOmniChannelKnowledgeFAQRequest object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_faq.BizAIOmniChannelKnowledgeFAQRequest":{"description":"Create or update an FAQ entry","properties":{"answer":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"question":{"type":"string"}},"required":["answer","question"],"type":"object"}}}}
```

## The knowledge\_faq.BizAIOmniChannelKnowledgeFAQResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_faq.BizAIOmniChannelKnowledgeFAQResponse":{"description":"A single FAQ entry","properties":{"answer":{"type":"string"},"created_at":{"type":"integer"},"id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"question":{"type":"string"}},"required":["answer","id","question"],"type":"object"}}}}
```

## The knowledge\_faq.StandardError object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_faq.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"type":"string"},"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"}}}}
```

## The knowledge\_files.BizAIOmniChannelKnowledgeFileResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_files.BizAIOmniChannelKnowledgeFileResponse":{"description":"Metadata of a knowledge base file","properties":{"file_name":{"type":"string"},"id":{"type":"string"}},"required":["file_name","id"],"type":"object"}}}}
```

## The knowledge\_files.StandardError object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_files.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"type":"string"},"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"}}}}
```

## The knowledge\_skills.BizAIOmniChannelSkillsRequest object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_skills.BizAIOmniChannelSkillsRequest":{"description":"Create or update an AI skill","properties":{"description":{"type":"string"},"skill":{"type":"string"},"title":{"type":"string"}},"type":"object"}}}}
```

## The knowledge\_skills.BizAIOmniChannelSkillsResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_skills.BizAIOmniChannelSkillsResponse":{"description":"A single AI skill","properties":{"channel":{"enum":["email","instagram","line","messenger","sms","tiktok","unknown","webchat","whatsapp"],"type":"string"},"created_at":{"type":"integer"},"description":{"type":"string"},"id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"skill":{"type":"string"},"title":{"type":"string"}},"required":["channel","id","skill"],"type":"object"}}}}
```

## The knowledge\_skills.StandardError object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_skills.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"type":"string"},"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"}}}}
```

## The knowledge\_websites.BizAIKnowledgeWebsiteRequest object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_websites.BizAIKnowledgeWebsiteRequest":{"description":"Add or update a website crawl entry","properties":{"url":{"type":"string"}},"required":["url"],"type":"object"}}}}
```

## The knowledge\_websites.BizAIKnowledgeWebsiteResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_websites.BizAIKnowledgeWebsiteResponse":{"description":"A single website crawl entry","properties":{"crawl_status":{"type":"string"},"created_at":{"type":"integer"},"id":{"type":"string"},"last_crawled_at":{"type":"integer"},"pages_crawled":{"type":"integer"},"url":{"type":"string"}},"required":["id","url"],"type":"object"}}}}
```

## The knowledge\_websites.StandardError object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"knowledge_websites.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"type":"string"},"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"}}}}
```

## The onboard.BizAIOmniChannelAllowlistRequest object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"onboard.BizAIOmniChannelAllowlistRequest":{"description":"Request payload to add a consumer WhatsApp phone number to the allowlist","properties":{"consumer_phone_number":{"type":"string"}},"required":["consumer_phone_number"],"type":"object"}}}}
```

## The onboard.BizAIOmniChannelAllowlistResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"onboard.BizAIOmniChannelAllowlistResponse":{"description":"A single allowlist entry","properties":{"consumer_phone_number":{"type":"string"},"id":{"type":"string"}},"type":"object"}}}}
```

## The onboard.BizAIOmniChannelDeleteAgentResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"onboard.BizAIOmniChannelDeleteAgentResponse":{"description":"Result of removing the Meta Business agent from the phone number","properties":{"deleted_agent_id":{"type":"string"}},"type":"object"}}}}
```

## The onboard.BizAIOmniChannelEligibilityResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"onboard.BizAIOmniChannelEligibilityResponse":{"description":"Eligibility result for the entity","properties":{"is_eligible":{"type":"boolean"}},"type":"object"}}}}
```

## The onboard.BizAIOmniChannelOnboardingResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"onboard.BizAIOmniChannelOnboardingResponse":{"description":"Result of triggering AI agent onboarding","properties":{"agent_id":{"type":"string"}},"type":"object"}}}}
```

## The onboard.BizAIOmniChannelSettingsFollowup object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"onboard.BizAIOmniChannelSettingsFollowup":{"description":"Settings for following up with an inactive user. Null if not configured","properties":{"enabled":{"type":"boolean"},"followup_interval_in_seconds":{"enum":[0,300,900,1800,3600,7200,28800,86400],"type":"integer"},"message":{"type":"string"}},"required":["enabled"],"type":"object"}}}}
```

## The onboard.BizAIOmniChannelSettingsHandoff object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"onboard.BizAIOmniChannelSettingsHandoff":{"description":"Settings for handing over the conversation to a human agent. Null if not configured","properties":{"enabled":{"type":"boolean"},"message":{"type":"string"}},"required":["enabled"],"type":"object"}}}}
```

## The onboard.BizAIOmniChannelSettingsRequest object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"onboard.BizAIOmniChannelSettingsRequest":{"description":"Create or fully replace the AI agent settings for an entity","properties":{"ai_audience":{"enum":["ALLOWLISTED_ONLY","EVERYONE"],"type":"string"},"followup":{"$ref":"#/components/schemas/onboard.BizAIOmniChannelSettingsFollowup"},"handoff":{"$ref":"#/components/schemas/onboard.BizAIOmniChannelSettingsHandoff"},"rollout":{"$ref":"#/components/schemas/onboard.BizAIOmniChannelSettingsRollout"}},"type":"object"},"onboard.BizAIOmniChannelSettingsFollowup":{"description":"Settings for following up with an inactive user. Null if not configured","properties":{"enabled":{"type":"boolean"},"followup_interval_in_seconds":{"enum":[0,300,900,1800,3600,7200,28800,86400],"type":"integer"},"message":{"type":"string"}},"required":["enabled"],"type":"object"},"onboard.BizAIOmniChannelSettingsHandoff":{"description":"Settings for handing over the conversation to a human agent. Null if not configured","properties":{"enabled":{"type":"boolean"},"message":{"type":"string"}},"required":["enabled"],"type":"object"},"onboard.BizAIOmniChannelSettingsRollout":{"description":"Rollout configuration for the AI agent, containing the enabled flag and future gradual rollout fields","properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"type":"object"}}}}
```

## The onboard.BizAIOmniChannelSettingsResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"onboard.BizAIOmniChannelSettingsResponse":{"description":"The AI agent settings for an entity","properties":{"agent_id":{"type":"string"},"ai_audience":{"enum":["ALLOWLISTED_ONLY","EVERYONE"],"type":"string"},"channel":{"enum":["email","instagram","line","messenger","sms","tiktok","unknown","webchat","whatsapp"],"type":"string"},"followup":{"$ref":"#/components/schemas/onboard.BizAIOmniChannelSettingsFollowup"},"handoff":{"$ref":"#/components/schemas/onboard.BizAIOmniChannelSettingsHandoff"},"rollout":{"$ref":"#/components/schemas/onboard.BizAIOmniChannelSettingsRollout"}},"required":["agent_id","channel","rollout"],"type":"object"},"onboard.BizAIOmniChannelSettingsFollowup":{"description":"Settings for following up with an inactive user. Null if not configured","properties":{"enabled":{"type":"boolean"},"followup_interval_in_seconds":{"enum":[0,300,900,1800,3600,7200,28800,86400],"type":"integer"},"message":{"type":"string"}},"required":["enabled"],"type":"object"},"onboard.BizAIOmniChannelSettingsHandoff":{"description":"Settings for handing over the conversation to a human agent. Null if not configured","properties":{"enabled":{"type":"boolean"},"message":{"type":"string"}},"required":["enabled"],"type":"object"},"onboard.BizAIOmniChannelSettingsRollout":{"description":"Rollout configuration for the AI agent, containing the enabled flag and future gradual rollout fields","properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"type":"object"}}}}
```

## The onboard.BizAIOmniChannelSettingsRollout object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"onboard.BizAIOmniChannelSettingsRollout":{"description":"Rollout configuration for the AI agent, containing the enabled flag and future gradual rollout fields","properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"type":"object"}}}}
```

## The onboard.StandardError object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"onboard.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"type":"string"},"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"}}}}
```

## The operate.BizAIComboJobError object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.BizAIComboJobError":{"description":"Error details when status is FAILED","properties":{"code":{"type":"string"},"failed_case_ids":{"items":{"type":"string"},"type":"array","uniqueItems":false},"message":{"type":"string"}},"required":["code","message"],"type":"object"}}}}
```

## The operate.BizAIComboJobProgress object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.BizAIComboJobProgress":{"description":"Progress information while the job is running","properties":{"completed":{"type":"integer"},"current_stage":{"enum":["simulation","evaluation","insights","done"],"type":"string"},"total":{"type":"integer"}},"required":["completed","current_stage","total"],"type":"object"}}}}
```

## The operate.BizAIComboJobResult object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.BizAIComboJobResult":{"description":"Full result payload when status is COMPLETED","properties":{"avg_conversation_score":{"type":"number"},"avg_turn_score":{"type":"number"},"creation_time":{"type":"integer"},"eval_ids_by_score":{"type":"string"},"highlights":{"type":"string"},"summary":{"type":"string"},"summary_id":{"type":"string"},"top_failure_categories":{"type":"string"},"update_time":{"type":"integer"}},"required":["creation_time","summary","summary_id","update_time"],"type":"object"}}}}
```

## The operate.BizAIComboJobStatusResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.BizAIComboJobStatusResponse":{"description":"Current job status and results (if completed)","properties":{"error":{"$ref":"#/components/schemas/operate.BizAIComboJobError"},"progress":{"$ref":"#/components/schemas/operate.BizAIComboJobProgress"},"result":{"$ref":"#/components/schemas/operate.BizAIComboJobResult"},"status":{"enum":["QUEUED","RUNNING","COMPLETED","FAILED"],"type":"string"}},"required":["status"],"type":"object"},"operate.BizAIComboJobError":{"description":"Error details when status is FAILED","properties":{"code":{"type":"string"},"failed_case_ids":{"items":{"type":"string"},"type":"array","uniqueItems":false},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"operate.BizAIComboJobProgress":{"description":"Progress information while the job is running","properties":{"completed":{"type":"integer"},"current_stage":{"enum":["simulation","evaluation","insights","done"],"type":"string"},"total":{"type":"integer"}},"required":["completed","current_stage","total"],"type":"object"},"operate.BizAIComboJobResult":{"description":"Full result payload when status is COMPLETED","properties":{"avg_conversation_score":{"type":"number"},"avg_turn_score":{"type":"number"},"creation_time":{"type":"integer"},"eval_ids_by_score":{"type":"string"},"highlights":{"type":"string"},"summary":{"type":"string"},"summary_id":{"type":"string"},"top_failure_categories":{"type":"string"},"update_time":{"type":"integer"}},"required":["creation_time","summary","summary_id","update_time"],"type":"object"}}}}
```

## The operate.BizAIComboRunRequest object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.BizAIComboRunRequest":{"description":"Combo evaluation job request body","type":"object"}}}}
```

## The operate.BizAIComboRunResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.BizAIComboRunResponse":{"description":"Acknowledgment that the job was accepted for processing","properties":{"job_id":{"type":"string"},"status":{"type":"string"}},"required":["job_id","status"],"type":"object"}}}}
```

## The operate.BizAIEvalCaseResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.BizAIEvalCaseResponse":{"description":"A single evaluation scenario configuration","properties":{"categories":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"max_turns":{"type":"integer"},"scenario":{"type":"string"},"success_criteria":{"items":{"type":"string"},"type":"array","uniqueItems":false}},"required":["id","scenario"],"type":"object"}}}}
```

## The operate.BizAIEvalDetailResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.BizAIEvalDetailResponse":{"description":"A per-conversation evaluation result","properties":{"creation_time":{"type":"integer"},"custom_success_criteria":{"type":"string"},"eval_case_id":{"type":"string"},"id":{"type":"string"},"per_turn_labels":{"type":"string"},"reasons":{"type":"string"},"score":{"type":"integer"},"transcript":{"type":"string"},"update_time":{"type":"integer"}},"required":["creation_time","id","per_turn_labels","reasons","update_time"],"type":"object"}}}}
```

## The operate.BizAIEvalSummaryResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.BizAIEvalSummaryResponse":{"description":"An aggregated insight report","properties":{"avg_conversation_score":{"type":"number"},"avg_turn_score":{"type":"number"},"creation_time":{"type":"integer"},"eval_ids_by_score":{"type":"string"},"highlights":{"type":"string"},"id":{"type":"string"},"summary":{"type":"string"},"top_failure_categories":{"type":"string"},"update_time":{"type":"integer"}},"required":["creation_time","id","summary","update_time"],"type":"object"}}}}
```

## The operate.BizAIOmniChannelAgentEvent object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.BizAIOmniChannelAgentEvent":{"description":"Event-specific fields","properties":{"description":{"type":"string"},"payload":{"type":"string"},"type":{"type":"string"}},"required":["description","payload","type"],"type":"object"}}}}
```

## The operate.BizAIOmniChannelAgentEventRequest object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.BizAIOmniChannelAgentEventRequest":{"description":"Trigger an agent action asynchronously","properties":{"event":{"$ref":"#/components/schemas/operate.BizAIOmniChannelAgentEvent"},"to":{"type":"string"}},"required":["event","to"],"type":"object"},"operate.BizAIOmniChannelAgentEvent":{"description":"Event-specific fields","properties":{"description":{"type":"string"},"payload":{"type":"string"},"type":{"type":"string"}},"required":["description","payload","type"],"type":"object"}}}}
```

## The operate.BizAIOmniChannelAgentEventResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.BizAIOmniChannelAgentEventResponse":{"description":"Acknowledgment that the event was accepted for processing","properties":{"agent_event_id":{"type":"string"},"status":{"type":"string"}},"required":["status"],"type":"object"}}}}
```

## The operate.BizAIOmniChannelAgentEventStatusResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.BizAIOmniChannelAgentEventStatusResponse":{"description":"The current processing status of an agent event","properties":{"created_at":{"type":"string"},"error_message":{"type":"string"},"event_type":{"type":"string"},"skipped_reason":{"type":"string"},"status":{"enum":["request_received","processing","sent","failed","skipped","success"],"type":"string"},"updated_at":{"type":"string"}},"required":["created_at","event_type","status","updated_at"],"type":"object"}}}}
```

## The operate.BizAIOmniChannelAgentTestRequest object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.BizAIOmniChannelAgentTestRequest":{"description":"Send a test message to the AI agent","properties":{"conversation_id":{"type":"string"},"user_msg":{"type":"string"}},"required":["user_msg"],"type":"object"}}}}
```

## The operate.BizAIOmniChannelAgentTestResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.BizAIOmniChannelAgentTestResponse":{"description":"The AI agent response and test conversation metadata","properties":{"agent_response":{"type":"string"},"conversation_id":{"type":"string"},"handoff_reason":{"type":"string"},"message_id":{"type":"string"},"no_response_reason":{"type":"string"},"product_variant_ids":{"items":{"type":"string"},"type":"array","uniqueItems":false},"quick_replies":{"items":{"type":"string"},"type":"array","uniqueItems":false},"timestamp":{"type":"integer"}},"required":["agent_response","conversation_id","message_id"],"type":"object"}}}}
```

## The operate.EvalCasesResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.EvalCasesResponse":{"description":"List of eval cases for the entity","properties":{"eval_cases":{"items":{"$ref":"#/components/schemas/operate.BizAIEvalCaseResponse"},"type":"array","uniqueItems":false}},"required":["eval_cases"],"type":"object"},"operate.BizAIEvalCaseResponse":{"description":"A single evaluation scenario configuration","properties":{"categories":{"items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"type":"string"},"max_turns":{"type":"integer"},"scenario":{"type":"string"},"success_criteria":{"items":{"type":"string"},"type":"array","uniqueItems":false}},"required":["id","scenario"],"type":"object"}}}}
```

## The operate.EvalDetailsResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.EvalDetailsResponse":{"description":"List of evaluation results","properties":{"evaluations":{"items":{"$ref":"#/components/schemas/operate.BizAIEvalDetailResponse"},"type":"array","uniqueItems":false}},"required":["evaluations"],"type":"object"},"operate.BizAIEvalDetailResponse":{"description":"A per-conversation evaluation result","properties":{"creation_time":{"type":"integer"},"custom_success_criteria":{"type":"string"},"eval_case_id":{"type":"string"},"id":{"type":"string"},"per_turn_labels":{"type":"string"},"reasons":{"type":"string"},"score":{"type":"integer"},"transcript":{"type":"string"},"update_time":{"type":"integer"}},"required":["creation_time","id","per_turn_labels","reasons","update_time"],"type":"object"}}}}
```

## The operate.EvalSummariesResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.EvalSummariesResponse":{"description":"List of insight reports","properties":{"insights":{"items":{"$ref":"#/components/schemas/operate.BizAIEvalSummaryResponse"},"type":"array","uniqueItems":false}},"required":["insights"],"type":"object"},"operate.BizAIEvalSummaryResponse":{"description":"An aggregated insight report","properties":{"avg_conversation_score":{"type":"number"},"avg_turn_score":{"type":"number"},"creation_time":{"type":"integer"},"eval_ids_by_score":{"type":"string"},"highlights":{"type":"string"},"id":{"type":"string"},"summary":{"type":"string"},"top_failure_categories":{"type":"string"},"update_time":{"type":"integer"}},"required":["creation_time","id","summary","update_time"],"type":"object"}}}}
```

## The operate.StandardError object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"type":"string"},"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"}}}}
```

## The operate.ThreadControlRequest object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.ThreadControlRequest":{"description":"Thread control action to perform","properties":{"action":{"enum":["pass","release"],"type":"string"},"messaging_product":{"enum":["whatsapp"],"type":"string"},"recipient":{"type":"string"},"to":{"type":"string"}},"required":["action","messaging_product"],"type":"object"}}}}
```

## The operate.ThreadControlResponse object

```json
{"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.49.1"},"components":{"schemas":{"operate.ThreadControlResponse":{"description":"Thread control action result with messaging product identifier","properties":{"messaging_product":{"enum":["whatsapp"],"type":"string"}},"required":["messaging_product"],"type":"object"}}}}
```


---

# 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.360dialog.com/docs/mba/api-ref/models.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.