> 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 budget.AgentBudgetRequest object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"budget.AgentBudgetRequest":{"description":"Replace the full set of budgets for the agent","properties":{"budgets":{"description":"The complete set of budgets for the agent. This replaces any budgets already configured, so any left out are removed, and an empty array clears them all and returns the agent to unlimited usage. A given unit type and time window pair may only appear once","items":{"$ref":"#/components/schemas/budget.AgentBudgetRequestItem"},"type":"array","uniqueItems":false}},"required":["budgets"],"type":"object"},"budget.AgentBudgetRequestItem":{"description":"A single budget to configure for the agent","properties":{"budget_id":{"description":"Stable identifier of the budget. For an existing budget, pass the id the server returned when it was created to edit or preserve it. For a new budget, leave it empty; the server assigns one","type":"string"},"max_budget":{"description":"The maximum allowed usage, in the given unit, within the time window. Must be a positive whole number","minimum":1,"type":"integer"},"time_window":{"description":"The rolling period usage is totalled over, measured in the timezone of the WhatsApp Business Account","enum":["one_day","seven_days","fourteen_days","thirty_days"],"type":"string"},"unit_type":{"description":"What the budget measures: token usage or AI agent turns","enum":["token","ai_turn"],"type":"string"}},"required":["max_budget","time_window","unit_type"],"type":"object"}}}} ``` ## The budget.AgentBudgetRequestItem object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"budget.AgentBudgetRequestItem":{"description":"A single budget to configure for the agent","properties":{"budget_id":{"description":"Stable identifier of the budget. For an existing budget, pass the id the server returned when it was created to edit or preserve it. For a new budget, leave it empty; the server assigns one","type":"string"},"max_budget":{"description":"The maximum allowed usage, in the given unit, within the time window. Must be a positive whole number","minimum":1,"type":"integer"},"time_window":{"description":"The rolling period usage is totalled over, measured in the timezone of the WhatsApp Business Account","enum":["one_day","seven_days","fourteen_days","thirty_days"],"type":"string"},"unit_type":{"description":"What the budget measures: token usage or AI agent turns","enum":["token","ai_turn"],"type":"string"}},"required":["max_budget","time_window","unit_type"],"type":"object"}}}} ``` ## The budget.AgentBudgetResponse object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"budget.AgentBudgetResponse":{"description":"The budgets configured for the agent","properties":{"budgets":{"description":"The budgets configured for the agent. When more than one is set, whichever is reached first takes effect. An empty array means no cap is set and usage is unlimited","items":{"$ref":"#/components/schemas/budget.AgentBudgetResponseItem"},"type":"array","uniqueItems":false}},"required":["budgets"],"type":"object"},"budget.AgentBudgetResponseItem":{"description":"A single budget configured for the agent","properties":{"budget_id":{"description":"Stable identifier for this budget. Pass it back on a subsequent set request to edit or preserve this budget","type":"string"},"max_budget":{"description":"The maximum allowed usage, in the given unit, within the time window","type":"integer"},"time_window":{"description":"The rolling period usage is totalled over, measured in the timezone of the WhatsApp Business Account","enum":["one_day","seven_days","fourteen_days","thirty_days"],"type":"string"},"unit_type":{"description":"What the budget measures: token usage or AI agent turns","enum":["token","ai_turn"],"type":"string"}},"required":["budget_id","max_budget","time_window","unit_type"],"type":"object"}}}} ``` ## The budget.AgentBudgetResponseItem object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"budget.AgentBudgetResponseItem":{"description":"A single budget configured for the agent","properties":{"budget_id":{"description":"Stable identifier for this budget. Pass it back on a subsequent set request to edit or preserve this budget","type":"string"},"max_budget":{"description":"The maximum allowed usage, in the given unit, within the time window","type":"integer"},"time_window":{"description":"The rolling period usage is totalled over, measured in the timezone of the WhatsApp Business Account","enum":["one_day","seven_days","fourteen_days","thirty_days"],"type":"string"},"unit_type":{"description":"What the budget measures: token usage or AI agent turns","enum":["token","ai_turn"],"type":"string"}},"required":["budget_id","max_budget","time_window","unit_type"],"type":"object"}}}} ``` ## The budget.StandardError object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"budget.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"description":"Human-readable explanation of the error","type":"string"},"status":{"description":"HTTP status code","type":"integer"},"title":{"description":"Short, human-readable summary of the problem","type":"string"},"type":{"description":"A URI reference identifying the problem type","type":"string"}},"type":"object"}}}} ``` ## The knowledge\_bi.BizAIOmniChannelKnowledgeBusinessInfoRequest object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"knowledge_bi.BizAIOmniChannelKnowledgeBusinessInfoRequest":{"description":"Create or fully replace the business information for an entity","properties":{"business_description":{"description":"General information about the business","type":"string"},"contact_info":{"$ref":"#/components/schemas/knowledge_bi.BizAIOmniChannelKnowledgeContactInfo"},"delivery_and_shipping":{"description":"Details about delivery and shipping","type":"string"},"payment_method":{"description":"Accepted payment methods","type":"string"},"purchase_info":{"description":"Information about how to make a purchase","type":"string"},"return_policy":{"description":"The company return policy","type":"string"}},"type":"object"},"knowledge_bi.BizAIOmniChannelKnowledgeContactInfo":{"description":"Contact and location details for the business. Null if not configured","properties":{"address":{"description":"Physical address of the business","type":"string"},"email":{"description":"Business email address","type":"string"},"hours_of_operation":{"description":"Business hours of operation","type":"string"}},"type":"object"}}}} ``` ## The knowledge\_bi.BizAIOmniChannelKnowledgeBusinessInfoResponse object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"knowledge_bi.BizAIOmniChannelKnowledgeBusinessInfoResponse":{"description":"The business information configured for an entity","properties":{"business_description":{"description":"General information about the business","type":"string"},"contact_info":{"$ref":"#/components/schemas/knowledge_bi.BizAIOmniChannelKnowledgeContactInfo"},"delivery_and_shipping":{"description":"Details about delivery and shipping","type":"string"},"payment_method":{"description":"Accepted payment methods","type":"string"},"purchase_info":{"description":"Information about how to make a purchase","type":"string"},"return_policy":{"description":"The company return policy","type":"string"}},"type":"object"},"knowledge_bi.BizAIOmniChannelKnowledgeContactInfo":{"description":"Contact and location details for the business. Null if not configured","properties":{"address":{"description":"Physical address of the business","type":"string"},"email":{"description":"Business email address","type":"string"},"hours_of_operation":{"description":"Business hours of operation","type":"string"}},"type":"object"}}}} ``` ## The knowledge\_bi.BizAIOmniChannelKnowledgeContactInfo object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"knowledge_bi.BizAIOmniChannelKnowledgeContactInfo":{"description":"Contact and location details for the business. Null if not configured","properties":{"address":{"description":"Physical address of the business","type":"string"},"email":{"description":"Business email address","type":"string"},"hours_of_operation":{"description":"Business hours of operation","type":"string"}},"type":"object"}}}} ``` ## The knowledge\_bi.StandardError object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"knowledge_bi.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"description":"Human-readable explanation of the error","type":"string"},"status":{"description":"HTTP status code","type":"integer"},"title":{"description":"Short, human-readable summary of the problem","type":"string"},"type":{"description":"A URI reference identifying the problem type","type":"string"}},"type":"object"}}}} ``` ## The knowledge\_connector\_tools.BizAIOmniChannelConnectorToolBodyNode object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"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":{"description":"Human-readable documentation for the field or container","type":"string"},"items":{"description":"BodyNode element schema for array nodes, as a string representation of the BodyNode type. Only for \"array\" nodes.","type":"string"},"properties":{"additionalProperties":{"type":"string"},"description":"Child fields for object nodes; keys are canonical field names, value is a string representation of the BodyNode type. Only for \"object\" nodes.","type":"object"},"required":{"description":"Required properties of this object. Only for \"object\" type nodes.","items":{"type":"string"},"type":"array","uniqueItems":false},"type":{"description":"Node type. Use \"object\" with explicit properties for structured data rather than \"string\".","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":{"description":"Source mode for a Meta Business Agent-owned field","enum":["default","macro"],"type":"string"},"macro":{"description":"Registered Meta Business Agent macro ID, required when kind = \"macro\"","enum":["WHATSAPP_PHONE_NUMBER","WHATSAPP_IDENTITY_HASH","WHATSAPP_CURRENT_STATUS_ID"],"type":"string"},"value":{"description":"Typed literal value, required when kind = \"default\". Provided as a string; the underlying value must match the node type.","type":"string"}},"required":["kind"],"type":"object"}}}} ``` ## The knowledge\_connector\_tools.BizAIOmniChannelConnectorToolParameterBinding object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"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":{"description":"Source mode for a Meta Business Agent-owned field","enum":["default","macro"],"type":"string"},"macro":{"description":"Registered Meta Business Agent macro ID, required when kind = \"macro\"","enum":["WHATSAPP_PHONE_NUMBER","WHATSAPP_IDENTITY_HASH","WHATSAPP_CURRENT_STATUS_ID"],"type":"string"},"value":{"description":"Typed literal value, required when kind = \"default\". Provided as a string; the underlying value must match the node type.","type":"string"}},"required":["kind"],"type":"object"}}}} ``` ## The knowledge\_connector\_tools.BizAIOmniChannelConnectorToolParameterNode object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"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":{"description":"Human-readable documentation for the parameter. The agent uses it to understand what value to pass.","type":"string"},"required":{"description":"Whether the field is required. Ignored for path params, which are always required.","type":"boolean"},"type":{"description":"Node 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":{"description":"Source mode for a Meta Business Agent-owned field","enum":["default","macro"],"type":"string"},"macro":{"description":"Registered Meta Business Agent macro ID, required when kind = \"macro\"","enum":["WHATSAPP_PHONE_NUMBER","WHATSAPP_IDENTITY_HASH","WHATSAPP_CURRENT_STATUS_ID"],"type":"string"},"value":{"description":"Typed literal value, required when kind = \"default\". Provided as a string; the underlying value must match the node type.","type":"string"}},"required":["kind"],"type":"object"}}}} ``` ## The knowledge\_connector\_tools.BizAIOmniChannelConnectorToolRequest object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"knowledge_connector_tools.BizAIOmniChannelConnectorToolRequest":{"description":"Create or update a connector tool","properties":{"description":{"description":"Human-readable description of what this tool does and when to use it. The agent relies on this to decide when to invoke the tool.","type":"string"},"name":{"description":"Stable tool/action key, visible to the agent. Use a clear, descriptive name (e.g. check_order_status).","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":{"description":"If true, Meta Business Agent injects stored user auth into the outbound request at runtime","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"},"description":"Header schema; property names are the canonical outbound header names","type":"object"},"method":{"description":"HTTP method for the outbound request","enum":["GET","POST","PUT","DELETE","PATCH"],"type":"string"},"path":{"description":"Outbound request path template, including {placeholder} segments for path parameters","type":"string"},"path_parameters":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterNode"},"description":"Path-parameter schema; property names must match the placeholder names used in path","type":"object"},"query_parameters":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterNode"},"description":"Query-parameter schema; property names are the canonical outbound query parameter names","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":{"description":"Request body content type; currently only supports application/json","enum":["application/json"],"type":"string"},"params":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolBodyNode"},"description":"Top-level JSON body fields; keys are canonical outbound field names","type":"object"},"required":{"description":"Required top-level body fields. Entries must be keys present in params.","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":{"description":"Human-readable documentation for the field or container","type":"string"},"items":{"description":"BodyNode element schema for array nodes, as a string representation of the BodyNode type. Only for \"array\" nodes.","type":"string"},"properties":{"additionalProperties":{"type":"string"},"description":"Child fields for object nodes; keys are canonical field names, value is a string representation of the BodyNode type. Only for \"object\" nodes.","type":"object"},"required":{"description":"Required properties of this object. Only for \"object\" type nodes.","items":{"type":"string"},"type":"array","uniqueItems":false},"type":{"description":"Node type. Use \"object\" with explicit properties for structured data rather than \"string\".","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":{"description":"Source mode for a Meta Business Agent-owned field","enum":["default","macro"],"type":"string"},"macro":{"description":"Registered Meta Business Agent macro ID, required when kind = \"macro\"","enum":["WHATSAPP_PHONE_NUMBER","WHATSAPP_IDENTITY_HASH","WHATSAPP_CURRENT_STATUS_ID"],"type":"string"},"value":{"description":"Typed literal value, required when kind = \"default\". Provided as a string; the underlying value must match the node type.","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":{"description":"Human-readable documentation for the parameter. The agent uses it to understand what value to pass.","type":"string"},"required":{"description":"Whether the field is required. Ignored for path params, which are always required.","type":"boolean"},"type":{"description":"Node 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":{"description":"Dot-path used to extract token expiry from a login/refresh tool response","type":"string"},"expires_at_type":{"description":"How to interpret the value found at expires_at_path","enum":["absolute","relative_seconds"],"type":"string"},"refresh_token_path":{"description":"Dot-path used to extract the refresh token from a login/refresh tool response","type":"string"},"user_action_tool_type":{"description":"Type of user auth action: auth performs initial authorization, refresh uses an existing refresh token","enum":["auth","refresh"],"type":"string"},"user_auth_token_path":{"description":"Dot-path used to extract the access token from a login/refresh tool response","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.50.0"},"components":{"schemas":{"knowledge_connector_tools.BizAIOmniChannelConnectorToolRequestBodyDefinition":{"description":"Request body definition; omit or set to null when the request has no body","properties":{"content_type":{"description":"Request body content type; currently only supports application/json","enum":["application/json"],"type":"string"},"params":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolBodyNode"},"description":"Top-level JSON body fields; keys are canonical outbound field names","type":"object"},"required":{"description":"Required top-level body fields. Entries must be keys present in params.","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":{"description":"Human-readable documentation for the field or container","type":"string"},"items":{"description":"BodyNode element schema for array nodes, as a string representation of the BodyNode type. Only for \"array\" nodes.","type":"string"},"properties":{"additionalProperties":{"type":"string"},"description":"Child fields for object nodes; keys are canonical field names, value is a string representation of the BodyNode type. Only for \"object\" nodes.","type":"object"},"required":{"description":"Required properties of this object. Only for \"object\" type nodes.","items":{"type":"string"},"type":"array","uniqueItems":false},"type":{"description":"Node type. Use \"object\" with explicit properties for structured data rather than \"string\".","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":{"description":"Source mode for a Meta Business Agent-owned field","enum":["default","macro"],"type":"string"},"macro":{"description":"Registered Meta Business Agent macro ID, required when kind = \"macro\"","enum":["WHATSAPP_PHONE_NUMBER","WHATSAPP_IDENTITY_HASH","WHATSAPP_CURRENT_STATUS_ID"],"type":"string"},"value":{"description":"Typed literal value, required when kind = \"default\". Provided as a string; the underlying value must match the node type.","type":"string"}},"required":["kind"],"type":"object"}}}} ``` ## The knowledge\_connector\_tools.BizAIOmniChannelConnectorToolRequestDefinition object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"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"},"description":"Header schema; property names are the canonical outbound header names","type":"object"},"method":{"description":"HTTP method for the outbound request","enum":["GET","POST","PUT","DELETE","PATCH"],"type":"string"},"path":{"description":"Outbound request path template, including {placeholder} segments for path parameters","type":"string"},"path_parameters":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterNode"},"description":"Path-parameter schema; property names must match the placeholder names used in path","type":"object"},"query_parameters":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterNode"},"description":"Query-parameter schema; property names are the canonical outbound query parameter names","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":{"description":"Request body content type; currently only supports application/json","enum":["application/json"],"type":"string"},"params":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolBodyNode"},"description":"Top-level JSON body fields; keys are canonical outbound field names","type":"object"},"required":{"description":"Required top-level body fields. Entries must be keys present in params.","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":{"description":"Human-readable documentation for the field or container","type":"string"},"items":{"description":"BodyNode element schema for array nodes, as a string representation of the BodyNode type. Only for \"array\" nodes.","type":"string"},"properties":{"additionalProperties":{"type":"string"},"description":"Child fields for object nodes; keys are canonical field names, value is a string representation of the BodyNode type. Only for \"object\" nodes.","type":"object"},"required":{"description":"Required properties of this object. Only for \"object\" type nodes.","items":{"type":"string"},"type":"array","uniqueItems":false},"type":{"description":"Node type. Use \"object\" with explicit properties for structured data rather than \"string\".","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":{"description":"Source mode for a Meta Business Agent-owned field","enum":["default","macro"],"type":"string"},"macro":{"description":"Registered Meta Business Agent macro ID, required when kind = \"macro\"","enum":["WHATSAPP_PHONE_NUMBER","WHATSAPP_IDENTITY_HASH","WHATSAPP_CURRENT_STATUS_ID"],"type":"string"},"value":{"description":"Typed literal value, required when kind = \"default\". Provided as a string; the underlying value must match the node type.","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":{"description":"Human-readable documentation for the parameter. The agent uses it to understand what value to pass.","type":"string"},"required":{"description":"Whether the field is required. Ignored for path params, which are always required.","type":"boolean"},"type":{"description":"Node 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.50.0"},"components":{"schemas":{"knowledge_connector_tools.BizAIOmniChannelConnectorToolResponse":{"description":"A single connector tool","properties":{"description":{"description":"Human-readable tool description","type":"string"},"id":{"description":"Tool ID returned by the Stefi API","type":"string"},"name":{"description":"Stable tool/action key, visible to the agent","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":{"description":"Whether Meta Business Agent injects stored user auth into the outbound request at runtime","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"},"description":"Header schema; property names are the canonical outbound header names","type":"object"},"method":{"description":"HTTP method for the outbound request","enum":["GET","POST","PUT","DELETE","PATCH"],"type":"string"},"path":{"description":"Outbound request path template, including {placeholder} segments for path parameters","type":"string"},"path_parameters":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterNode"},"description":"Path-parameter schema; property names must match the placeholder names used in path","type":"object"},"query_parameters":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolParameterNode"},"description":"Query-parameter schema; property names are the canonical outbound query parameter names","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":{"description":"Request body content type; currently only supports application/json","enum":["application/json"],"type":"string"},"params":{"additionalProperties":{"$ref":"#/components/schemas/knowledge_connector_tools.BizAIOmniChannelConnectorToolBodyNode"},"description":"Top-level JSON body fields; keys are canonical outbound field names","type":"object"},"required":{"description":"Required top-level body fields. Entries must be keys present in params.","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":{"description":"Human-readable documentation for the field or container","type":"string"},"items":{"description":"BodyNode element schema for array nodes, as a string representation of the BodyNode type. Only for \"array\" nodes.","type":"string"},"properties":{"additionalProperties":{"type":"string"},"description":"Child fields for object nodes; keys are canonical field names, value is a string representation of the BodyNode type. Only for \"object\" nodes.","type":"object"},"required":{"description":"Required properties of this object. Only for \"object\" type nodes.","items":{"type":"string"},"type":"array","uniqueItems":false},"type":{"description":"Node type. Use \"object\" with explicit properties for structured data rather than \"string\".","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":{"description":"Source mode for a Meta Business Agent-owned field","enum":["default","macro"],"type":"string"},"macro":{"description":"Registered Meta Business Agent macro ID, required when kind = \"macro\"","enum":["WHATSAPP_PHONE_NUMBER","WHATSAPP_IDENTITY_HASH","WHATSAPP_CURRENT_STATUS_ID"],"type":"string"},"value":{"description":"Typed literal value, required when kind = \"default\". Provided as a string; the underlying value must match the node type.","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":{"description":"Human-readable documentation for the parameter. The agent uses it to understand what value to pass.","type":"string"},"required":{"description":"Whether the field is required. Ignored for path params, which are always required.","type":"boolean"},"type":{"description":"Node 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":{"description":"Dot-path used to extract token expiry from a login/refresh tool response","type":"string"},"expires_at_type":{"description":"How to interpret the value found at expires_at_path","enum":["absolute","relative_seconds"],"type":"string"},"refresh_token_path":{"description":"Dot-path used to extract the refresh token from a login/refresh tool response","type":"string"},"user_action_tool_type":{"description":"Type of user auth action: auth performs initial authorization, refresh uses an existing refresh token","enum":["auth","refresh"],"type":"string"},"user_auth_token_path":{"description":"Dot-path used to extract the access token from a login/refresh tool response","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.50.0"},"components":{"schemas":{"knowledge_connector_tools.BizAIOmniChannelConnectorToolRunRequest":{"description":"Execute a tool action","properties":{"input":{"description":"JSON-encoded input payload for the tool action. Defaults to empty object if not provided.","type":"string"}},"type":"object"}}}} ``` ## The knowledge\_connector\_tools.BizAIOmniChannelConnectorToolRunResponse object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"knowledge_connector_tools.BizAIOmniChannelConnectorToolRunResponse":{"description":"The result of executing a tool action","properties":{"output":{"description":"JSON-encoded response from the tool execution","type":"string"},"status":{"description":"Execution status: success or error","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.50.0"},"components":{"schemas":{"knowledge_connector_tools.BizAIOmniChannelConnectorToolUserAuthActionConfig":{"description":"Response extraction config for login/refresh user-auth actions","properties":{"expires_at_path":{"description":"Dot-path used to extract token expiry from a login/refresh tool response","type":"string"},"expires_at_type":{"description":"How to interpret the value found at expires_at_path","enum":["absolute","relative_seconds"],"type":"string"},"refresh_token_path":{"description":"Dot-path used to extract the refresh token from a login/refresh tool response","type":"string"},"user_action_tool_type":{"description":"Type of user auth action: auth performs initial authorization, refresh uses an existing refresh token","enum":["auth","refresh"],"type":"string"},"user_auth_token_path":{"description":"Dot-path used to extract the access token from a login/refresh tool response","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.50.0"},"components":{"schemas":{"knowledge_connector_tools.BizAIOmniChannelConnectorToolUserAuthToolConfig":{"description":"Response extraction config for login/refresh user-auth actions","properties":{"expires_at_path":{"description":"Dot-path used to extract token expiry from a login/refresh tool response","type":"string"},"expires_at_type":{"description":"How to interpret the value found at expires_at_path","enum":["absolute","relative_seconds"],"type":"string"},"refresh_token_path":{"description":"Dot-path used to extract the refresh token from a login/refresh tool response","type":"string"},"user_action_tool_type":{"description":"Type of user auth action: auth performs initial authorization, refresh uses an existing refresh token","enum":["auth","refresh"],"type":"string"},"user_auth_token_path":{"description":"Dot-path used to extract the access token from a login/refresh tool response","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.50.0"},"components":{"schemas":{"knowledge_connector_tools.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"description":"Human-readable explanation of the error","type":"string"},"status":{"description":"HTTP status code","type":"integer"},"title":{"description":"Short, human-readable summary of the problem","type":"string"},"type":{"description":"A URI reference identifying the problem type","type":"string"}},"type":"object"}}}} ``` ## The knowledge\_connectors.BizAIOmniChannelConnectorApiKeyAuthConfig object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorApiKeyAuthConfig":{"description":"API key configuration. Provide only when auth_type is API_KEY.","properties":{"body_params":{"description":"API key fields to add as JSON body parameters","items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"headers":{"description":"API key fields to add as HTTP headers","items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"query_params":{"description":"API key fields to add as query parameters","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":{"description":"Header, query parameter, or body field name","type":"string"},"prefix":{"description":"Optional value prefix, such as Bearer followed by a space","type":"string"},"value":{"description":"Secret value for this API key field","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.50.0"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam":{"description":"A single API key field","properties":{"field_name":{"description":"Header, query parameter, or body field name","type":"string"},"prefix":{"description":"Optional value prefix, such as Bearer followed by a space","type":"string"},"value":{"description":"Secret value for this API key field","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.50.0"},"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":{"description":"API key fields to add as JSON body parameters","items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"headers":{"description":"API key fields to add as HTTP headers","items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"query_params":{"description":"API key fields to add as query parameters","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":{"description":"Header, query parameter, or body field name","type":"string"},"prefix":{"description":"Optional value prefix, such as Bearer followed by a space","type":"string"},"value":{"description":"Secret value for this API key field","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":{"description":"OAuth client ID","type":"string"},"client_secret":{"description":"OAuth client secret","type":"string"},"scopes_to_request":{"description":"OAuth scopes to request","items":{"type":"string"},"type":"array","uniqueItems":false},"token_request_content_type":{"description":"Content type for token requests. Supports application/x-www-form-urlencoded and application/json. Defaults to application/x-www-form-urlencoded.","type":"string"},"token_url":{"description":"Token URL used to request OAuth access tokens","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.50.0"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorCertificateRequest":{"description":"Upload or rotate the mTLS client certificate for a connector","properties":{"ca_certificate":{"description":"Optional PEM-encoded CA certificate for the client-side mTLS trust chain.","type":"string"},"client_certificate":{"description":"PEM-encoded client certificate for mTLS. Must begin with -----BEGIN CERTIFICATE-----.","type":"string"},"client_key":{"description":"PEM-encoded private key for mTLS (PKCS8, RSA, or EC).","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.50.0"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorConnectionStatus":{"description":"Connection status information","properties":{"error_message":{"description":"Error message if connection failed","type":"string"},"status":{"description":"Current connection 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.50.0"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorLogEntry":{"description":"A log entry (individual mode) or failure pattern (summary_only mode)","properties":{"error_message":{"description":"Error message from the failed operation","type":"string"},"event_time":{"description":"ISO 8601 UTC timestamp of when the error event occurred (individual log entry mode)","type":"string"},"failure_code_name":{"description":"Human-readable name of the failure code (e.g. TRANSPORT_ERROR)","type":"string"},"last_seen":{"description":"ISO 8601 UTC timestamp of the most recent occurrence (summary_only mode)","type":"string"},"occurrences":{"description":"Number of times this failure pattern occurred (summary_only mode)","type":"integer"},"tool_name":{"description":"The tool that was being used when the error occurred","type":"string"}},"type":"object"}}}} ``` ## The knowledge\_connectors.BizAIOmniChannelConnectorLogStats object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorLogStats":{"description":"Aggregate statistics for the queried time window, present when include_stats is true","properties":{"avg_latency_s":{"description":"Average execution latency in seconds","type":"number"},"exception_count":{"description":"Number of failed tool executions","type":"integer"},"p95_latency_s":{"description":"95th percentile execution latency in seconds","type":"number"},"p99_latency_s":{"description":"99th percentile execution latency in seconds","type":"number"},"start_count":{"description":"Total number of tool execution starts","type":"integer"},"success_count":{"description":"Number of successful tool executions","type":"integer"},"success_rate":{"description":"Ratio of successful executions to total starts","type":"number"},"time_window_seconds":{"description":"Number of seconds in the statistics time window. Reflects the actual covered window, which may be smaller than the requested range if the most recent logs have not yet been processed.","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.50.0"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorLogStatsResponse":{"description":"Log entries or failure patterns, with optional statistics","properties":{"data":{"description":"Array of log entries or failure patterns depending on query mode","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":{"description":"Error message from the failed operation","type":"string"},"event_time":{"description":"ISO 8601 UTC timestamp of when the error event occurred (individual log entry mode)","type":"string"},"failure_code_name":{"description":"Human-readable name of the failure code (e.g. TRANSPORT_ERROR)","type":"string"},"last_seen":{"description":"ISO 8601 UTC timestamp of the most recent occurrence (summary_only mode)","type":"string"},"occurrences":{"description":"Number of times this failure pattern occurred (summary_only mode)","type":"integer"},"tool_name":{"description":"The tool that was being used when the error occurred","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":{"description":"Average execution latency in seconds","type":"number"},"exception_count":{"description":"Number of failed tool executions","type":"integer"},"p95_latency_s":{"description":"95th percentile execution latency in seconds","type":"number"},"p99_latency_s":{"description":"99th percentile execution latency in seconds","type":"number"},"start_count":{"description":"Total number of tool execution starts","type":"integer"},"success_count":{"description":"Number of successful tool executions","type":"integer"},"success_rate":{"description":"Ratio of successful executions to total starts","type":"number"},"time_window_seconds":{"description":"Number of seconds in the statistics time window. Reflects the actual covered window, which may be smaller than the requested range if the most recent logs have not yet been processed.","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.BizAIOmniChannelConnectorMcpToolSync object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorMcpToolSync":{"description":"MCP tool discovery cache status. Null for HTTP connectors.","properties":{"fingerprint":{"description":"Fingerprint of the cached remote tool set","type":"string"},"last_attempted_at":{"description":"Unix timestamp of the latest refresh attempt","type":"integer"},"last_successful_at":{"description":"Unix timestamp of the latest successful refresh","type":"integer"},"status":{"description":"Current MCP tool refresh status","enum":["ERROR","PENDING","READY"],"type":"string"},"tool_count":{"description":"Number of cached remote MCP tools","type":"integer"}},"required":["status"],"type":"object"}}}} ``` ## The knowledge\_connectors.BizAIOmniChannelConnectorMtlsConfig object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorMtlsConfig":{"description":"mTLS certificate metadata and PEM content (private key is never exposed)","properties":{"ca_certificate":{"description":"PEM-encoded CA certificate chain (public, safe to expose)","type":"string"},"client_certificate":{"description":"PEM-encoded client certificate (public, safe to expose)","type":"string"},"expires_at":{"description":"Unix timestamp of certificate expiry","type":"integer"},"fingerprint":{"description":"SHA-256 fingerprint of the certificate","type":"string"},"has_certificate":{"description":"Whether an mTLS certificate is configured","type":"boolean"},"subject":{"description":"Certificate subject DN","type":"string"}},"required":["has_certificate"],"type":"object"}}}} ``` ## The knowledge\_connectors.BizAIOmniChannelConnectorOAuth2ClientCredentialsAuthConfig object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorOAuth2ClientCredentialsAuthConfig":{"description":"OAuth 2.0 client credentials configuration. Provide only when auth_type is OAUTH2_CLIENT_CREDENTIALS.","properties":{"client_id":{"description":"OAuth client ID","type":"string"},"client_secret":{"description":"OAuth client secret","type":"string"},"scopes_to_request":{"description":"OAuth scopes to request","items":{"type":"string"},"type":"array","uniqueItems":false},"token_request_content_type":{"description":"Content type for token requests. Supports application/x-www-form-urlencoded and application/json. Defaults to application/x-www-form-urlencoded.","type":"string"},"token_url":{"description":"Token URL used to request OAuth access tokens","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.50.0"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorRequest":{"description":"Create or update a connector","properties":{"auth_config":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorAuthConfig"},"auth_type":{"description":"Authentication type. Currently only OAUTH2_CLIENT_CREDENTIALS, API_KEY, and NONE are supported. Set auth_config.oauth2_client_credentials when this is OAUTH2_CLIENT_CREDENTIALS, set auth_config.api_key when this is API_KEY, and omit auth_config when this is NONE.","enum":["OAUTH2","OAUTH2_CLIENT_CREDENTIALS","API_KEY","BASIC","CUSTOM","NONE"],"type":"string"},"base_url":{"description":"Base URL of the external HTTP API or remote MCP server","type":"string"},"connector_protocol":{"description":"Connector protocol. Defaults to HTTP when omitted and cannot be changed after creation.","enum":["HTTP","MCP"],"type":"string"},"description":{"description":"Description of what this connector integrates with and its purpose. The agent uses this to understand the connector capabilities, e.g. 'Connects to the Shopify API for managing customer orders, processing returns, and checking inventory availability.'","type":"string"},"name":{"description":"Display name of the connector. Use a name that clearly identifies the external service (e.g. Shopify_Order_Management, Salesforce_CRM). Must be unique among the connectors already created for this entity. Connector names must contain only letters, numbers, and underscores (regex: ^[A-Za-z0-9_]+$). They must not start or end with an underscore or contain consecutive underscores. Spaces, hyphens, dots, and accented characters are not allowed.","type":"string"},"requires_certificate":{"description":"Whether this connector requires an mTLS client certificate. When true, use the upsertCertificate endpoint to provide it.","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":{"description":"API key fields to add as JSON body parameters","items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"headers":{"description":"API key fields to add as HTTP headers","items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"query_params":{"description":"API key fields to add as query parameters","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":{"description":"Header, query parameter, or body field name","type":"string"},"prefix":{"description":"Optional value prefix, such as Bearer followed by a space","type":"string"},"value":{"description":"Secret value for this API key field","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":{"description":"OAuth client ID","type":"string"},"client_secret":{"description":"OAuth client secret","type":"string"},"scopes_to_request":{"description":"OAuth scopes to request","items":{"type":"string"},"type":"array","uniqueItems":false},"token_request_content_type":{"description":"Content type for token requests. Supports application/x-www-form-urlencoded and application/json. Defaults to application/x-www-form-urlencoded.","type":"string"},"token_url":{"description":"Token URL used to request OAuth access tokens","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":{"description":"Field name for the injected token (e.g. X-User-Token)","type":"string"},"location":{"description":"Where to inject the token","enum":["body","headers","path","query"],"type":"string"},"prefix":{"description":"Prefix for the token value (e.g. Bearer )","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.50.0"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorResponse":{"description":"A single connector","properties":{"auth_config":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorAuthConfig"},"auth_type":{"description":"Authentication type for this connector","enum":["OAUTH2","OAUTH2_CLIENT_CREDENTIALS","API_KEY","BASIC","CUSTOM","NONE"],"type":"string"},"base_url":{"description":"Base URL of the external API","type":"string"},"connection_status":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorConnectionStatus"},"connector_protocol":{"description":"Protocol used by this connector. Defaults to HTTP when omitted.","enum":["HTTP","MCP"],"type":"string"},"description":{"description":"Description of the connector","type":"string"},"id":{"description":"The unique identifier for this connector","type":"string"},"mcp_tool_sync":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorMcpToolSync"},"mtls_config":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorMtlsConfig"},"name":{"description":"Display name of the connector","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":{"description":"API key fields to add as JSON body parameters","items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"headers":{"description":"API key fields to add as HTTP headers","items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"query_params":{"description":"API key fields to add as query parameters","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":{"description":"Header, query parameter, or body field name","type":"string"},"prefix":{"description":"Optional value prefix, such as Bearer followed by a space","type":"string"},"value":{"description":"Secret value for this API key field","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":{"description":"OAuth client ID","type":"string"},"client_secret":{"description":"OAuth client secret","type":"string"},"scopes_to_request":{"description":"OAuth scopes to request","items":{"type":"string"},"type":"array","uniqueItems":false},"token_request_content_type":{"description":"Content type for token requests. Supports application/x-www-form-urlencoded and application/json. Defaults to application/x-www-form-urlencoded.","type":"string"},"token_url":{"description":"Token URL used to request OAuth access tokens","type":"string"}},"required":["client_id","client_secret","scopes_to_request","token_url"],"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorConnectionStatus":{"description":"Connection status information","properties":{"error_message":{"description":"Error message if connection failed","type":"string"},"status":{"description":"Current connection status","enum":["PENDING_OAUTH","ACTIVE","EXPIRED","ERROR"],"type":"string"}},"required":["status"],"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorMcpToolSync":{"description":"MCP tool discovery cache status. Null for HTTP connectors.","properties":{"fingerprint":{"description":"Fingerprint of the cached remote tool set","type":"string"},"last_attempted_at":{"description":"Unix timestamp of the latest refresh attempt","type":"integer"},"last_successful_at":{"description":"Unix timestamp of the latest successful refresh","type":"integer"},"status":{"description":"Current MCP tool refresh status","enum":["ERROR","PENDING","READY"],"type":"string"},"tool_count":{"description":"Number of cached remote MCP tools","type":"integer"}},"required":["status"],"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorMtlsConfig":{"description":"mTLS certificate metadata and PEM content (private key is never exposed)","properties":{"ca_certificate":{"description":"PEM-encoded CA certificate chain (public, safe to expose)","type":"string"},"client_certificate":{"description":"PEM-encoded client certificate (public, safe to expose)","type":"string"},"expires_at":{"description":"Unix timestamp of certificate expiry","type":"integer"},"fingerprint":{"description":"SHA-256 fingerprint of the certificate","type":"string"},"has_certificate":{"description":"Whether an mTLS certificate is configured","type":"boolean"},"subject":{"description":"Certificate subject DN","type":"string"}},"required":["has_certificate"],"type":"object"},"knowledge_connectors.BizAIOmniChannelConnectorUserAuthInjectionConfig":{"description":"Configuration for injecting user auth tokens into tool requests","properties":{"field_name":{"description":"Field name for the injected token (e.g. X-User-Token)","type":"string"},"location":{"description":"Where to inject the token","enum":["body","headers","path","query"],"type":"string"},"prefix":{"description":"Prefix for the token value (e.g. Bearer )","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.50.0"},"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":{"description":"API key fields to add as JSON body parameters","items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"headers":{"description":"API key fields to add as HTTP headers","items":{"$ref":"#/components/schemas/knowledge_connectors.BizAIOmniChannelConnectorApiKeyParam"},"type":"array","uniqueItems":false},"query_params":{"description":"API key fields to add as query parameters","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":{"description":"Header, query parameter, or body field name","type":"string"},"prefix":{"description":"Optional value prefix, such as Bearer followed by a space","type":"string"},"value":{"description":"Secret value for this API key field","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.50.0"},"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":{"description":"OAuth client ID","type":"string"},"client_secret":{"description":"OAuth client secret","type":"string"},"scopes_to_request":{"description":"OAuth scopes to request","items":{"type":"string"},"type":"array","uniqueItems":false},"token_request_content_type":{"description":"Content type for token requests. Supports application/x-www-form-urlencoded and application/json. Defaults to application/x-www-form-urlencoded.","type":"string"},"token_url":{"description":"Token URL used to request OAuth access tokens","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.50.0"},"components":{"schemas":{"knowledge_connectors.BizAIOmniChannelConnectorUserAuthInjectionConfig":{"description":"Configuration for injecting user auth tokens into tool requests","properties":{"field_name":{"description":"Field name for the injected token (e.g. X-User-Token)","type":"string"},"location":{"description":"Where to inject the token","enum":["body","headers","path","query"],"type":"string"},"prefix":{"description":"Prefix for the token value (e.g. Bearer )","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.50.0"},"components":{"schemas":{"knowledge_connectors.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"description":"Human-readable explanation of the error","type":"string"},"status":{"description":"HTTP status code","type":"integer"},"title":{"description":"Short, human-readable summary of the problem","type":"string"},"type":{"description":"A URI reference identifying the problem type","type":"string"}},"type":"object"}}}} ``` ## The knowledge\_faq.BizAIOmniChannelKnowledgeFAQRequest object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"knowledge_faq.BizAIOmniChannelKnowledgeFAQRequest":{"description":"Create or update an FAQ entry","properties":{"answer":{"description":"The FAQ answer text. Keep answers factual, concise, and self-contained.","type":"string"},"metadata":{"additionalProperties":{"type":"string"},"description":"Key-value metadata associated with this FAQ entry","type":"object"},"question":{"description":"The FAQ question text. Write it as a natural question a customer would ask. Each FAQ should address a single, specific topic.","type":"string"}},"required":["answer","question"],"type":"object"}}}} ``` ## The knowledge\_faq.BizAIOmniChannelKnowledgeFAQResponse object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"knowledge_faq.BizAIOmniChannelKnowledgeFAQResponse":{"description":"A single FAQ entry","properties":{"answer":{"description":"The FAQ answer text","type":"string"},"created_at":{"description":"The timestamp when the FAQ was created","type":"integer"},"id":{"description":"The unique identifier for this FAQ entry","type":"string"},"metadata":{"additionalProperties":{"type":"string"},"description":"Key-value metadata associated with this FAQ entry","type":"object"},"question":{"description":"The FAQ question text","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.50.0"},"components":{"schemas":{"knowledge_faq.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"description":"Human-readable explanation of the error","type":"string"},"status":{"description":"HTTP status code","type":"integer"},"title":{"description":"Short, human-readable summary of the problem","type":"string"},"type":{"description":"A URI reference identifying the problem type","type":"string"}},"type":"object"}}}} ``` ## The knowledge\_files.BizAIOmniChannelKnowledgeFileResponse object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"knowledge_files.BizAIOmniChannelKnowledgeFileResponse":{"description":"Metadata of a knowledge base file","properties":{"file_name":{"description":"The name of the file","type":"string"},"id":{"description":"The unique identifier for this file","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.50.0"},"components":{"schemas":{"knowledge_files.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"description":"Human-readable explanation of the error","type":"string"},"status":{"description":"HTTP status code","type":"integer"},"title":{"description":"Short, human-readable summary of the problem","type":"string"},"type":{"description":"A URI reference identifying the problem type","type":"string"}},"type":"object"}}}} ``` ## The knowledge\_skills.BizAIOmniChannelSkillsRequest object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"knowledge_skills.BizAIOmniChannelSkillsRequest":{"description":"Create or update an AI skill","properties":{"description":{"description":"A description telling the AI when to apply this skill. Max 1024 characters. Be specific about the trigger or context.","type":"string"},"skill":{"description":"The body containing the actual instructions for the AI. Max 20000 characters. Write clear, non-conflicting directives.","type":"string"},"title":{"description":"A human-readable name for the skill. Max 64 characters. Must contain only lowercase letters, numbers, and hyphens, and must not start or end with a hyphen.","type":"string"}},"type":"object"}}}} ``` ## The knowledge\_skills.BizAIOmniChannelSkillsResponse object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"knowledge_skills.BizAIOmniChannelSkillsResponse":{"description":"A single AI skill","properties":{"channel":{"description":"The channel/platform this skill applies to","enum":["email","instagram","line","messenger","sms","tiktok","unknown","webchat","whatsapp"],"type":"string"},"created_at":{"description":"The timestamp when the skill was created","type":"integer"},"description":{"description":"A description telling the AI when to apply this skill","type":"string"},"id":{"description":"A unique identifier for the skill","type":"string"},"metadata":{"additionalProperties":{"type":"string"},"description":"A map of key-value pairs for additional metadata","type":"object"},"skill":{"description":"The body containing the actual instructions for the AI. Has no specific restrictions on structure or content.","type":"string"},"title":{"description":"An optional, human-readable name for the skill","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.50.0"},"components":{"schemas":{"knowledge_skills.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"description":"Human-readable explanation of the error","type":"string"},"status":{"description":"HTTP status code","type":"integer"},"title":{"description":"Short, human-readable summary of the problem","type":"string"},"type":{"description":"A URI reference identifying the problem type","type":"string"}},"type":"object"}}}} ``` ## The knowledge\_websites.BizAIKnowledgeWebsiteRequest object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"knowledge_websites.BizAIKnowledgeWebsiteRequest":{"description":"Add or update a website crawl entry","properties":{"url":{"description":"The URL of the website to crawl","type":"string"}},"required":["url"],"type":"object"}}}} ``` ## The knowledge\_websites.BizAIKnowledgeWebsiteResponse object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"knowledge_websites.BizAIKnowledgeWebsiteResponse":{"description":"A single website crawl entry","properties":{"crawl_status":{"description":"The current status of the crawl (e.g., \"pending\", \"in_progress\", \"completed\", \"failed\")","type":"string"},"created_at":{"description":"The timestamp when the website entry was created","type":"integer"},"id":{"description":"The unique identifier for this website crawl entry","type":"string"},"last_crawled_at":{"description":"The timestamp when the website was last successfully crawled","type":"integer"},"pages_crawled":{"description":"The number of pages successfully crawled","type":"integer"},"url":{"description":"The URL of the website being crawled","type":"string"}},"required":["id","url"],"type":"object"}}}} ``` ## The knowledge\_websites.StandardError object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"knowledge_websites.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"description":"Human-readable explanation of the error","type":"string"},"status":{"description":"HTTP status code","type":"integer"},"title":{"description":"Short, human-readable summary of the problem","type":"string"},"type":{"description":"A URI reference identifying the problem type","type":"string"}},"type":"object"}}}} ``` ## The onboard.BizAIOmniChannelAllowlistRequest object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"onboard.BizAIOmniChannelAllowlistRequest":{"description":"Request payload to add a consumer WhatsApp phone number to the allowlist","properties":{"consumer_phone_number":{"description":"Consumer WhatsApp phone number in E.164 format (e.g. +15551234567)","type":"string"}},"required":["consumer_phone_number"],"type":"object"}}}} ``` ## The onboard.BizAIOmniChannelAllowlistResponse object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"onboard.BizAIOmniChannelAllowlistResponse":{"description":"A single allowlist entry","properties":{"consumer_phone_number":{"description":"Consumer WhatsApp phone number in E.164 format","type":"string"},"id":{"description":"The unique identifier for this allowlist entry","type":"string"}},"type":"object"}}}} ``` ## The onboard.BizAIOmniChannelDeleteAgentResponse object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"onboard.BizAIOmniChannelDeleteAgentResponse":{"description":"Result of removing the Meta Business agent from the phone number","properties":{"deleted_agent_id":{"description":"The ID of the AI agent settings that was removed, or null if there was nothing to remove","type":"string"}},"type":"object"}}}} ``` ## The onboard.BizAIOmniChannelEligibilityResponse object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"onboard.BizAIOmniChannelEligibilityResponse":{"description":"Eligibility result for the entity","properties":{"is_eligible":{"description":"Whether the entity is eligible for the business AI agent. true for eligible, false for not eligible","type":"boolean"}},"type":"object"}}}} ``` ## The onboard.BizAIOmniChannelOnboardingResponse object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"onboard.BizAIOmniChannelOnboardingResponse":{"description":"Result of triggering AI agent onboarding","properties":{"agent_id":{"description":"The ID of the agent settings entity","type":"string"}},"type":"object"}}}} ``` ## The onboard.BizAIOmniChannelSettingsFollowup object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"onboard.BizAIOmniChannelSettingsFollowup":{"description":"Settings for following up with an inactive user. Null if not configured","properties":{"enabled":{"description":"Whether followup is enabled. true to enable, false to disable","type":"boolean"},"followup_interval_in_seconds":{"description":"The time in seconds of user inactivity before the followup message is sent. Setting to 0 will disable followup","enum":[0,300,900,1800,3600,7200,28800,86400],"type":"integer"},"message":{"description":"The message sent to follow up with the user after inactivity","type":"string"}},"required":["enabled"],"type":"object"}}}} ``` ## The onboard.BizAIOmniChannelSettingsHandoff object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"onboard.BizAIOmniChannelSettingsHandoff":{"description":"Settings for handing over the conversation to a human agent. Null if not configured","properties":{"enabled":{"description":"Whether handoff to a human agent is enabled. true to enable, false to disable","type":"boolean"},"message":{"description":"The message displayed to the user when a handoff to a human agent occurs","type":"string"}},"required":["enabled"],"type":"object"}}}} ``` ## The onboard.BizAIOmniChannelSettingsRequest object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"onboard.BizAIOmniChannelSettingsRequest":{"description":"Create or fully replace the AI agent settings for an entity","properties":{"ai_audience":{"description":"Controls which consumers the AI agent responds to. EVERYONE = all consumers (default), ALLOWLISTED_ONLY = only phone numbers in the allowlist. Only supported for WhatsApp entities.","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":{"description":"Whether followup is enabled. true to enable, false to disable","type":"boolean"},"followup_interval_in_seconds":{"description":"The time in seconds of user inactivity before the followup message is sent. Setting to 0 will disable followup","enum":[0,300,900,1800,3600,7200,28800,86400],"type":"integer"},"message":{"description":"The message sent to follow up with the user after inactivity","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":{"description":"Whether handoff to a human agent is enabled. true to enable, false to disable","type":"boolean"},"message":{"description":"The message displayed to the user when a handoff to a human agent occurs","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":{"description":"Whether the AI agent is currently enabled. true for on, false for off","type":"boolean"}},"required":["enabled"],"type":"object"}}}} ``` ## The onboard.BizAIOmniChannelSettingsResponse object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"onboard.BizAIOmniChannelSettingsResponse":{"description":"The AI agent settings for an entity","properties":{"agent_id":{"description":"Unique identifier for this agent configuration. Use this ID to target a specific agent in update or delete operations","type":"string"},"ai_audience":{"description":"Controls which consumers the AI agent responds to. EVERYONE = all consumers (default), ALLOWLISTED_ONLY = only phone numbers in the allowlist. Null for non-WhatsApp entities.","enum":["ALLOWLISTED_ONLY","EVERYONE"],"type":"string"},"channel":{"description":"The channel/platform these settings apply to","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":{"description":"Whether followup is enabled. true to enable, false to disable","type":"boolean"},"followup_interval_in_seconds":{"description":"The time in seconds of user inactivity before the followup message is sent. Setting to 0 will disable followup","enum":[0,300,900,1800,3600,7200,28800,86400],"type":"integer"},"message":{"description":"The message sent to follow up with the user after inactivity","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":{"description":"Whether handoff to a human agent is enabled. true to enable, false to disable","type":"boolean"},"message":{"description":"The message displayed to the user when a handoff to a human agent occurs","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":{"description":"Whether the AI agent is currently enabled. true for on, false for off","type":"boolean"}},"required":["enabled"],"type":"object"}}}} ``` ## The onboard.BizAIOmniChannelSettingsRollout object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"onboard.BizAIOmniChannelSettingsRollout":{"description":"Rollout configuration for the AI agent, containing the enabled flag and future gradual rollout fields","properties":{"enabled":{"description":"Whether the AI agent is currently enabled. true for on, false for off","type":"boolean"}},"required":["enabled"],"type":"object"}}}} ``` ## The onboard.StandardError object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"onboard.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"description":"Human-readable explanation of the error","type":"string"},"status":{"description":"HTTP status code","type":"integer"},"title":{"description":"Short, human-readable summary of the problem","type":"string"},"type":{"description":"A URI reference identifying the problem type","type":"string"}},"type":"object"}}}} ``` ## The operate.BizAIComboJobError object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"operate.BizAIComboJobError":{"description":"Error details when status is FAILED","properties":{"code":{"description":"Error code (e.g. SIMULATION_FAILED)","type":"string"},"failed_case_ids":{"description":"IDs of cases that failed","items":{"type":"string"},"type":"array","uniqueItems":false},"message":{"description":"Human-readable error message","type":"string"}},"required":["code","message"],"type":"object"}}}} ``` ## The operate.BizAIComboJobProgress object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"operate.BizAIComboJobProgress":{"description":"Progress information while the job is running","properties":{"completed":{"description":"Number of eval cases completed","type":"integer"},"current_stage":{"description":"Current pipeline stage","enum":["simulation","evaluation","insights","done"],"type":"string"},"total":{"description":"Total number of eval cases in the job","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.50.0"},"components":{"schemas":{"operate.BizAIComboJobResult":{"description":"Full result payload when status is COMPLETED","properties":{"avg_conversation_score":{"description":"Average score across evaluated conversations (range: 1-5)","type":"number"},"avg_turn_score":{"description":"Average score across evaluated turns (range: 1-5)","type":"number"},"creation_time":{"description":"Unix timestamp when the insight report was created","type":"integer"},"eval_ids_by_score":{"description":"JSON object grouping evaluation IDs by score","type":"string"},"highlights":{"description":"JSON array of highlight objects with description and evaluation IDs","type":"string"},"summary":{"description":"Natural-language summary of overall agent performance","type":"string"},"summary_id":{"description":"The unique identifier for the summary report","type":"string"},"top_failure_categories":{"description":"JSON array of failure category objects with category, evaluation IDs, and recommended actions","type":"string"},"update_time":{"description":"Unix timestamp when the insight report was last updated","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.50.0"},"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":{"description":"Job status","enum":["QUEUED","RUNNING","COMPLETED","FAILED"],"type":"string"}},"required":["status"],"type":"object"},"operate.BizAIComboJobError":{"description":"Error details when status is FAILED","properties":{"code":{"description":"Error code (e.g. SIMULATION_FAILED)","type":"string"},"failed_case_ids":{"description":"IDs of cases that failed","items":{"type":"string"},"type":"array","uniqueItems":false},"message":{"description":"Human-readable error message","type":"string"}},"required":["code","message"],"type":"object"},"operate.BizAIComboJobProgress":{"description":"Progress information while the job is running","properties":{"completed":{"description":"Number of eval cases completed","type":"integer"},"current_stage":{"description":"Current pipeline stage","enum":["simulation","evaluation","insights","done"],"type":"string"},"total":{"description":"Total number of eval cases in the job","type":"integer"}},"required":["completed","current_stage","total"],"type":"object"},"operate.BizAIComboJobResult":{"description":"Full result payload when status is COMPLETED","properties":{"avg_conversation_score":{"description":"Average score across evaluated conversations (range: 1-5)","type":"number"},"avg_turn_score":{"description":"Average score across evaluated turns (range: 1-5)","type":"number"},"creation_time":{"description":"Unix timestamp when the insight report was created","type":"integer"},"eval_ids_by_score":{"description":"JSON object grouping evaluation IDs by score","type":"string"},"highlights":{"description":"JSON array of highlight objects with description and evaluation IDs","type":"string"},"summary":{"description":"Natural-language summary of overall agent performance","type":"string"},"summary_id":{"description":"The unique identifier for the summary report","type":"string"},"top_failure_categories":{"description":"JSON array of failure category objects with category, evaluation IDs, and recommended actions","type":"string"},"update_time":{"description":"Unix timestamp when the insight report was last updated","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.50.0"},"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.50.0"},"components":{"schemas":{"operate.BizAIComboRunResponse":{"description":"Acknowledgment that the job was accepted for processing","properties":{"job_id":{"description":"The unique identifier for the created evaluation job (pfbid format)","type":"string"},"status":{"description":"Initial job status: QUEUED","type":"string"}},"required":["job_id","status"],"type":"object"}}}} ``` ## The operate.BizAIEvalCaseResponse object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"operate.BizAIEvalCaseResponse":{"description":"A single evaluation scenario configuration","properties":{"categories":{"description":"Category strings for the test scenario","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The eval case entity ID","type":"string"},"max_turns":{"description":"Maximum number of turns allowed in the conversation simulation","type":"integer"},"scenario":{"description":"Free-form text defining the task and constraints for the user simulator","type":"string"},"success_criteria":{"description":"Criteria strings the agent must meet for the test to pass","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.50.0"},"components":{"schemas":{"operate.BizAIEvalDetailResponse":{"description":"A per-conversation evaluation result","properties":{"creation_time":{"description":"Unix timestamp when the evaluation was created","type":"integer"},"custom_success_criteria":{"description":"JSON array of client-specified success criteria strings","type":"string"},"eval_case_id":{"description":"ID of the eval case that defined the scenario and success criteria","type":"string"},"id":{"description":"The evaluation ID","type":"string"},"per_turn_labels":{"description":"JSON array of per-turn label integers","type":"string"},"reasons":{"description":"JSON array of {category, score, description, recommended_actions} objects","type":"string"},"score":{"description":"Overall evaluation score from the judge LLM","type":"integer"},"transcript":{"description":"JSON object with system_prompt and transcript_turns for the evaluated conversation","type":"string"},"update_time":{"description":"Unix timestamp when the evaluation was last updated","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.50.0"},"components":{"schemas":{"operate.BizAIEvalSummaryResponse":{"description":"An aggregated insight report","properties":{"avg_conversation_score":{"description":"Average score across evaluated conversations","type":"number"},"avg_turn_score":{"description":"Average score across evaluated turns","type":"number"},"creation_time":{"description":"Unix timestamp when the insight report was created","type":"integer"},"eval_ids_by_score":{"description":"JSON object grouping evaluation IDs by score","type":"string"},"highlights":{"description":"JSON array of highlight objects with description and evaluation IDs","type":"string"},"id":{"description":"The unique identifier for the insight report","type":"string"},"summary":{"description":"Natural-language summary of overall agent performance","type":"string"},"top_failure_categories":{"description":"JSON array of failure category objects with category, evaluation IDs, and recommended actions","type":"string"},"update_time":{"description":"Unix timestamp when the insight report was last updated","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.50.0"},"components":{"schemas":{"operate.BizAIOmniChannelAgentEvent":{"description":"Event-specific fields","properties":{"description":{"description":"Human-readable description of the event. Max 1024 characters.","type":"string"},"payload":{"description":"Opaque JSON string passed through to the agent as-is. Max 4096 characters.","type":"string"},"type":{"description":"Partner-defined event identifier, e.g. document_verified. Max 256 characters.","type":"string"}},"required":["description","payload","type"],"type":"object"}}}} ``` ## The operate.BizAIOmniChannelAgentEventRequest object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"operate.BizAIOmniChannelAgentEventRequest":{"description":"Trigger an agent action asynchronously","properties":{"event":{"$ref":"#/components/schemas/operate.BizAIOmniChannelAgentEvent"},"to":{"description":"Consumer phone number in E.164 format","type":"string"}},"required":["event","to"],"type":"object"},"operate.BizAIOmniChannelAgentEvent":{"description":"Event-specific fields","properties":{"description":{"description":"Human-readable description of the event. Max 1024 characters.","type":"string"},"payload":{"description":"Opaque JSON string passed through to the agent as-is. Max 4096 characters.","type":"string"},"type":{"description":"Partner-defined event identifier, e.g. document_verified. Max 256 characters.","type":"string"}},"required":["description","payload","type"],"type":"object"}}}} ``` ## The operate.BizAIOmniChannelAgentEventResponse object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"operate.BizAIOmniChannelAgentEventResponse":{"description":"Acknowledgment that the event was accepted for processing","properties":{"agent_event_id":{"description":"The ID of the recorded agent event, when one was created","type":"string"},"status":{"description":"\"accepted\" when the event is successfully enqueued","type":"string"}},"required":["status"],"type":"object"}}}} ``` ## The operate.BizAIOmniChannelAgentEventStatusResponse object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"operate.BizAIOmniChannelAgentEventStatusResponse":{"description":"The current processing status of an agent event","properties":{"created_at":{"description":"The ISO 8601 timestamp at which the agent event was received","type":"string"},"error_message":{"description":"Summary of failure, if event state is FAILED","type":"string"},"event_type":{"description":"The partner-defined event identifier supplied when the event was submitted, e.g. document_verified","type":"string"},"skipped_reason":{"description":"Summary of skip reason, if event state is SKIPPED","type":"string"},"status":{"description":"The current processing status of the agent event","enum":["request_received","processing","sent","failed","skipped","success"],"type":"string"},"updated_at":{"description":"The ISO 8601 timestamp at which the agent event status was last updated","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.50.0"},"components":{"schemas":{"operate.BizAIOmniChannelAgentTestRequest":{"description":"Send a test message to the AI agent","properties":{"conversation_id":{"description":"Identifier for multi-turn test conversations. Provide the conversation_id from a previous response to continue that conversation.","type":"string"},"user_msg":{"description":"The text content of the test message to send to the AI agent","type":"string"}},"required":["user_msg"],"type":"object"}}}} ``` ## The operate.BizAIOmniChannelAgentTestResponse object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"operate.BizAIOmniChannelAgentTestResponse":{"description":"The AI agent response and test conversation metadata","properties":{"agent_response":{"description":"The AI agent response text","type":"string"},"conversation_id":{"description":"The test conversation identifier. Use this in subsequent requests for multi-turn conversations.","type":"string"},"handoff_reason":{"description":"If the agent hands off to a human, this contains the reason","type":"string"},"message_id":{"description":"Unique identifier for this message exchange","type":"string"},"no_response_reason":{"description":"If the agent did not generate a response, this contains the reason (e.g. ELIGIBILITY_CHECK_FAILED)","type":"string"},"product_variant_ids":{"description":"The variant IDs of the products referenced in the agent response","items":{"type":"string"},"type":"array","uniqueItems":false},"quick_replies":{"description":"Suggested quick reply messages generated by the AI agent","items":{"type":"string"},"type":"array","uniqueItems":false},"timestamp":{"description":"Unix timestamp when the response was generated","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.50.0"},"components":{"schemas":{"operate.EvalCasesResponse":{"description":"List of eval cases for the entity","properties":{"eval_cases":{"description":"Array of eval case configurations","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":{"description":"Category strings for the test scenario","items":{"type":"string"},"type":"array","uniqueItems":false},"id":{"description":"The eval case entity ID","type":"string"},"max_turns":{"description":"Maximum number of turns allowed in the conversation simulation","type":"integer"},"scenario":{"description":"Free-form text defining the task and constraints for the user simulator","type":"string"},"success_criteria":{"description":"Criteria strings the agent must meet for the test to pass","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.50.0"},"components":{"schemas":{"operate.EvalDetailsResponse":{"description":"List of evaluation results","properties":{"evaluations":{"description":"List of evaluation results","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":{"description":"Unix timestamp when the evaluation was created","type":"integer"},"custom_success_criteria":{"description":"JSON array of client-specified success criteria strings","type":"string"},"eval_case_id":{"description":"ID of the eval case that defined the scenario and success criteria","type":"string"},"id":{"description":"The evaluation ID","type":"string"},"per_turn_labels":{"description":"JSON array of per-turn label integers","type":"string"},"reasons":{"description":"JSON array of {category, score, description, recommended_actions} objects","type":"string"},"score":{"description":"Overall evaluation score from the judge LLM","type":"integer"},"transcript":{"description":"JSON object with system_prompt and transcript_turns for the evaluated conversation","type":"string"},"update_time":{"description":"Unix timestamp when the evaluation was last updated","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.50.0"},"components":{"schemas":{"operate.EvalSummariesResponse":{"description":"List of insight reports","properties":{"insights":{"description":"Array of insight report objects","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":{"description":"Average score across evaluated conversations","type":"number"},"avg_turn_score":{"description":"Average score across evaluated turns","type":"number"},"creation_time":{"description":"Unix timestamp when the insight report was created","type":"integer"},"eval_ids_by_score":{"description":"JSON object grouping evaluation IDs by score","type":"string"},"highlights":{"description":"JSON array of highlight objects with description and evaluation IDs","type":"string"},"id":{"description":"The unique identifier for the insight report","type":"string"},"summary":{"description":"Natural-language summary of overall agent performance","type":"string"},"top_failure_categories":{"description":"JSON array of failure category objects with category, evaluation IDs, and recommended actions","type":"string"},"update_time":{"description":"Unix timestamp when the insight report was last updated","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.50.0"},"components":{"schemas":{"operate.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"description":"Human-readable explanation of the error","type":"string"},"status":{"description":"HTTP status code","type":"integer"},"title":{"description":"Short, human-readable summary of the problem","type":"string"},"type":{"description":"A URI reference identifying the problem type","type":"string"}},"type":"object"}}}} ``` ## The operate.ThreadControlPassRequest object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"operate.ThreadControlPassRequest":{"description":"Optional configuration for a pass action. When omitted, pass uses the configured escalation partner.","properties":{"target_role":{"description":"Role receiving thread control. \"ai_agent\" selects Meta Business Agent.","enum":["ai_agent"],"type":"string"}},"required":["target_role"],"type":"object"}}}} ``` ## The operate.ThreadControlRequest object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"operate.ThreadControlRequest":{"description":"Thread control action to perform","properties":{"action":{"description":"The thread control action to perform. \"release\" relinquishes thread control and hands the conversation back to Meta Business Agent as the automatic responder; you must currently hold thread control. \"take\" acquires thread control from the current owner and is restricted to the configured escalation partner. \"pass\" transfers thread control to Meta Business Agent when control_pass.target_role is \"ai_agent\", or to the configured escalation partner when control_pass is omitted; you must currently hold thread control.","enum":["pass","release","take"],"type":"string"},"control_pass":{"$ref":"#/components/schemas/operate.ThreadControlPassRequest"},"messaging_product":{"description":"Messaging service used for the request. Must be \"whatsapp\".","enum":["whatsapp"],"type":"string"},"metadata":{"description":"Optional free-form string forwarded verbatim to the receiving app in the resulting messaging_handovers webhook.","type":"string"},"recipient":{"description":"Business-scoped user ID of the consumer whose thread control is being transferred. Accepted but not yet wired; provide \"to\" instead.","type":"string"},"to":{"description":"Consumer identifier (phone number or WhatsApp ID) whose thread control is being transferred.","type":"string"}},"required":["action","messaging_product"],"type":"object"},"operate.ThreadControlPassRequest":{"description":"Optional configuration for a pass action. When omitted, pass uses the configured escalation partner.","properties":{"target_role":{"description":"Role receiving thread control. \"ai_agent\" selects Meta Business Agent.","enum":["ai_agent"],"type":"string"}},"required":["target_role"],"type":"object"}}}} ``` ## The operate.ThreadControlResponse object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"operate.ThreadControlResponse":{"description":"Thread control action result with messaging product identifier","properties":{"messaging_product":{"description":"Messaging service used for the response. Always \"whatsapp\".","enum":["whatsapp"],"type":"string"}},"required":["messaging_product"],"type":"object"}}}} ``` ## The ui\_skills.BizAIOmniChannelUISkillCreateRequest object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"ui_skills.BizAIOmniChannelUISkillCreateRequest":{"description":"Create a UI skill","properties":{"component_type":{"description":"The type of rich message this UI skill sends","enum":["carousel_quick_reply","carousel_url","cta_url","flow","image","interactive_list","interactive_reply_buttons","location","location_request"],"type":"string"},"flow_id":{"description":"The identifier of the flow to associate. Required when component_type is flow, and not supported otherwise","type":"integer"},"instruction":{"description":"A description telling the AI agent when to send this UI skill","type":"string"},"status":{"description":"Whether this UI skill is enabled and available to the AI agent","enum":["disabled","enabled"],"type":"string"},"title":{"description":"A human-readable name for the UI skill","type":"string"}},"required":["component_type","instruction","status","title"],"type":"object"}}}} ``` ## The ui\_skills.BizAIOmniChannelUISkillListResponse object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"ui_skills.BizAIOmniChannelUISkillListResponse":{"description":"A paginated list of UI skills","properties":{"data":{"description":"The page of data returned","items":{"$ref":"#/components/schemas/ui_skills.BizAIOmniChannelUISkillResponse"},"type":"array","uniqueItems":false},"paging":{"$ref":"#/components/schemas/ui_skills.Paging","description":"Pagination metadata"}},"required":["data"],"type":"object"},"ui_skills.BizAIOmniChannelUISkillResponse":{"description":"A single UI skill","properties":{"component_type":{"description":"The type of rich message this UI skill sends","enum":["carousel_quick_reply","carousel_url","cta_url","flow","image","interactive_list","interactive_reply_buttons","location","location_request"],"type":"string"},"created_at":{"description":"The timestamp when the UI skill was created","type":"integer"},"flow_id":{"description":"The identifier of the associated flow. Only present for flow skills","type":"integer"},"id":{"description":"A unique identifier for the UI skill","type":"string"},"instruction":{"description":"A description telling the AI agent when to send this UI skill","type":"string"},"status":{"description":"Whether this UI skill is enabled and available to the AI agent","enum":["disabled","enabled"],"type":"string"},"title":{"description":"A human-readable name for the UI skill","type":"string"},"updated_at":{"description":"The timestamp when the UI skill was last updated","type":"integer"}},"required":["component_type","created_at","id","instruction","status","title","updated_at"],"type":"object"},"ui_skills.Paging":{"description":"Pagination metadata","properties":{"cursors":{"$ref":"#/components/schemas/ui_skills.Cursors","description":"Cursors to the next and previous pages"},"next":{"description":"The API that will return the next page of data. If not included, this is the last page of data. Due to how pagination works with visibility and privacy, a page may be empty but still carry a next link, so stop paging when the next link no longer appears","type":"string"},"previous":{"description":"The API that will return the previous page of data. If not included, this is the first page of data","type":"string"}},"required":["cursors"],"type":"object"},"ui_skills.Cursors":{"description":"Cursors to the next and previous pages","properties":{"after":{"description":"The cursor that points to the end of the page of data that has been returned","type":"string"},"before":{"description":"The cursor that points to the start of the page of data that has been returned","type":"string"}},"type":"object"}}}} ``` ## The ui\_skills.BizAIOmniChannelUISkillResponse object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"ui_skills.BizAIOmniChannelUISkillResponse":{"description":"A single UI skill","properties":{"component_type":{"description":"The type of rich message this UI skill sends","enum":["carousel_quick_reply","carousel_url","cta_url","flow","image","interactive_list","interactive_reply_buttons","location","location_request"],"type":"string"},"created_at":{"description":"The timestamp when the UI skill was created","type":"integer"},"flow_id":{"description":"The identifier of the associated flow. Only present for flow skills","type":"integer"},"id":{"description":"A unique identifier for the UI skill","type":"string"},"instruction":{"description":"A description telling the AI agent when to send this UI skill","type":"string"},"status":{"description":"Whether this UI skill is enabled and available to the AI agent","enum":["disabled","enabled"],"type":"string"},"title":{"description":"A human-readable name for the UI skill","type":"string"},"updated_at":{"description":"The timestamp when the UI skill was last updated","type":"integer"}},"required":["component_type","created_at","id","instruction","status","title","updated_at"],"type":"object"}}}} ``` ## The ui\_skills.BizAIOmniChannelUISkillUpdateRequest object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"ui_skills.BizAIOmniChannelUISkillUpdateRequest":{"description":"Update a UI skill","properties":{"instruction":{"description":"A description telling the AI agent when to send this UI skill","type":"string"},"status":{"description":"Whether this UI skill is enabled and available to the AI agent. Flow skills cannot be enabled unless the corresponding flow is published","enum":["disabled","enabled"],"type":"string"},"title":{"description":"A human-readable name for the UI skill","type":"string"}},"type":"object"}}}} ``` ## The ui\_skills.Cursors object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"ui_skills.Cursors":{"description":"Cursors to the next and previous pages","properties":{"after":{"description":"The cursor that points to the end of the page of data that has been returned","type":"string"},"before":{"description":"The cursor that points to the start of the page of data that has been returned","type":"string"}},"type":"object"}}}} ``` ## The ui\_skills.Paging object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"ui_skills.Paging":{"description":"Pagination metadata","properties":{"cursors":{"$ref":"#/components/schemas/ui_skills.Cursors","description":"Cursors to the next and previous pages"},"next":{"description":"The API that will return the next page of data. If not included, this is the last page of data. Due to how pagination works with visibility and privacy, a page may be empty but still carry a next link, so stop paging when the next link no longer appears","type":"string"},"previous":{"description":"The API that will return the previous page of data. If not included, this is the first page of data","type":"string"}},"required":["cursors"],"type":"object"},"ui_skills.Cursors":{"description":"Cursors to the next and previous pages","properties":{"after":{"description":"The cursor that points to the end of the page of data that has been returned","type":"string"},"before":{"description":"The cursor that points to the start of the page of data that has been returned","type":"string"}},"type":"object"}}}} ``` ## The ui\_skills.StandardError object ```json {"openapi":"3.1.0","info":{"title":"Business Agent API","version":"1.50.0"},"components":{"schemas":{"ui_skills.StandardError":{"description":"Standard error response for Meta Business Agent endpoints","properties":{"detail":{"description":"Human-readable explanation of the error","type":"string"},"status":{"description":"HTTP status code","type":"integer"},"title":{"description":"Short, human-readable summary of the problem","type":"string"},"type":{"description":"A URI reference identifying the problem type","type":"string"}},"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=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.