{"openapi":"3.1.0","info":{"title":"api-service","version":"0.1.0"},"paths":{"/docs":{"get":{"summary":"Redirect Docs","operationId":"redirect_docs_docs_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/v1/integrations/chat/conversation":{"post":{"tags":["Integrations"],"summary":"Create Chat Conversation","description":"Use this API to create or retrieve a chat conversation for a user.  \n\nThis endpoint supports multiple ways of identifying a user or conversation.  \nDepending on the fields you provide, the API will behave differently.  \nThe sections below explain each scenario and the recommended approach.  \n\n---\n\n## conversation_reference_id (external reference to an existing conversation)  \nUse this field when you want to link a conversation to an external identifier \n(for example, a `complaint_id` or support ticket number in your own system).  \n\n**Behavior:**\n- If a conversation already exists for the provided reference ID, it will be returned.\n- If no conversation exists, a new one will be created and associated with this reference ID.\n- When this field is provided, `chat_user_id`, `user_external_id`, `user_name`, and `user_phone` are **ignored** during lookup.\n- User resolution is handled internally using the existing conversation.\n\n**Recommendation:**  \nWe generally do *not* recommend using this field for user identification, as it may lead to inconsistent or unexpected behavior if used incorrectly.  \nUse `chat_user_id` instead whenever possible.\n\nUse this field to provide reference to existing opened conversation. For example, it can be `complaint_id` on your system...  \nIf provided, it will get/create conversation using reference id.  \nDuring get operation, the values of `chat_user` and `chat_phone` will be ignored.  \nWe do not recommend using this field as it could pose inconsistent behavior.  \n\n## chat_user_id (preferred method)\nThis is the recommended and most reliable way to associate a user with a conversation.\n\n**Behavior:**\n- The conversation is created (or retrieved) for this specific chat user.\n- User details are managed through dedicated Chat User APIs.\n- No automatic user creation or profile changes happen at this step.\n\n**Recommendation:**  \nUse this field whenever the user already exists in your chat system.\n\n## user_external_id, user_name, user_phone  \nUse these fields when the user doesn't yet exist in your chat platform and you want the API to auto-create them.  \n\n**Behavior:**\n- If `chat_user_id` is provided, these fields are **ignored**.\n- If `user_external_id` is provided and the user does not exist, a new user will be created automatically.\n- If the user already exists, **their profile details (`user_name`, `user_phone`) are NOT updated**.\n\n**Important Note:**  \nTo update user details later, use the dedicated Chat User Update API.  \nThis endpoint does not modify any existing user information.\n\n### Required scopes:\n- `organization:admin`: Modify your organization","operationId":"create_conversation_api_v1_integrations_chat_conversation_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConversation"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatConversationSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"api_key":["organization:admin"]},{"session_key":["organization:admin"]}]}},"/api/v1/integrations/chat/conversation/{conversation_id}/message":{"post":{"tags":["Integrations"],"summary":"Send Message to Chat Conversation","description":"Use this API to send message to a chat conversation.\n\n### Required scopes:\n- `organization:admin`: Modify your organization","operationId":"add_message_api_v1_integrations_chat_conversation__conversation_id__message_post","security":[{"api_key":["organization:admin"]}],"parameters":[{"name":"conversation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Chat conversation `id` returned in create conversaion API response","title":"Conversation Id"},"description":"Chat conversation `id` returned in create conversaion API response"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppendMessageEvent"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessedMessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/integrations/chatwoot/message/{connector_id}":{"post":{"tags":["Integrations - chatwoot"],"summary":"Chatwoot Webhook Handler","operationId":"chatwoot_webhook_handler_api_v1_integrations_chatwoot_message__connector_id__post","parameters":[{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connector Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Event"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/integrations/wati/message/{connector_id}":{"post":{"tags":["Integrations - wati"],"summary":"Wati Webhook Handler","operationId":"wati_webhook_handler_api_v1_integrations_wati_message__connector_id__post","parameters":[{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connector Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageReceived"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/integrations/respondio/message/{connector_id}":{"post":{"tags":["Integrations - respondio"],"summary":"Respondio Webhook Handler","operationId":"respondio_webhook_handler_api_v1_integrations_respondio_message__connector_id__post","parameters":[{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connector Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Event"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/integrations/whatsapp/message/{connector_id}":{"get":{"tags":["Integrations - whatsapp"],"summary":"Whatsapp Webhook Verification Handler","operationId":"whatsapp_webhook_verification_handler_api_v1_integrations_whatsapp_message__connector_id__get","parameters":[{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connector Id"}},{"name":"hub.mode","in":"query","required":true,"schema":{"type":"string","title":"Hub.Mode"}},{"name":"hub.verify_token","in":"query","required":true,"schema":{"type":"string","title":"Hub.Verify Token"}},{"name":"hub.challenge","in":"query","required":true,"schema":{"type":"string","title":"Hub.Challenge"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Integrations - whatsapp"],"summary":"Whatsapp Webhook Handler","operationId":"whatsapp_webhook_handler_api_v1_integrations_whatsapp_message__connector_id__post","parameters":[{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connector Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Event"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaigns":{"get":{"tags":["Campaigns"],"summary":"List Campaigns","description":"List campaigns\n\n### Required scopes:\n- `campaigns:read`: Read campaigns\n\n- `campaigns:write`: Modify campaigns\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"list_campaigns_api_v1_campaigns_get","security":[{"api_key":["campaigns:read","campaigns:write","organization:admin","organization:read"]},{"session_key":["campaigns:read","campaigns:write","organization:admin","organization:read"]}],"parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/CampaignStatus"},{"type":"null"}],"description":"Campaign status","title":"Status"},"description":"Campaign status"},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/CampaignType"},{"type":"null"}],"description":"Campaign type","title":"Type"},"description":"Campaign type"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Campaign name","title":"Name"},"description":"Campaign name"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResource_ListCampaignsResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Campaigns"],"summary":"Create Campaign","operationId":"create_campaign_api_v1_campaigns_post","security":[{"api_key":["campaigns:write","organization:admin"]},{"session_key":["campaigns:write","organization:admin"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCampaignRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignDetailsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `campaigns:write`: Modify campaigns\n\n- `organization:admin`: Modify your organization"}},"/api/v1/campaigns/{campaign_id}":{"get":{"tags":["Campaigns"],"summary":"Get Campaign","operationId":"get_by_id_api_v1_campaigns__campaign_id__get","security":[{"api_key":["campaigns:read","campaigns:write","organization:admin","organization:read"]},{"session_key":["campaigns:read","campaigns:write","organization:admin","organization:read"]}],"parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Campaign Id"}},{"name":"include_phonenumbers","in":"query","required":false,"schema":{"type":"boolean","description":"Include campaign phone numbers list","default":false,"title":"Include Phonenumbers"},"description":"Include campaign phone numbers list"},{"name":"include_insights","in":"query","required":false,"schema":{"type":"boolean","description":"Include basic campaign insights","default":false,"title":"Include Insights"},"description":"Include basic campaign insights"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCampaignDetailsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `campaigns:read`: Read campaigns\n\n- `campaigns:write`: Modify campaigns\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization"},"delete":{"tags":["Campaigns"],"summary":"Delete Campaign","operationId":"delete_by_id_api_v1_campaigns__campaign_id__delete","security":[{"api_key":["campaigns:write","organization:admin"]},{"session_key":["campaigns:write","organization:admin"]}],"parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Campaign Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCampaignResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `campaigns:write`: Modify campaigns\n\n- `organization:admin`: Modify your organization"}},"/api/v1/campaigns/{campaign_id}/step":{"put":{"tags":["Campaigns"],"summary":"Update Campaign Step","operationId":"update_campaign_step_api_v1_campaigns__campaign_id__step_put","security":[{"api_key":["campaigns:write","organization:admin"]},{"session_key":["campaigns:write","organization:admin"]}],"parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Campaign Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UpdateCampaignDetailsStep"},{"$ref":"#/components/schemas/UpdateCampaignDestinationsStep"},{"$ref":"#/components/schemas/UpdateCampaignConfigurationStep"}],"discriminator":{"propertyName":"step","mapping":{"details":"#/components/schemas/UpdateCampaignDetailsStep","destinations":"#/components/schemas/UpdateCampaignDestinationsStep","configuration":"#/components/schemas/UpdateCampaignConfigurationStep"}},"title":"Data"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignDetailsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `campaigns:write`: Modify campaigns\n\n- `organization:admin`: Modify your organization"}},"/api/v1/campaigns/{campaign_id}/status":{"put":{"tags":["Campaigns"],"summary":"Update Campaign Status","description":"Update campaign status as paused or resume\n\n### Required scopes:\n- `campaigns:write`: Modify campaigns\n\n- `organization:admin`: Modify your organization","operationId":"update_campaign_status_api_v1_campaigns__campaign_id__status_put","security":[{"api_key":["campaigns:write","organization:admin"]},{"session_key":["campaigns:write","organization:admin"]}],"parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Campaign Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCampaignStatusRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignDetailsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaigns/{campaign_id}/destinations":{"post":{"tags":["Campaigns"],"summary":"Update Campaign Destinations","description":"Use this API to add outbound calls (destinations) to an existing campaign\n\n### Required scopes:\n- `campaigns:write`: Modify campaigns\n\n- `organization:admin`: Modify your organization","operationId":"update_campaign_destinations_api_v1_campaigns__campaign_id__destinations_post","security":[{"api_key":["campaigns:write","organization:admin"]},{"session_key":["campaigns:write","organization:admin"]}],"parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Campaign Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCampaignDestinationsSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCampaignDestinationsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/campaigns/{campaign_id}/analytics":{"get":{"tags":["Campaigns"],"summary":"Get Campaign Analytics","operationId":"get_campaign_analytics_api_v1_campaigns__campaign_id__analytics_get","security":[{"api_key":["campaigns:read","campaigns:write","organization:admin","organization:read"]},{"session_key":["campaigns:read","campaigns:write","organization:admin","organization:read"]}],"parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Campaign Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignAnalyticsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `campaigns:read`: Read campaigns\n\n- `campaigns:write`: Modify campaigns\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization"}},"/api/v1/agent-rules":{"get":{"tags":["Agent Rules"],"summary":"List Agent Rules","description":"List all agent rules grouped by category. Returns both organization-owned and system/global rules.\n\n### Required scopes:\n- `inbound_configs:read`: Read inbound configs / agents\n\n- `inbound_configs:write`: Modify inbound configs / agents\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"list_agent_rules_api_v1_agent_rules_get","security":[{"api_key":["inbound_configs:read","inbound_configs:write","organization:admin","organization:read"]},{"session_key":["inbound_configs:read","inbound_configs:write","organization:admin","organization:read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResource_AgentRulesCategorySchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Agent Rules"],"summary":"Create Agent Rule","description":"Create a new agent rule under a category.\n\n### Required scopes:\n- `inbound_configs:write`: Modify inbound configs / agents\n\n- `organization:admin`: Modify your organization","operationId":"create_agent_rule_api_v1_agent_rules_post","security":[{"api_key":["inbound_configs:write","organization:admin"]},{"session_key":["inbound_configs:write","organization:admin"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAgentRule"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentRuleSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/agent-rules/{agent_rule_id}":{"patch":{"tags":["Agent Rules"],"summary":"Update Agent Rule","description":"Update an organization-owned agent rule. Cannot update system/global rules.\n\n### Required scopes:\n- `inbound_configs:write`: Modify inbound configs / agents\n\n- `organization:admin`: Modify your organization","operationId":"update_agent_rule_api_v1_agent_rules__agent_rule_id__patch","security":[{"api_key":["inbound_configs:write","organization:admin"]},{"session_key":["inbound_configs:write","organization:admin"]}],"parameters":[{"name":"agent_rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Rule Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAgentRule"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentRuleSchema"}}}},"403":{"description":"Cannot modify system/global agent rules","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Agent Rules"],"summary":"Delete Agent Rule","description":"Soft-delete an organization-owned agent rule. Cannot delete system/global rules.\n\n### Required scopes:\n- `inbound_configs:write`: Modify inbound configs / agents\n\n- `organization:admin`: Modify your organization","operationId":"delete_agent_rule_api_v1_agent_rules__agent_rule_id__delete","security":[{"api_key":["inbound_configs:write","organization:admin"]},{"session_key":["inbound_configs:write","organization:admin"]}],"parameters":[{"name":"agent_rule_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Rule Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentRuleSchema"}}}},"403":{"description":"Cannot modify system/global agent rules","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/chat-users":{"post":{"tags":["Chat Users"],"summary":"Create Chat User","description":"Use this API to create chat user\n\n### Required scopes:\n- `chat_users:write`: Modify chat users\n\n- `organization:admin`: Modify your organization","operationId":"create_chat_user_api_v1_chat_users_post","security":[{"api_key":["chat_users:write","organization:admin"]},{"session_key":["chat_users:write","organization:admin"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChatUser"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatUserSchema"}}}},"409":{"description":"Chat user already exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceAlreadyExists"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Chat Users"],"summary":"List Chat Users","description":"Use this API to list chat users\n\n### Required scopes:\n- `chat_users:read`: Read chat users\n\n- `chat_users:write`: Modify chat users\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"list_chat_users_api_v1_chat_users_get","security":[{"api_key":["chat_users:read","chat_users:write","organization:admin","organization:read"]},{"session_key":["chat_users:read","chat_users:write","organization:admin","organization:read"]}],"parameters":[{"name":"external_id","in":"query","required":false,"schema":{"type":"string","description":"Filter by external_id (exact match)","title":"External Id"},"description":"Filter by external_id (exact match)"},{"name":"name","in":"query","required":false,"schema":{"type":"string","description":"Filter by name (fuzzy match)","title":"Name"},"description":"Filter by name (fuzzy match)"},{"name":"phone","in":"query","required":false,"schema":{"type":"string","description":"Filter by phone (fuzzy match)","title":"Phone"},"description":"Filter by phone (fuzzy match)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResource_ChatUserSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/chat-users/{chat_user_id}":{"get":{"tags":["Chat Users"],"summary":"Get Chat User By Id","description":"Use this API to get chat user by id\n\n### Required scopes:\n- `chat_users:read`: Read chat users\n\n- `chat_users:write`: Modify chat users\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"get_chat_user_by_id_api_v1_chat_users__chat_user_id__get","security":[{"api_key":["chat_users:read","chat_users:write","organization:admin","organization:read"]},{"session_key":["chat_users:read","chat_users:write","organization:admin","organization:read"]}],"parameters":[{"name":"chat_user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Chat User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatUserSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Chat Users"],"summary":"Update Chat User By Id","description":"Use this API to update chat user by id\n\n### Required scopes:\n- `chat_users:write`: Modify chat users\n\n- `organization:admin`: Modify your organization","operationId":"update_chat_user_by_id_api_v1_chat_users__chat_user_id__patch","security":[{"api_key":["chat_users:write","organization:admin"]},{"session_key":["chat_users:write","organization:admin"]}],"parameters":[{"name":"chat_user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Chat User Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChatUser"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatUserSchema"}}}},"409":{"description":"Chat user already exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceAlreadyExists"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/actions":{"post":{"tags":["Actions"],"summary":"Create Custom Action","description":"Create a new custom action.\n\n### Required scopes:\n- `actions:write`: Modify actions / tools\n\n- `organization:admin`: Modify your organization","operationId":"create_action_api_v1_actions_post","security":[{"api_key":["actions:write","organization:admin"]},{"session_key":["actions:write","organization:admin"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreateMCPAction"},{"$ref":"#/components/schemas/CreateGoogleSheetsRowAppendAction"},{"$ref":"#/components/schemas/CreateTransferCallAction"},{"$ref":"#/components/schemas/CreateTransferChatRespondioAction"},{"$ref":"#/components/schemas/CreateApiCallAction"},{"$ref":"#/components/schemas/CreateKnowledgeBaseAction"}],"discriminator":{"propertyName":"type","mapping":{"mcp":"#/components/schemas/CreateMCPAction","google.sheets.row.append":"#/components/schemas/CreateGoogleSheetsRowAppendAction","transfer_call":"#/components/schemas/CreateTransferCallAction","transfer_chat_respondio":"#/components/schemas/CreateTransferChatRespondioAction","api_call":"#/components/schemas/CreateApiCallAction","knowledge_base":"#/components/schemas/CreateKnowledgeBaseAction"}},"title":"Data"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/MCPActionSchema"},{"$ref":"#/components/schemas/GoogleSheetsActionSchema"},{"$ref":"#/components/schemas/TransferCallActionSchema"},{"$ref":"#/components/schemas/TransferChatRespondioActionSchema"},{"$ref":"#/components/schemas/ApiCallActionSchema"},{"$ref":"#/components/schemas/KnowledgeBaseActionSchema"}],"discriminator":{"propertyName":"type","mapping":{"mcp":"#/components/schemas/MCPActionSchema","google.sheets.row.append":"#/components/schemas/GoogleSheetsActionSchema","transfer_call":"#/components/schemas/TransferCallActionSchema","transfer_chat_respondio":"#/components/schemas/TransferChatRespondioActionSchema","api_call":"#/components/schemas/ApiCallActionSchema","knowledge_base":"#/components/schemas/KnowledgeBaseActionSchema"}},"title":"Response Create Action Api V1 Actions Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Actions"],"summary":"List Custom Actions","description":"List all custom actions for the organization.\n\n### Required scopes:\n- `actions:read`: Read actions / tools\n\n- `actions:write`: Modify actions / tools\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"list_actions_api_v1_actions_get","security":[{"api_key":["actions:read","actions:write","organization:admin","organization:read"]},{"session_key":["actions:read","actions:write","organization:admin","organization:read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__pagenation__ListResource[]"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/actions/lookup":{"get":{"tags":["Actions"],"summary":"Lookup Custom Actions","description":"Get minimal cusotm actions data for ui and dropdowns\n\n### Required scopes:\n- `actions:read`: Read actions / tools\n\n- `actions:write`: Modify actions / tools\n\n- `call_flows:read`: Read conversation flows\n\n- `call_flows:write`: Modify conversation flows\n\n- `campaigns:read`: Read campaigns\n\n- `campaigns:write`: Modify campaigns\n\n- `inbound_configs:read`: Read inbound configs / agents\n\n- `inbound_configs:write`: Modify inbound configs / agents\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"lookup_inbound_configs_api_v1_actions_lookup_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CustomActionLookupSchema"},"type":"array","title":"Response Lookup Inbound Configs Api V1 Actions Lookup Get"}}}}},"security":[{"api_key":["actions:read","actions:write","call_flows:read","call_flows:write","campaigns:read","campaigns:write","inbound_configs:read","inbound_configs:write","organization:admin","organization:read"]},{"session_key":["actions:read","actions:write","call_flows:read","call_flows:write","campaigns:read","campaigns:write","inbound_configs:read","inbound_configs:write","organization:admin","organization:read"]}]}},"/api/v1/actions/{id}":{"get":{"tags":["Actions"],"summary":"Get Custom Action","description":"Get a single custom action by ID.\n\n### Required scopes:\n- `actions:read`: Read actions / tools\n\n- `actions:write`: Modify actions / tools\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"get_action_api_v1_actions__id__get","security":[{"api_key":["actions:read","actions:write","organization:admin","organization:read"]},{"session_key":["actions:read","actions:write","organization:admin","organization:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The action ID.","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/MCPActionSchema"},{"$ref":"#/components/schemas/GoogleSheetsActionSchema"},{"$ref":"#/components/schemas/TransferCallActionSchema"},{"$ref":"#/components/schemas/TransferChatRespondioActionSchema"},{"$ref":"#/components/schemas/ApiCallActionSchema"},{"$ref":"#/components/schemas/KnowledgeBaseActionSchema"}],"discriminator":{"propertyName":"type","mapping":{"mcp":"#/components/schemas/MCPActionSchema","google.sheets.row.append":"#/components/schemas/GoogleSheetsActionSchema","transfer_call":"#/components/schemas/TransferCallActionSchema","transfer_chat_respondio":"#/components/schemas/TransferChatRespondioActionSchema","api_call":"#/components/schemas/ApiCallActionSchema","knowledge_base":"#/components/schemas/KnowledgeBaseActionSchema"}},"title":"Response Get Action Api V1 Actions  Id  Get"}}}},"404":{"description":"Action not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Actions"],"summary":"Update Custom Action","description":"Update a custom action.\n\n### Required scopes:\n- `actions:write`: Modify actions / tools\n\n- `organization:admin`: Modify your organization","operationId":"update_action_api_v1_actions__id__put","security":[{"api_key":["actions:write","organization:admin"]},{"session_key":["actions:write","organization:admin"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The action ID.","title":"Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreateMCPAction"},{"$ref":"#/components/schemas/CreateGoogleSheetsRowAppendAction"},{"$ref":"#/components/schemas/CreateTransferCallAction"},{"$ref":"#/components/schemas/CreateTransferChatRespondioAction"},{"$ref":"#/components/schemas/CreateApiCallAction"},{"$ref":"#/components/schemas/CreateKnowledgeBaseAction"}],"discriminator":{"propertyName":"type","mapping":{"mcp":"#/components/schemas/CreateMCPAction","google.sheets.row.append":"#/components/schemas/CreateGoogleSheetsRowAppendAction","transfer_call":"#/components/schemas/CreateTransferCallAction","transfer_chat_respondio":"#/components/schemas/CreateTransferChatRespondioAction","api_call":"#/components/schemas/CreateApiCallAction","knowledge_base":"#/components/schemas/CreateKnowledgeBaseAction"}},"title":"Data"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/MCPActionSchema"},{"$ref":"#/components/schemas/GoogleSheetsActionSchema"},{"$ref":"#/components/schemas/TransferCallActionSchema"},{"$ref":"#/components/schemas/TransferChatRespondioActionSchema"},{"$ref":"#/components/schemas/ApiCallActionSchema"},{"$ref":"#/components/schemas/KnowledgeBaseActionSchema"}],"discriminator":{"propertyName":"type","mapping":{"mcp":"#/components/schemas/MCPActionSchema","google.sheets.row.append":"#/components/schemas/GoogleSheetsActionSchema","transfer_call":"#/components/schemas/TransferCallActionSchema","transfer_chat_respondio":"#/components/schemas/TransferChatRespondioActionSchema","api_call":"#/components/schemas/ApiCallActionSchema","knowledge_base":"#/components/schemas/KnowledgeBaseActionSchema"}},"title":"Response Update Action Api V1 Actions  Id  Put"}}}},"404":{"description":"Action not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Actions"],"summary":"Delete Custom Action","description":"Delete a custom action.\n\n### Required scopes:\n- `actions:write`: Modify actions / tools\n\n- `organization:admin`: Modify your organization","operationId":"delete_action_api_v1_actions__id__delete","security":[{"api_key":["actions:write","organization:admin"]},{"session_key":["actions:write","organization:admin"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The action ID.","title":"Id"}}],"responses":{"204":{"description":"Successful Response"},"404":{"description":"Action not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/actions/{id}/mcp-tools":{"get":{"tags":["Actions"],"summary":"Get MCP Tools","description":"Get list of tools exposed by an MCP server.\n\nThis endpoint fetches the available tools from an MCP action.\nIt handles authentication via x-mawj-secret header if webhookSecret is configured.\n\n### Required scopes:\n- `actions:read`: Read actions / tools\n\n- `actions:write`: Modify actions / tools\n\n- `call_flows:read`: Read conversation flows\n\n- `call_flows:write`: Modify conversation flows\n\n- `campaigns:read`: Read campaigns\n\n- `campaigns:write`: Modify campaigns\n\n- `inbound_configs:read`: Read inbound configs / agents\n\n- `inbound_configs:write`: Modify inbound configs / agents\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"get_mcp_tools_api_v1_actions__id__mcp_tools_get","security":[{"api_key":["actions:read","actions:write","call_flows:read","call_flows:write","campaigns:read","campaigns:write","inbound_configs:read","inbound_configs:write","organization:admin","organization:read"]},{"session_key":["actions:read","actions:write","call_flows:read","call_flows:write","campaigns:read","campaigns:write","inbound_configs:read","inbound_configs:write","organization:admin","organization:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The action ID.","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MCPToolsListResponse"}}}},"404":{"description":"Action not found"},"400":{"description":"Not an MCP action or failed to fetch tools"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/structured-outputs":{"get":{"tags":["Structured Outputs"],"summary":"List Structured Outputs","description":"List Structured Ouputs.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `reporting_insights:read`: Read insights and boards\n\n- `structured_outputs:read`: Read structured outputs\n\n- `structured_outputs:write`: Create and modify structured outputs","operationId":"list_all_api_v1_structured_outputs_get","security":[{"api_key":["organization:admin","organization:read","reporting_insights:read","structured_outputs:read","structured_outputs:write"]},{"session_key":["organization:admin","organization:read","reporting_insights:read","structured_outputs:read","structured_outputs:write"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResource_StructuredOutput_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Structured Outputs"],"summary":"Create Structured Output","operationId":"create_api_v1_structured_outputs_post","security":[{"api_key":["organization:admin","structured_outputs:write"]},{"session_key":["organization:admin","structured_outputs:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredOutputCreate"}}}},"responses":{"201":{"description":"Structured Output created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredOutput"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `structured_outputs:write`: Create and modify structured outputs"}},"/api/v1/structured-outputs/{id}":{"get":{"tags":["Structured Outputs"],"summary":"Get Structured Output","description":"Get a Structured Output by ID.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `reporting_insights:read`: Read insights and boards\n\n- `structured_outputs:read`: Read structured outputs\n\n- `structured_outputs:write`: Create and modify structured outputs","operationId":"get_api_v1_structured_outputs__id__get","security":[{"api_key":["organization:admin","organization:read","reporting_insights:read","structured_outputs:read","structured_outputs:write"]},{"session_key":["organization:admin","organization:read","reporting_insights:read","structured_outputs:read","structured_outputs:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The structured output ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/structured-outputs","resourceName":"Structured Output","displayProperty":"name"},"title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredOutput"}}}},"404":{"description":"Structured Output not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__NotFoundError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Structured Outputs"],"summary":"Update Structured Output","description":"Update a Structured Output by ID.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `structured_outputs:write`: Create and modify structured outputs","operationId":"patch_api_v1_structured_outputs__id__patch","security":[{"api_key":["organization:admin","structured_outputs:write"]},{"session_key":["organization:admin","structured_outputs:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The structured output ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/structured-outputs","resourceName":"Structured Output","displayProperty":"name"},"title":"Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredOutputUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredOutput"}}}},"404":{"description":"Structured Output not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__NotFoundError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Structured Outputs"],"summary":"Delete Structured Output","description":"Delete a Structured Output.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `structured_outputs:write`: Create and modify structured outputs","operationId":"delete_structured_output_api_v1_structured_outputs__id__delete","security":[{"api_key":["organization:admin","structured_outputs:write"]},{"session_key":["organization:admin","structured_outputs:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The structured output ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/structured-outputs","resourceName":"Structured Output","displayProperty":"name"},"title":"Id"}}],"responses":{"204":{"description":"Structured Output deleted."},"404":{"description":"Structured Output not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__NotFoundError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/structured-outputs/{id}/metric":{"get":{"tags":["Structured Outputs"],"summary":"Get Structured Output Metric","operationId":"metric_api_v1_structured_outputs__id__metric_get","security":[{"api_key":["organization:admin","organization:read","reporting_insights:read","structured_outputs:read","structured_outputs:write"]},{"session_key":["organization:admin","organization:read","reporting_insights:read","structured_outputs:read","structured_outputs:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The structured output ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/structured-outputs","resourceName":"Structured Output","displayProperty":"name"},"title":"Id"}},{"name":"start_timestamp","in":"query","required":true,"schema":{"type":"string","format":"date-time","description":"Start timestamp.","title":"Start Timestamp"},"description":"Start timestamp."},{"name":"end_timestamp","in":"query","required":true,"schema":{"type":"string","format":"date-time","description":"End timestamp.","title":"End Timestamp"},"description":"End timestamp."},{"name":"aggregation_function","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/AggregationFunction"},{"type":"null"}],"description":"If set, will first compute the quantities per customer before aggregating them using the given function. If not set, the quantities will be aggregated across all events.","title":"Aggregation Function"},"description":"If set, will first compute the quantities per customer before aggregating them using the given function. If not set, the quantities will be aggregated across all events."},{"name":"interval","in":"query","required":true,"schema":{"$ref":"#/components/schemas/TimeInterval","description":"Interval between two timestamps."},"description":"Interval between two timestamps."},{"name":"agent_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"array","items":{"type":"string","format":"uuid4"}},{"type":"null"}],"title":"AgentID Filter","description":"Filter by agent ID."},"description":"Filter by agent ID."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricQuantities"}}}},"404":{"description":"Structured Output not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__NotFoundError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `reporting_insights:read`: Read insights and boards\n\n- `structured_outputs:read`: Read structured outputs\n\n- `structured_outputs:write`: Create and modify structured outputs"}},"/api/v1/structured-outputs/{id}/results":{"get":{"tags":["Structured Outputs"],"summary":"Get Structured Output Results","operationId":"structured_output_results_api_v1_structured_outputs__id__results_get","security":[{"api_key":["organization:admin","organization:read","reporting_insights:read","structured_outputs:read","structured_outputs:write"]},{"session_key":["organization:admin","organization:read","reporting_insights:read","structured_outputs:read","structured_outputs:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The structured output ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/structured-outputs","resourceName":"Structured Output","displayProperty":"name"},"title":"Id"}},{"name":"start_timestamp","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Start timestamp.","title":"Start Timestamp"},"description":"Start timestamp."},{"name":"end_timestamp","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"End timestamp.","title":"End Timestamp"},"description":"End timestamp."},{"name":"conversation_id","in":"query","required":false,"schema":{"type":"string","format":"uuid","description":"Filter by specific conversation id","title":"Conversation Id"},"description":"Filter by specific conversation id"},{"name":"call_id","in":"query","required":false,"schema":{"type":"string","format":"uuid","description":"Filter by specific conversation id. Deprecated: Use `conversation_id` instead","deprecated":true,"title":"Call Id"},"description":"Filter by specific conversation id. Deprecated: Use `conversation_id` instead","deprecated":true},{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResource_StructuredOutputResultSchema_"}}}},"404":{"description":"Structured Output not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__NotFoundError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `reporting_insights:read`: Read insights and boards\n\n- `structured_outputs:read`: Read structured outputs\n\n- `structured_outputs:write`: Create and modify structured outputs"}},"/api/v1/inbound-configs/lookup":{"get":{"tags":["Inbound Configs"],"summary":"Lookup Inbound Configs for Dropdowns","description":"Get minimal inbound config data (id, name) for dropdowns, optimized for UI selection\n\n### Required scopes:\n- `actions:read`: Read actions / tools\n\n- `actions:write`: Modify actions / tools\n\n- `calls:read`: Read calls\n\n- `campaigns:read`: Read campaigns\n\n- `campaigns:write`: Modify campaigns\n\n- `evals:read`: Read evals\n\n- `evals:write`: Create and modify evals\n\n- `inbound_configs:read`: Read inbound configs / agents\n\n- `inbound_configs:write`: Modify inbound configs / agents\n\n- `knowledge_bases:read`: Read knowledge bases\n\n- `knowledge_bases:write`: Create and modify knowledge bases\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `phone_numbers:read`: Read phone numbers\n\n- `phone_numbers:write`: Create and modify phone numbers\n\n- `reporting_analytics:read`: Read analytics\n\n- `reporting_analytics:write`: Modify analytics\n\n- `reporting_improvements:read`: Read improvements\n\n- `reporting_improvements:write`: Modify improvements\n\n- `reporting_insights:read`: Read insights and boards\n\n- `reporting_insights:write`: Modify insights and boards\n\n- `structured_outputs:read`: Read structured outputs\n\n- `structured_outputs:write`: Create and modify structured outputs","operationId":"lookup_inbound_configs_api_v1_inbound_configs_lookup_get","security":[{"api_key":["actions:read","actions:write","calls:read","campaigns:read","campaigns:write","evals:read","evals:write","inbound_configs:read","inbound_configs:write","knowledge_bases:read","knowledge_bases:write","organization:admin","organization:read","phone_numbers:read","phone_numbers:write","reporting_analytics:read","reporting_analytics:write","reporting_improvements:read","reporting_improvements:write","reporting_insights:read","reporting_insights:write","structured_outputs:read","structured_outputs:write"]},{"session_key":["actions:read","actions:write","calls:read","campaigns:read","campaigns:write","evals:read","evals:write","inbound_configs:read","inbound_configs:write","knowledge_bases:read","knowledge_bases:write","organization:admin","organization:read","phone_numbers:read","phone_numbers:write","reporting_analytics:read","reporting_analytics:write","reporting_improvements:read","reporting_improvements:write","reporting_insights:read","reporting_insights:write","structured_outputs:read","structured_outputs:write"]}],"parameters":[{"name":"include_calls_count","in":"query","required":false,"schema":{"type":"boolean","description":"Include agent calls count in response","default":false,"title":"Include Calls Count"},"description":"Include agent calls count in response"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InboundConfigLookupSchema"},"title":"Response Lookup Inbound Configs Api V1 Inbound Configs Lookup Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/knowledge-base":{"post":{"tags":["Knowledge Base"],"summary":"Create Knowledge Base","description":"Create a new knowledge base entry from file or text.\n\n### Required scopes:\n- `knowledge_bases:write`: Create and modify knowledge bases\n\n- `organization:admin`: Modify your organization","operationId":"create_knowledge_base_api_v1_knowledge_base_post","security":[{"api_key":["knowledge_bases:write","organization:admin"]},{"session_key":["knowledge_bases:write","organization:admin"]}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_create_knowledge_base_api_v1_knowledge_base_post"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Knowledge Base"],"summary":"List Knowledge Bases","description":"List all knowledge base entries for the organization\n\n### Required scopes:\n- `knowledge_bases:read`: Read knowledge bases\n\n- `knowledge_bases:write`: Create and modify knowledge bases\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"list_knowledge_bases_api_v1_knowledge_base_get","security":[{"api_key":["knowledge_bases:read","knowledge_bases:write","organization:admin","organization:read"]},{"session_key":["knowledge_bases:read","knowledge_bases:write","organization:admin","organization:read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResource_KnowledgeBaseSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/knowledge-base/auto-structure":{"post":{"tags":["Knowledge Base"],"summary":"Auto-Structure Knowledge Bases","description":"Uses AI to analyze the provided content and produce one or more well-structured knowledge bases, each with a generated name, description, and content.\n\n### Required scopes:\n- `knowledge_bases:write`: Create and modify knowledge bases\n\n- `organization:admin`: Modify your organization","operationId":"auto_structure_knowledge_base_api_v1_knowledge_base_auto_structure_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_auto_structure_knowledge_base_api_v1_knowledge_base_auto_structure_post"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoStructureResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"api_key":["knowledge_bases:write","organization:admin"]},{"session_key":["knowledge_bases:write","organization:admin"]}]}},"/api/v1/knowledge-base/lookup":{"get":{"tags":["Knowledge Base"],"summary":"Lookup Knowledge Bases","description":"Get minimal kbs data for ui and dropdowns\n\n### Required scopes:\n- `call_flows:read`: Read conversation flows\n\n- `call_flows:write`: Modify conversation flows\n\n- `campaigns:read`: Read campaigns\n\n- `campaigns:write`: Modify campaigns\n\n- `inbound_configs:read`: Read inbound configs / agents\n\n- `inbound_configs:write`: Modify inbound configs / agents\n\n- `knowledge_bases:read`: Read knowledge bases\n\n- `knowledge_bases:write`: Create and modify knowledge bases\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"lookup_knowledge_bases_api_v1_knowledge_base_lookup_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/KnowledgeBaseLookupSchema"},"type":"array","title":"Response Lookup Knowledge Bases Api V1 Knowledge Base Lookup Get"}}}}},"security":[{"api_key":["call_flows:read","call_flows:write","campaigns:read","campaigns:write","inbound_configs:read","inbound_configs:write","knowledge_bases:read","knowledge_bases:write","organization:admin","organization:read"]},{"session_key":["call_flows:read","call_flows:write","campaigns:read","campaigns:write","inbound_configs:read","inbound_configs:write","knowledge_bases:read","knowledge_bases:write","organization:admin","organization:read"]}]}},"/api/v1/knowledge-base/{id}":{"get":{"tags":["Knowledge Base"],"summary":"Get Knowledge Base Entry","description":"Get a single knowledge base entry by ID\n\n### Required scopes:\n- `knowledge_bases:read`: Read knowledge bases\n\n- `knowledge_bases:write`: Create and modify knowledge bases\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"get_knowledge_base_api_v1_knowledge_base__id__get","security":[{"api_key":["knowledge_bases:read","knowledge_bases:write","organization:admin","organization:read"]},{"session_key":["knowledge_bases:read","knowledge_bases:write","organization:admin","organization:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Knowledge Base"],"summary":"Update Knowledge Base Entry","description":"Update a knowledge base entry. If setting use_as_tool to true, description must have more than 1 character.\n\n### Required scopes:\n- `knowledge_bases:write`: Create and modify knowledge bases\n\n- `organization:admin`: Modify your organization","operationId":"update_knowledge_base_api_v1_knowledge_base__id__patch","security":[{"api_key":["knowledge_bases:write","organization:admin"]},{"session_key":["knowledge_bases:write","organization:admin"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateKnowledgeBase"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Knowledge Base"],"summary":"Delete Knowledge Base Entry","description":"Delete a knowledge base entry\n\n### Required scopes:\n- `knowledge_bases:write`: Create and modify knowledge bases\n\n- `organization:admin`: Modify your organization","operationId":"delete_knowledge_base_api_v1_knowledge_base__id__delete","security":[{"api_key":["knowledge_bases:write","organization:admin"]},{"session_key":["knowledge_bases:write","organization:admin"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/outbound-calls":{"get":{"tags":["Outbound Calls"],"summary":"List Outbound Calls","description":"List outbound calls.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `outbound_calls:read`: Read outbound calls\n\n- `outbound_calls:write`: Create and modify outbound calls","operationId":"list_api_v1_outbound_calls_get","security":[{"api_key":["organization:admin","organization:read","outbound_calls:read","outbound_calls:write"]},{"session_key":["organization:admin","organization:read","outbound_calls:read","outbound_calls:write"]}],"parameters":[{"name":"campaign_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Filter results by campaign id","title":"Campaign Id"},"description":"Filter results by campaign id"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResource_OutboundCallWithCampaignSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Outbound Calls"],"summary":"Create Outbound Call","operationId":"create_api_v1_outbound_calls_post","security":[{"api_key":["organization:admin","outbound_calls:write"]},{"session_key":["organization:admin","outbound_calls:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOutboundCallRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOutboundCallResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `outbound_calls:write`: Create and modify outbound calls"}},"/api/v1/outbound-calls/{id}":{"get":{"tags":["Outbound Calls"],"summary":"Get Outbound Call","description":"Get an outbound call by ID.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `outbound_calls:read`: Read outbound calls\n\n- `outbound_calls:write`: Create and modify outbound calls","operationId":"get_api_v1_outbound_calls__id__get","security":[{"api_key":["organization:admin","organization:read","outbound_calls:read","outbound_calls:write"]},{"session_key":["organization:admin","organization:read","outbound_calls:read","outbound_calls:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The outbound call ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/outbound-calls","resourceName":"OutboundCall","displayProperty":"name"},"title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutboundCallWithCampaignSchema"}}}},"404":{"description":"Outbound call not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__NotFoundError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/outbound-calls/bulk":{"post":{"tags":["Outbound Calls"],"summary":"Create Outbound Calls in Bulk","operationId":"create_bulk_api_v1_outbound_calls_bulk_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBulkOutboundCallRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBulkOutboundCallResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"api_key":["organization:admin","outbound_calls:write"]},{"session_key":["organization:admin","outbound_calls:write"]}],"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `outbound_calls:write`: Create and modify outbound calls"}},"/api/v1/outbound-calls/{id}/cancel":{"put":{"tags":["Outbound Calls"],"summary":"Mark Outbound Call for Cancellation","operationId":"cancel_outbound_call_api_v1_outbound_calls__id__cancel_put","security":[{"api_key":["organization:admin","outbound_calls:write"]},{"session_key":["organization:admin","outbound_calls:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOutboundCallResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `outbound_calls:write`: Create and modify outbound calls"}},"/api/v1/phone-numbers":{"get":{"tags":["Phone Numbers"],"summary":"List Organization Phone Numbers","operationId":"list_phone_numbers_api_v1_phone_numbers_get","security":[{"api_key":["organization:admin","organization:read","phone_numbers:read","phone_numbers:write"]},{"session_key":["organization:admin","organization:read","phone_numbers:read","phone_numbers:write"]}],"parameters":[{"name":"outbound_only","in":"query","required":false,"schema":{"type":"boolean","description":"Include outbound supported phone numbers only","default":false,"title":"Outbound Only"},"description":"Include outbound supported phone numbers only"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPhoneNumbersResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `phone_numbers:read`: Read phone numbers\n\n- `phone_numbers:write`: Create and modify phone numbers"},"post":{"tags":["Phone Numbers"],"summary":"Create Phone Number","operationId":"create_phone_number_api_v1_phone_numbers_post","security":[{"api_key":["organization:admin","phone_numbers:write"]},{"session_key":["organization:admin","phone_numbers:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreateMawjPhoneNumber"},{"$ref":"#/components/schemas/CreateSipRegisterPhoneNumber"},{"$ref":"#/components/schemas/CreateMaqsamPhoneNumber"},{"$ref":"#/components/schemas/CreateLiveKitPhoneNumber"}],"discriminator":{"propertyName":"type","mapping":{"mawj":"#/components/schemas/CreateMawjPhoneNumber","sip_register":"#/components/schemas/CreateSipRegisterPhoneNumber","maqsam":"#/components/schemas/CreateMaqsamPhoneNumber","livekit":"#/components/schemas/CreateLiveKitPhoneNumber"}},"title":"Data"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"boolean"},"title":"Response Create Phone Number Api V1 Phone Numbers Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `phone_numbers:write`: Create and modify phone numbers"}},"/api/v1/phone-numbers/lookup":{"get":{"tags":["Phone Numbers"],"summary":"Lookup Phone Numbers for Dropdowns","description":"Get minimal phone numbers data (id, name).\n\n### Required scopes:\n- `calls:read`: Read calls\n\n- `campaigns:read`: Read campaigns\n\n- `campaigns:write`: Modify campaigns\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `phone_numbers:read`: Read phone numbers\n\n- `phone_numbers:write`: Create and modify phone numbers","operationId":"lookup_phone_numbers_api_v1_phone_numbers_lookup_get","security":[{"api_key":["calls:read","campaigns:read","campaigns:write","organization:admin","organization:read","phone_numbers:read","phone_numbers:write"]},{"session_key":["calls:read","campaigns:read","campaigns:write","organization:admin","organization:read","phone_numbers:read","phone_numbers:write"]}],"parameters":[{"name":"outbound_only","in":"query","required":false,"schema":{"type":"boolean","description":"Include outbound supported phone numbers only","default":false,"title":"Outbound Only"},"description":"Include outbound supported phone numbers only"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberLookupSchema"},"title":"Response Lookup Phone Numbers Api V1 Phone Numbers Lookup Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/phone-numbers/{id}":{"get":{"tags":["Phone Numbers"],"summary":"Get Phone Number by ID","operationId":"get_phone_number_api_v1_phone_numbers__id__get","security":[{"api_key":["organization:admin","organization:read","phone_numbers:read","phone_numbers:write"]},{"session_key":["organization:admin","organization:read","phone_numbers:read","phone_numbers:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/MawjPhoneNumber"},{"$ref":"#/components/schemas/SipRegisterPhoneNumber"},{"$ref":"#/components/schemas/MaqsamPhoneNumber"},{"$ref":"#/components/schemas/LiveKitPhoneNumber"}],"discriminator":{"propertyName":"type","mapping":{"mawj":"#/components/schemas/MawjPhoneNumber","sip_register":"#/components/schemas/SipRegisterPhoneNumber","maqsam":"#/components/schemas/MaqsamPhoneNumber","livekit":"#/components/schemas/LiveKitPhoneNumber"}},"title":"Response Get Phone Number Api V1 Phone Numbers  Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `phone_numbers:read`: Read phone numbers\n\n- `phone_numbers:write`: Create and modify phone numbers"},"put":{"tags":["Phone Numbers"],"summary":"Update Phone Number","operationId":"update_phone_number_api_v1_phone_numbers__id__put","security":[{"api_key":["organization:admin","phone_numbers:write"]},{"session_key":["organization:admin","phone_numbers:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreateMawjPhoneNumber"},{"$ref":"#/components/schemas/UpdateSipRegisterPhoneNumber"},{"$ref":"#/components/schemas/CreateMaqsamPhoneNumber"},{"$ref":"#/components/schemas/CreateLiveKitPhoneNumber"}],"discriminator":{"propertyName":"type","mapping":{"mawj":"#/components/schemas/CreateMawjPhoneNumber","sip_register":"#/components/schemas/UpdateSipRegisterPhoneNumber","maqsam":"#/components/schemas/CreateMaqsamPhoneNumber","livekit":"#/components/schemas/CreateLiveKitPhoneNumber"}},"title":"Data"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"boolean"},"title":"Response Update Phone Number Api V1 Phone Numbers  Id  Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `phone_numbers:write`: Create and modify phone numbers"},"delete":{"tags":["Phone Numbers"],"summary":"Delete Phone Number","operationId":"delete_phone_number_api_v1_phone_numbers__id__delete","security":[{"api_key":["organization:admin","phone_numbers:write"]},{"session_key":["organization:admin","phone_numbers:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"boolean"},"title":"Response Delete Phone Number Api V1 Phone Numbers  Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `phone_numbers:write`: Create and modify phone numbers"}},"/api/v1/calls":{"get":{"tags":["Calls"],"summary":"List Calls","description":"List calls with optional filters.\n\n### Required scopes:\n- `calls:read`: Read calls\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"list_api_v1_calls_get","deprecated":true,"security":[{"api_key":["calls:read","organization:admin","organization:read"]},{"session_key":["calls:read","organization:admin","organization:read"]}],"parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ConversationStatus"},{"type":"array","items":{"$ref":"#/components/schemas/ConversationStatus"}},{"type":"null"}],"description":"Filter by call status (supports multiple values)","title":"Status"},"description":"Filter by call status (supports multiple values)"},{"name":"phone_number_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"array","items":{"type":"string","format":"uuid4"}},{"type":"null"}],"description":"Filter by phone number ID (supports multiple values)","title":"Phone Number Id"},"description":"Filter by phone number ID (supports multiple values)"},{"name":"agent_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"array","items":{"type":"string","format":"uuid4"}},{"type":"null"}],"description":"Filter by agent ID (supports multiple values)","title":"Agent Id"},"description":"Filter by agent ID (supports multiple values)"},{"name":"call_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"description":"Filter by specific call ID","title":"Call Id"},"description":"Filter by specific call ID"},{"name":"from_number","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by from number","title":"From Number"},"description":"Filter by from number"},{"name":"to_number","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by to number","title":"To Number"},"description":"Filter by to number"},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter calls starting from this date","title":"Start Date"},"description":"Filter calls starting from this date"},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter calls up to this date","title":"End Date"},"description":"Filter calls up to this date"},{"name":"min_duration","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Minimum duration in seconds","title":"Min Duration"},"description":"Minimum duration in seconds"},{"name":"max_duration","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Maximum duration in seconds","title":"Max Duration"},"description":"Maximum duration in seconds"},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/CallType"},{"type":"null"}],"description":"Call type to fetch. By default inbound and outbound calls are fetched.","title":"Type"},"description":"Call type to fetch. By default inbound and outbound calls are fetched."},{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResource_Call_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/calls/list":{"post":{"tags":["Calls"],"summary":"List Calls (Advanced)","description":"List calls with advanced filtering.\n\n### Required scopes:\n- `calls:read`: Read calls\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"list_post_api_v1_calls_list_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallListRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResource_Call_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"api_key":["calls:read","organization:admin","organization:read"]},{"session_key":["calls:read","organization:admin","organization:read"]}]}},"/api/v1/calls/export-csv":{"post":{"tags":["Calls"],"summary":"Export Calls To CSV","description":"Export filtered calls to CSV.\n\n### Required scopes:\n- `calls:read`: Read calls\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"export_calls_to_csv_api_v1_calls_export_csv_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallListExportCsvRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallListExportCsvResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"api_key":["calls:read","organization:admin","organization:read"]},{"session_key":["calls:read","organization:admin","organization:read"]}]}},"/api/v1/calls/{id}":{"get":{"tags":["Calls"],"summary":"Get Call","description":"Get a call by ID.\n\n### Required scopes:\n- `calls:read`: Read calls\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"get_api_v1_calls__id__get","security":[{"api_key":["calls:read","organization:admin","organization:read"]},{"session_key":["calls:read","organization:admin","organization:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The call ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/calls","resourceName":"Call","displayProperty":"name"},"title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Call"}}}},"404":{"description":"Call not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__NotFoundError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/calls/{id}/structured-outputs":{"get":{"tags":["Calls"],"summary":"List Call Structured Outputs","operationId":"list_structured_outputs_api_v1_calls__id__structured_outputs_get","security":[{"api_key":["calls:read","organization:admin","organization:read"]},{"session_key":["calls:read","organization:admin","organization:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The call ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/calls","resourceName":"Call","displayProperty":"name"},"title":"Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResource_CallStructuredOutputResult_"}}}},"404":{"description":"Call not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__NotFoundError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `calls:read`: Read calls\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization"}},"/api/v1/call-flows":{"get":{"tags":["Call Flows"],"summary":"List Call Flows","description":"List call flows.\n\n### Required scopes:\n- `call_flows:read`: Read conversation flows\n\n- `call_flows:write`: Modify conversation flows\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"list_api_v1_call_flows_get","security":[{"api_key":["call_flows:read","call_flows:write","organization:admin","organization:read"]},{"session_key":["call_flows:read","call_flows:write","organization:admin","organization:read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__pagenation__ListResource[]"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Call Flows"],"summary":"Create Call Flow","operationId":"create_api_v1_call_flows_post","security":[{"api_key":["call_flows:write","organization:admin"]},{"session_key":["call_flows:write","organization:admin"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreateCallFlowV1"},{"$ref":"#/components/schemas/CreateCallFlowV2"}],"discriminator":{"propertyName":"version","mapping":{"1":"#/components/schemas/CreateCallFlowV1","2":"#/components/schemas/CreateCallFlowV2"}},"title":"Data"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CallFlowV1"},{"$ref":"#/components/schemas/CallFlowV2"}],"discriminator":{"propertyName":"version","mapping":{"1":"#/components/schemas/CallFlowV1","2":"#/components/schemas/CallFlowV2"}},"title":"Response Create Api V1 Call Flows Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `call_flows:write`: Modify conversation flows\n\n- `organization:admin`: Modify your organization"}},"/api/v1/call-flows/{id}":{"get":{"tags":["Call Flows"],"summary":"Get Call flow","description":"Get a call flow by ID.\n\n### Required scopes:\n- `call_flows:read`: Read conversation flows\n\n- `call_flows:write`: Modify conversation flows\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"get_api_v1_call_flows__id__get","security":[{"api_key":["call_flows:read","call_flows:write","organization:admin","organization:read"]},{"session_key":["call_flows:read","call_flows:write","organization:admin","organization:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The call flow ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/call-flows","resourceName":"Call Flow","displayProperty":"name"},"title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CallFlowV1"},{"$ref":"#/components/schemas/CallFlowV2"}],"discriminator":{"propertyName":"version","mapping":{"1":"#/components/schemas/CallFlowV1","2":"#/components/schemas/CallFlowV2"}},"title":"Response Get Api V1 Call Flows  Id  Get"}}}},"404":{"description":"Call flow not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__NotFoundError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Call Flows"],"summary":"Update Call Flow","operationId":"update_api_v1_call_flows__id__put","security":[{"api_key":["call_flows:write","organization:admin"]},{"session_key":["call_flows:write","organization:admin"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The call flow ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/call-flows","resourceName":"Call Flow","displayProperty":"name"},"title":"Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UpdateCallFlowV1"},{"$ref":"#/components/schemas/UpdateCallFlowV2"}],"discriminator":{"propertyName":"version","mapping":{"1":"#/components/schemas/UpdateCallFlowV1","2":"#/components/schemas/UpdateCallFlowV2"}},"title":"Data"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CallFlowV1"},{"$ref":"#/components/schemas/CallFlowV2"}],"discriminator":{"propertyName":"version","mapping":{"1":"#/components/schemas/CallFlowV1","2":"#/components/schemas/CallFlowV2"}},"title":"Response Update Api V1 Call Flows  Id  Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `call_flows:write`: Modify conversation flows\n\n- `organization:admin`: Modify your organization"},"delete":{"tags":["Call Flows"],"summary":"Delete","description":"Delete a webhook endpoint.\n\n### Required scopes:\n- `call_flows:write`: Modify conversation flows\n\n- `organization:admin`: Modify your organization","operationId":"delete_api_v1_call_flows__id__delete","security":[{"api_key":["call_flows:write","organization:admin"]},{"session_key":["call_flows:write","organization:admin"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The call flow ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/call-flows","resourceName":"Call Flow","displayProperty":"name"},"title":"Id"}}],"responses":{"204":{"description":"Call flow endpoint deleted."},"404":{"description":"Call flow not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__NotFoundError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/webhooks/endpoints":{"get":{"tags":["Webhooks"],"summary":"List Webhook Endpoints","description":"List webhook endpoints.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `webhooks:read`: Read webhooks\n\n- `webhooks:write`: Create and modify webhooks","operationId":"list_webhook_endpoints_api_v1_webhooks_endpoints_get","security":[{"api_key":["organization:admin","organization:read","webhooks:read","webhooks:write"]},{"session_key":["organization:admin","organization:read","webhooks:read","webhooks:write"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResource_WebhookEndpoint_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Webhooks"],"summary":"Create Webhook Endpoint","description":"Create a webhook endpoint.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `webhooks:write`: Create and modify webhooks","operationId":"create_webhook_endpoint_api_v1_webhooks_endpoints_post","security":[{"api_key":["organization:admin","webhooks:write"]},{"session_key":["organization:admin","webhooks:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpointCreate"}}}},"responses":{"201":{"description":"Webhook endpoint created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpoint"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/webhooks/endpoints/{id}":{"get":{"tags":["Webhooks"],"summary":"Get Webhook Endpoint","description":"Get a webhook endpoint by ID.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `webhooks:read`: Read webhooks\n\n- `webhooks:write`: Create and modify webhooks","operationId":"get_webhook_endpoint_api_v1_webhooks_endpoints__id__get","security":[{"api_key":["organization:admin","organization:read","webhooks:read","webhooks:write"]},{"session_key":["organization:admin","organization:read","webhooks:read","webhooks:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The webhook endpoint ID.","title":"Id"},"description":"The webhook endpoint ID."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpoint"}}}},"404":{"description":"Webhook endpoint not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__NotFoundError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Webhooks"],"summary":"Update Webhook Endpoint","description":"Update a webhook endpoint.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `webhooks:write`: Create and modify webhooks","operationId":"update_webhook_endpoint_api_v1_webhooks_endpoints__id__patch","security":[{"api_key":["organization:admin","webhooks:write"]},{"session_key":["organization:admin","webhooks:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The webhook endpoint ID.","title":"Id"},"description":"The webhook endpoint ID."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpointUpdate"}}}},"responses":{"200":{"description":"Webhook endpoint updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpoint"}}}},"404":{"description":"Webhook endpoint not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__NotFoundError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Webhooks"],"summary":"Delete Webhook Endpoint","description":"Delete a webhook endpoint.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `webhooks:write`: Create and modify webhooks","operationId":"delete_webhook_endpoint_api_v1_webhooks_endpoints__id__delete","security":[{"api_key":["organization:admin","webhooks:write"]},{"session_key":["organization:admin","webhooks:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The webhook endpoint ID.","title":"Id"},"description":"The webhook endpoint ID."}],"responses":{"204":{"description":"Webhook endpoint deleted."},"404":{"description":"Webhook endpoint not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__NotFoundError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/webhooks/endpoints/{id}/secret":{"patch":{"tags":["Webhooks"],"summary":"Reset Webhook Endpoint Secret","description":"Regenerate a webhook endpoint secret.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `webhooks:write`: Create and modify webhooks","operationId":"reset_webhook_endpoint_secret_api_v1_webhooks_endpoints__id__secret_patch","security":[{"api_key":["organization:admin","webhooks:write"]},{"session_key":["organization:admin","webhooks:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The webhook endpoint ID.","title":"Id"},"description":"The webhook endpoint ID."}],"responses":{"200":{"description":"Webhook endpoint secret reset.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpoint"}}}},"404":{"description":"Webhook endpoint not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__NotFoundError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/webhooks/deliveries":{"get":{"tags":["Webhooks"],"summary":"List Webhook Deliveries","description":"List webhook deliveries.\n\nDeliveries are all the attempts to deliver a webhook event to an endpoint.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `webhooks:read`: Read webhooks\n\n- `webhooks:write`: Create and modify webhooks","operationId":"list_webhook_deliveries_api_v1_webhooks_deliveries_get","security":[{"api_key":["organization:admin","organization:read","webhooks:read","webhooks:write"]},{"session_key":["organization:admin","organization:read","webhooks:read","webhooks:write"]}],"parameters":[{"name":"endpoint_id","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid4"}},{"type":"null"}],"description":"Filter by webhook endpoint ID.","title":"Endpoint Id"},"description":"Filter by webhook endpoint ID."},{"name":"start_timestamp","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter deliveries after this timestamp.","title":"Start Timestamp"},"description":"Filter deliveries after this timestamp."},{"name":"end_timestamp","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter deliveries before this timestamp.","title":"End Timestamp"},"description":"Filter deliveries before this timestamp."},{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResource_WebhookDelivery_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/webhooks/events/{id}/redeliver":{"post":{"tags":["Webhooks"],"summary":"Redeliver Webhook Event","description":"Schedule the re-delivery of a webhook event.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `webhooks:write`: Create and modify webhooks","operationId":"redeliver_webhook_event_api_v1_webhooks_events__id__redeliver_post","security":[{"api_key":["organization:admin","webhooks:write"]},{"session_key":["organization:admin","webhooks:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The webhook event ID.","title":"Id"},"description":"The webhook event ID."}],"responses":{"202":{"description":"Webhook event re-delivery scheduled.","content":{"application/json":{"schema":{}}}},"404":{"description":"Webhook endpoint not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__NotFoundError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organization-api-keys":{"post":{"tags":["Organization API Keys"],"summary":"Create Organization API Key","operationId":"create_api_v1_organization_api_keys_post","security":[{"api_key":["organization:admin","organization_api_keys:write"]},{"session_key":["organization:admin","organization_api_keys:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationApiKeyCreate"}}}},"responses":{"201":{"description":"Organization API Key created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationApiKeyCreateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization_api_keys:write`: Create and modify organization api keys"},"get":{"tags":["Organization API Keys"],"summary":"List Organization API Keys","description":"List Organization API Keys.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `organization_api_keys:read`: Read organization api keys\n\n- `organization_api_keys:write`: Create and modify organization api keys","operationId":"list_all_api_v1_organization_api_keys_get","security":[{"api_key":["organization:admin","organization:read","organization_api_keys:read","organization_api_keys:write"]},{"session_key":["organization:admin","organization:read","organization_api_keys:read","organization_api_keys:write"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResource_OrganizationApiKeySchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organization-api-keys/{id}":{"get":{"tags":["Organization API Keys"],"summary":"Get Organization API Key","description":"Get a Organization API Key by ID.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `organization_api_keys:read`: Read organization api keys\n\n- `organization_api_keys:write`: Create and modify organization api keys","operationId":"get_api_v1_organization_api_keys__id__get","security":[{"api_key":["organization:admin","organization:read","organization_api_keys:read","organization_api_keys:write"]},{"session_key":["organization:admin","organization:read","organization_api_keys:read","organization_api_keys:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The organization api key ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/organization-api-keys","resourceName":"Organization API Key","displayProperty":"name"},"title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationApiKeySchema"}}}},"404":{"description":"Organization API Key not found for the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__ResourceNotFound"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Organization API Keys"],"summary":"Update Organization API Key","description":"Update a Organization API Key by ID.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization_api_keys:write`: Create and modify organization api keys","operationId":"patch_api_v1_organization_api_keys__id__patch","security":[{"api_key":["organization:admin","organization_api_keys:write"]},{"session_key":["organization:admin","organization_api_keys:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The organization api key ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/organization-api-keys","resourceName":"Organization API Key","displayProperty":"name"},"title":"Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationApiKeyUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationApiKeySchema"}}}},"404":{"description":"Organization API Key not found for the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__ResourceNotFound"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Organization API Keys"],"summary":"Delete Api Key","description":"Delete a Organization API Key.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization_api_keys:write`: Create and modify organization api keys","operationId":"delete_api_key_api_v1_organization_api_keys__id__delete","security":[{"api_key":["organization:admin","organization_api_keys:write"]},{"session_key":["organization:admin","organization_api_keys:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The organization api key ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/organization-api-keys","resourceName":"Organization API Key","displayProperty":"name"},"title":"Id"}}],"responses":{"204":{"description":"Organization API Key deleted."},"404":{"description":"Organization API Key not found for the given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__ResourceNotFound"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reporting/analytics/resolution-evaluation-plan/{agent_id}":{"get":{"tags":["Reporting Analytics"],"summary":"Get Resolution Evaluation Plan","description":"Get the resolution evaluation plan and default status prompts for an agent.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `reporting_analytics:read`: Read analytics\n\n- `reporting_analytics:write`: Modify analytics","operationId":"get_resolution_evaluation_plan_api_v1_reporting_analytics_resolution_evaluation_plan__agent_id__get","security":[{"api_key":["organization:admin","organization:read","reporting_analytics:read","reporting_analytics:write"]},{"session_key":["organization:admin","organization:read","reporting_analytics:read","reporting_analytics:write"]}],"parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolutionEvaluationPlanDetailSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Reporting Analytics"],"summary":"Update Resolution Evaluation Plan","description":"Update the resolution evaluation plan for an agent.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `reporting_analytics:write`: Modify analytics","operationId":"update_resolution_evaluation_plan_api_v1_reporting_analytics_resolution_evaluation_plan__agent_id__patch","security":[{"api_key":["organization:admin","reporting_analytics:write"]},{"session_key":["organization:admin","reporting_analytics:write"]}],"parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolutionEvaluationPlanUpdateSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolutionEvaluationPlanDetailSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reporting/analytics/calls":{"post":{"tags":["Reporting Analytics"],"summary":"Get Calls Analytics","operationId":"get_calls_analytics_api_v1_reporting_analytics_calls_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallsAnalyticsRequest"}}},"required":true},"responses":{"200":{"description":"Analytics data retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallsAnalyticsResponse"}}}},"400":{"description":"Bad request - invalid filters or time range."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"api_key":["organization:admin","organization:read","reporting_analytics:read","reporting_analytics:write"]},{"session_key":["organization:admin","organization:read","reporting_analytics:read","reporting_analytics:write"]}],"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `reporting_analytics:read`: Read analytics\n\n- `reporting_analytics:write`: Modify analytics"}},"/api/v1/reporting/insights":{"get":{"tags":["Insights"],"summary":"List Insights","operationId":"list_all_api_v1_reporting_insights_get","security":[{"api_key":["organization:admin","organization:read","reporting_insights:read","reporting_insights:write"]},{"session_key":["organization:admin","organization:read","reporting_insights:read","reporting_insights:write"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__pagenation__ListResource[]"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `reporting_insights:read`: Read insights and boards\n\n- `reporting_insights:write`: Modify insights and boards"},"post":{"tags":["Insights"],"summary":"Create Insight","operationId":"create_api_v1_reporting_insights_post","security":[{"api_key":["organization:admin","reporting_insights:write"]},{"session_key":["organization:admin","reporting_insights:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightCreateRequest"}}}},"responses":{"201":{"description":"Insight created.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TextInsightResponse"},{"$ref":"#/components/schemas/PieInsightResponse"},{"$ref":"#/components/schemas/BarInsightResponse"},{"$ref":"#/components/schemas/LineInsightResponse"}],"discriminator":{"propertyName":"type","mapping":{"text":"#/components/schemas/TextInsightResponse","pie":"#/components/schemas/PieInsightResponse","bar":"#/components/schemas/BarInsightResponse","line":"#/components/schemas/LineInsightResponse"}},"title":"Response Create Api V1 Reporting Insights Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `reporting_insights:write`: Modify insights and boards"}},"/api/v1/reporting/insights/{id}":{"get":{"tags":["Insights"],"summary":"Get Insight","operationId":"get_api_v1_reporting_insights__id__get","security":[{"api_key":["organization:admin","organization:read","reporting_insights:read","reporting_insights:write"]},{"session_key":["organization:admin","organization:read","reporting_insights:read","reporting_insights:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The insight ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/reporting/insights","resourceName":"Insight","displayProperty":"name"},"title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TextInsightResponse"},{"$ref":"#/components/schemas/PieInsightResponse"},{"$ref":"#/components/schemas/BarInsightResponse"},{"$ref":"#/components/schemas/LineInsightResponse"}],"discriminator":{"propertyName":"type","mapping":{"text":"#/components/schemas/TextInsightResponse","pie":"#/components/schemas/PieInsightResponse","bar":"#/components/schemas/BarInsightResponse","line":"#/components/schemas/LineInsightResponse"}},"title":"Response Get Api V1 Reporting Insights  Id  Get"}}}},"404":{"description":"Insight or referenced resource not found (e.g., structured output UUID or column).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__ResourceNotFound"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `reporting_insights:read`: Read insights and boards\n\n- `reporting_insights:write`: Modify insights and boards"},"put":{"tags":["Insights"],"summary":"Update Insight","operationId":"put_insight_api_v1_reporting_insights__id__put","security":[{"api_key":["organization:admin","reporting_insights:write"]},{"session_key":["organization:admin","reporting_insights:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The insight ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/reporting/insights","resourceName":"Insight","displayProperty":"name"},"title":"Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TextInsightResponse"},{"$ref":"#/components/schemas/PieInsightResponse"},{"$ref":"#/components/schemas/BarInsightResponse"},{"$ref":"#/components/schemas/LineInsightResponse"}],"discriminator":{"propertyName":"type","mapping":{"text":"#/components/schemas/TextInsightResponse","pie":"#/components/schemas/PieInsightResponse","bar":"#/components/schemas/BarInsightResponse","line":"#/components/schemas/LineInsightResponse"}},"title":"Response Put Insight Api V1 Reporting Insights  Id  Put"}}}},"404":{"description":"Insight or referenced resource not found (e.g., structured output UUID or column).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__ResourceNotFound"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `reporting_insights:write`: Modify insights and boards"},"delete":{"tags":["Insights"],"summary":"Delete Insight","operationId":"delete_insight_api_v1_reporting_insights__id__delete","security":[{"api_key":["organization:admin","reporting_insights:write"]},{"session_key":["organization:admin","reporting_insights:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The insight ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/reporting/insights","resourceName":"Insight","displayProperty":"name"},"title":"Id"}}],"responses":{"204":{"description":"Insight deleted."},"404":{"description":"Insight or referenced resource not found (e.g., structured output UUID or column).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__ResourceNotFound"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `reporting_insights:write`: Modify insights and boards"}},"/api/v1/reporting/insights/{id}/run":{"post":{"tags":["Insights"],"summary":"Run Insight","operationId":"run_insight_api_v1_reporting_insights__id__run_post","security":[{"api_key":["organization:admin","organization:read","reporting_insights:read","reporting_insights:write"]},{"session_key":["organization:admin","organization:read","reporting_insights:read","reporting_insights:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The insight ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/reporting/insights","resourceName":"Insight","displayProperty":"name"},"title":"Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightRunRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightPreviewResponse"}}}},"400":{"description":"Invalid insight request. This can occur due to: invalid time range, invalid column references, unsupported operations, or invalid filters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__BadRequestError"}}}},"404":{"description":"Insight or referenced resource not found (e.g., structured output UUID or column).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__ResourceNotFound"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `reporting_insights:read`: Read insights and boards\n\n- `reporting_insights:write`: Modify insights and boards"}},"/api/v1/reporting/insights/preview":{"post":{"tags":["Insights"],"summary":"Preview Insight","operationId":"preview_api_v1_reporting_insights_preview_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightPreviewRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightPreviewResponse"}}}},"400":{"description":"Invalid insight request. This can occur due to: invalid time range, invalid column references, unsupported operations, or invalid filters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__BadRequestError"}}}},"404":{"description":"Insight or referenced resource not found (e.g., structured output UUID or column).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__ResourceNotFound"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"api_key":["organization:admin","reporting_insights:write"]},{"session_key":["organization:admin","reporting_insights:write"]}],"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `reporting_insights:write`: Modify insights and boards"}},"/api/v1/reporting/insight-boards":{"get":{"tags":["Insight Boards"],"summary":"List Insight Boards","operationId":"list_all_api_v1_reporting_insight_boards_get","security":[{"api_key":["organization:admin","organization:read","reporting_insights:read","reporting_insights:write"]},{"session_key":["organization:admin","organization:read","reporting_insights:read","reporting_insights:write"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResource_InsightBoardSchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `reporting_insights:read`: Read insights and boards\n\n- `reporting_insights:write`: Modify insights and boards"},"post":{"tags":["Insight Boards"],"summary":"Create Insight Board","operationId":"create_api_v1_reporting_insight_boards_post","security":[{"api_key":["organization:admin","reporting_insights:write"]},{"session_key":["organization:admin","reporting_insights:write"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightBoardCreate"}}}},"responses":{"201":{"description":"Insight board created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightBoardWithItemsSchema"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__BadRequestError"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `reporting_insights:write`: Modify insights and boards"}},"/api/v1/reporting/insight-boards/{id}":{"get":{"tags":["Insight Boards"],"summary":"Get Insight Board","operationId":"get_api_v1_reporting_insight_boards__id__get","security":[{"api_key":["organization:admin","organization:read","reporting_insights:read","reporting_insights:write"]},{"session_key":["organization:admin","organization:read","reporting_insights:read","reporting_insights:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The insight board ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/reporting/insight-boards","resourceName":"Insight Board","displayProperty":"name"},"title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightBoardWithItemsSchema"}}}},"404":{"description":"Insight board not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__ResourceNotFound"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `reporting_insights:read`: Read insights and boards\n\n- `reporting_insights:write`: Modify insights and boards"},"patch":{"tags":["Insight Boards"],"summary":"Update Insight Board","operationId":"patch_insight_board_api_v1_reporting_insight_boards__id__patch","security":[{"api_key":["organization:admin","organization:read","reporting_insights:read","reporting_insights:write"]},{"session_key":["organization:admin","organization:read","reporting_insights:read","reporting_insights:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The insight board ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/reporting/insight-boards","resourceName":"Insight Board","displayProperty":"name"},"title":"Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightBoardUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightBoardWithItemsSchema"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__BadRequestError"}}}},"404":{"description":"Insight board not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__ResourceNotFound"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `reporting_insights:read`: Read insights and boards\n\n- `reporting_insights:write`: Modify insights and boards"},"delete":{"tags":["Insight Boards"],"summary":"Delete Insight Board","operationId":"delete_insight_board_api_v1_reporting_insight_boards__id__delete","security":[{"api_key":["organization:admin","reporting_insights:write"]},{"session_key":["organization:admin","reporting_insights:write"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The insight board ID.","x-mawj-selector-widget":{"resourceRoot":"/v1/reporting/insight-boards","resourceName":"Insight Board","displayProperty":"name"},"title":"Id"}}],"responses":{"204":{"description":"Insight deleted."},"404":{"description":"Insight board not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__ResourceNotFound"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `reporting_insights:write`: Modify insights and boards"}},"/api/v1/reporting/insight-boards/agents/{agent_id}":{"get":{"tags":["Insight Boards"],"summary":"Get / Create Insight Board By Agent ID","operationId":"get_create_by_agent_id_api_v1_reporting_insight_boards_agents__agent_id__get","security":[{"api_key":["organization:admin","organization:read","reporting_insights:read","reporting_insights:write"]},{"session_key":["organization:admin","organization:read","reporting_insights:read","reporting_insights:write"]}],"parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightBoardWithItemsSchema"}}}},"404":{"description":"Insight board not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/src__core__exceptions__base__ResourceNotFound"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `reporting_insights:read`: Read insights and boards\n\n- `reporting_insights:write`: Modify insights and boards"}},"/api/v1/reporting/improvements/categories":{"get":{"tags":["Reporting Improvements"],"summary":"List Improvement Categories","description":"List all active improvement categories.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `reporting_improvements:read`: Read improvements\n\n- `reporting_improvements:write`: Modify improvements","operationId":"list_categories_api_v1_reporting_improvements_categories_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ImprovementCategorySchema"},"type":"array","title":"Response List Categories Api V1 Reporting Improvements Categories Get"}}}}},"security":[{"api_key":["organization:admin","organization:read","reporting_improvements:read","reporting_improvements:write"]},{"session_key":["organization:admin","organization:read","reporting_improvements:read","reporting_improvements:write"]}]}},"/api/v1/reporting/improvements/categories/dashboard":{"get":{"tags":["Reporting Improvements"],"summary":"Get Improvement Categories Dashboard","description":"Get improvement categories with up to 3 topics each for dashboard view.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `reporting_improvements:read`: Read improvements\n\n- `reporting_improvements:write`: Modify improvements","operationId":"get_categories_dashboard_api_v1_reporting_improvements_categories_dashboard_get","security":[{"api_key":["organization:admin","organization:read","reporting_improvements:read","reporting_improvements:write"]},{"session_key":["organization:admin","organization:read","reporting_improvements:read","reporting_improvements:write"]}],"parameters":[{"name":"agent_id","in":"query","required":true,"schema":{"type":"string","format":"uuid4","description":"Filter by agent id.","title":"Agent Id"},"description":"Filter by agent id."},{"name":"min_occurrence_count","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Minimum number of topic occurrences","default":3,"title":"Min Occurrence Count"},"description":"Minimum number of topic occurrences"},{"name":"start","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start time (ISO 8601, 'now', or relative like '-7d'). Valid relative units are {h,d,w,m,y}.","examples":["-7d","-1m","2024-01-01T00:00:00Z","now"],"title":"Start"},"description":"Start time (ISO 8601, 'now', or relative like '-7d'). Valid relative units are {h,d,w,m,y}."},{"name":"end","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End time (ISO 8601, 'now', or relative like '-1d'). Valid relative units are {h,d,w,m,y}.","examples":["now","-1d","2024-12-31T23:59:59Z"],"title":"End"},"description":"End time (ISO 8601, 'now', or relative like '-1d'). Valid relative units are {h,d,w,m,y}."},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"IANA timezone value (e.g., 'Asia/Riyadh')","examples":["UTC","Asia/Riyadh","America/New_York","Europe/London"],"default":"UTC","title":"Timezone"},"description":"IANA timezone value (e.g., 'Asia/Riyadh')"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ImprovementCategoryWithTopicsSchema"},"title":"Response Get Categories Dashboard Api V1 Reporting Improvements Categories Dashboard Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reporting/improvements/topics":{"get":{"tags":["Reporting Improvements"],"summary":"List Improvement Topics","description":"List improvement topics with pagination.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `reporting_improvements:read`: Read improvements\n\n- `reporting_improvements:write`: Modify improvements","operationId":"list_topics_api_v1_reporting_improvements_topics_get","security":[{"api_key":["organization:admin","organization:read","reporting_improvements:read","reporting_improvements:write"]},{"session_key":["organization:admin","organization:read","reporting_improvements:read","reporting_improvements:write"]}],"parameters":[{"name":"agent_id","in":"query","required":true,"schema":{"type":"string","format":"uuid4","description":"Filter by agent id.","title":"Agent Id"},"description":"Filter by agent id."},{"name":"category_ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"array","items":{"type":"string","format":"uuid4"}},{"type":"null"}],"title":"Category Ids"}},{"name":"statuses","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ImprovementTopicStatus"},{"type":"array","items":{"$ref":"#/components/schemas/ImprovementTopicStatus"}},{"type":"null"}],"title":"Statuses"}},{"name":"min_occurrence_count","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Minimum number of topic occurrences","default":3,"title":"Min Occurrence Count"},"description":"Minimum number of topic occurrences"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."},{"name":"start","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start time (ISO 8601, 'now', or relative like '-7d'). Valid relative units are {h,d,w,m,y}.","examples":["-7d","-1m","2024-01-01T00:00:00Z","now"],"title":"Start"},"description":"Start time (ISO 8601, 'now', or relative like '-7d'). Valid relative units are {h,d,w,m,y}."},{"name":"end","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End time (ISO 8601, 'now', or relative like '-1d'). Valid relative units are {h,d,w,m,y}.","examples":["now","-1d","2024-12-31T23:59:59Z"],"title":"End"},"description":"End time (ISO 8601, 'now', or relative like '-1d'). Valid relative units are {h,d,w,m,y}."},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","description":"IANA timezone value (e.g., 'Asia/Riyadh')","examples":["UTC","Asia/Riyadh","America/New_York","Europe/London"],"default":"UTC","title":"Timezone"},"description":"IANA timezone value (e.g., 'Asia/Riyadh')"}],"responses":{"200":{"description":"Topics retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResource_ImprovementTopicWithCategorySchema_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reporting/improvements/topics/{topic_id}":{"get":{"tags":["Reporting Improvements"],"summary":"Get Improvement Topic","description":"Get a specific improvement topic by ID.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `reporting_improvements:read`: Read improvements\n\n- `reporting_improvements:write`: Modify improvements","operationId":"get_topic_api_v1_reporting_improvements_topics__topic_id__get","security":[{"api_key":["organization:admin","organization:read","reporting_improvements:read","reporting_improvements:write"]},{"session_key":["organization:admin","organization:read","reporting_improvements:read","reporting_improvements:write"]}],"parameters":[{"name":"topic_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The improvement topic ID.","title":"Topic Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImprovementTopicWithCategorySchema"}}}},"404":{"description":"Topic not found."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reporting/improvements/topics/{topic_id}/occurrences":{"get":{"tags":["Reporting Improvements"],"summary":"List Topic Occurrences","description":"List occurrences for a specific improvement topic.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization\n\n- `reporting_improvements:read`: Read improvements\n\n- `reporting_improvements:write`: Modify improvements","operationId":"list_topic_occurrences_api_v1_reporting_improvements_topics__topic_id__occurrences_get","security":[{"api_key":["organization:admin","organization:read","reporting_improvements:read","reporting_improvements:write"]},{"session_key":["organization:admin","organization:read","reporting_improvements:read","reporting_improvements:write"]}],"parameters":[{"name":"topic_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The improvement topic ID.","title":"Topic Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResource_ImprovementOccurrenceSchema_"}}}},"404":{"description":"Topic not found."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reporting/improvements/topics/{topic_id}/status":{"patch":{"tags":["Reporting Improvements"],"summary":"Update Topic Status","description":"Update the status of an improvement topic.\n\n### Required scopes:\n- `organization:admin`: Modify your organization\n\n- `reporting_improvements:write`: Modify improvements","operationId":"update_topic_status_api_v1_reporting_improvements_topics__topic_id__status_patch","security":[{"api_key":["organization:admin","reporting_improvements:write"]},{"session_key":["organization:admin","reporting_improvements:write"]}],"parameters":[{"name":"topic_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","description":"The improvement topic ID.","title":"Topic Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImprovementTopicUpdateStatus"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImprovementTopicSchema"}}}},"404":{"description":"Topic not found."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/evals":{"get":{"tags":["Evals"],"summary":"List Eval Test Cases","description":"List all eval test cases for the authenticated organization with pagination.\n\n### Required scopes:\n- `evals:read`: Read evals\n\n- `evals:write`: Create and modify evals\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"list_eval_test_cases_api_v1_evals_get","security":[{"api_key":["evals:read","evals:write","organization:admin","organization:read"]},{"session_key":["evals:read","evals:write","organization:admin","organization:read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResource_EvalTestCaseResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Evals"],"summary":"Create Eval Test Case","description":"Create a new eval test case.\n\n### Required scopes:\n- `evals:write`: Create and modify evals\n\n- `organization:admin`: Modify your organization","operationId":"create_eval_test_case_api_v1_evals_post","security":[{"api_key":["evals:write","organization:admin"]},{"session_key":["evals:write","organization:admin"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalTestCaseCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalTestCaseResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/evals/{id}":{"get":{"tags":["Evals"],"summary":"Get Eval Test Case","description":"Get a single eval test case by ID.\n\n### Required scopes:\n- `evals:read`: Read evals\n\n- `evals:write`: Create and modify evals\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"get_eval_test_case_api_v1_evals__id__get","security":[{"api_key":["evals:read","evals:write","organization:admin","organization:read"]},{"session_key":["evals:read","evals:write","organization:admin","organization:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalTestCaseResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Evals"],"summary":"Update Eval Test Case","description":"Update an existing eval test case.\n\n### Required scopes:\n- `evals:write`: Create and modify evals\n\n- `organization:admin`: Modify your organization","operationId":"update_eval_test_case_api_v1_evals__id__put","security":[{"api_key":["evals:write","organization:admin"]},{"session_key":["evals:write","organization:admin"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalTestCaseUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalTestCaseResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Evals"],"summary":"Delete Eval Test Case","description":"Soft delete an eval test case (sets deleted_at timestamp).\n\n### Required scopes:\n- `evals:write`: Create and modify evals\n\n- `organization:admin`: Modify your organization","operationId":"delete_eval_test_case_api_v1_evals__id__delete","security":[{"api_key":["evals:write","organization:admin"]},{"session_key":["evals:write","organization:admin"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/evals/from-call/{call_id}":{"post":{"tags":["Evals"],"summary":"Create Eval Test Case From a Completed Call","description":"Create a new eval test case.\n\n### Required scopes:\n- `evals:write`: Create and modify evals\n\n- `organization:admin`: Modify your organization","operationId":"create_eval_test_case_from_call_api_v1_evals_from_call__call_id__post","security":[{"api_key":["evals:write","organization:admin"]},{"session_key":["evals:write","organization:admin"]}],"parameters":[{"name":"call_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Call Id"}}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalTestCaseResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/eval-runs":{"get":{"tags":["Eval Runs"],"summary":"List All Eval Test Case Runs","description":"List all eval test case runs for the authenticated organization with pagination.\n\n### Required scopes:\n- `evals:read`: Read evals\n\n- `evals:write`: Create and modify evals\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"list_all_eval_test_case_runs_api_v1_eval_runs_get","security":[{"api_key":["evals:read","evals:write","organization:admin","organization:read"]},{"session_key":["evals:read","evals:write","organization:admin","organization:read"]}],"parameters":[{"name":"eval_test_case_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Eval Test Case `id` for the runs","title":"Eval Test Case Id"},"description":"Eval Test Case `id` for the runs"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page"},"description":"Page number, defaults to 1."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 50.","default":10,"title":"Limit"},"description":"Size of a page, defaults to 10. Maximum is 50."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResource_EvalTestCaseRun_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Eval Runs"],"summary":"Create Eval Test Case Run","description":"Create a new eval test case.\n\n### Required scopes:\n- `evals:write`: Create and modify evals\n\n- `organization:admin`: Modify your organization","operationId":"create_eval_test_case_run_api_v1_eval_runs_post","security":[{"api_key":["evals:write","organization:admin"]},{"session_key":["evals:write","organization:admin"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalTestCaseRunCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalTestCaseRun"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/eval-runs/{id}":{"get":{"tags":["Eval Runs"],"summary":"Get Eval Test Case Run","description":"Get a single eval test case run by ID.\n\n### Required scopes:\n- `evals:read`: Read evals\n\n- `evals:write`: Create and modify evals\n\n- `organization:admin`: Modify your organization\n\n- `organization:read`: Read your organization","operationId":"get_eval_test_case_run_api_v1_eval_runs__id__get","security":[{"api_key":["evals:read","evals:write","organization:admin","organization:read"]},{"session_key":["evals:read","evals:write","organization:admin","organization:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalTestCaseRun"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"webhooks":{"call.finalized":{"post":{"summary":"call.finalized","description":"Sent when a call is finalized.","operationId":"_endpointcall_finalized_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCallFinalizePayload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"tool.error":{"post":{"summary":"tool.error","description":"Sent when llm tool return error response.","operationId":"_endpointtool_error_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookToolErrorPayload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"placeholder.example":{"post":{"summary":"placeholder.example","description":"Sent when a call is finalized.","operationId":"_endpointplaceholder_example_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaceholderWebhookPayload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ActionFunctionDef-Input":{"properties":{"name":{"type":"string","pattern":"^[\\w-]{1,64}$","title":"Name","description":"Function name for agent"},"description":{"type":"string","title":"Description","description":"Function description for agent","default":""},"strict":{"type":"boolean","title":"Strict","default":false},"parameters":{"anyOf":[{"$ref":"#/components/schemas/FunctionParametersDef-Input"},{"type":"null"}]}},"type":"object","required":["name"],"title":"ActionFunctionDef","description":"Function definition attached to an action."},"ActionFunctionDef-Output":{"properties":{"name":{"type":"string","pattern":"^[\\w-]{1,64}$","title":"Name","description":"Function name for agent"},"description":{"type":"string","title":"Description","description":"Function description for agent","default":""},"strict":{"type":"boolean","title":"Strict","default":false},"parameters":{"anyOf":[{"$ref":"#/components/schemas/FunctionParametersDef-Output"},{"type":"null"}]}},"type":"object","required":["name"],"title":"ActionFunctionDef","description":"Function definition attached to an action."},"ActionMethod":{"type":"string","enum":["GET","POST","PUT","PATCH"],"title":"ActionMethod"},"ActionType":{"type":"string","enum":["api_call","google.sheets.row.append","transfer_call","mcp","transfer_chat_respondio","knowledge_base"],"title":"ActionType"},"AgentRuleSchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"title":{"type":"string","title":"Title","description":"Rule title"},"content":{"type":"string","title":"Content","description":"Rule content / instructions"},"agent_rules_category_id":{"type":"string","format":"uuid","title":"Agent Rules Category Id","description":"Category this rule belongs to"},"organization_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Organization Id","description":"Organization that owns this rule. None means it is a system/global rule."}},"type":"object","required":["created_at","updated_at","id","title","content","agent_rules_category_id","organization_id"],"title":"AgentRuleSchema","description":"An individual agent rule."},"AgentRulesCategorySchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"title":{"type":"string","title":"Title","description":"Category title"},"placement":{"type":"string","title":"Placement","description":"Where rules appear relative to agent prompt"},"order":{"type":"integer","title":"Order","description":"Display order"},"hint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hint","description":"Optional hint text for the category"},"agent_rules":{"items":{"$ref":"#/components/schemas/AgentRuleSchema"},"type":"array","title":"Agent Rules","description":"Agent rules within this category"}},"type":"object","required":["created_at","updated_at","id","title","placement","order","hint","agent_rules"],"title":"AgentRulesCategorySchema","description":"A category grouping agent rules, with nested rules."},"AggregationFunction":{"type":"string","enum":["count","sum","max","min","avg"],"title":"AggregationFunction"},"AggregationOperation":{"type":"string","enum":["count","sum","max","min","average"],"title":"AggregationOperation"},"AnalyticsFiltersSchema":{"properties":{"agent_ids":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Agent Ids","description":"Filter by agent IDs. If not provided, all agents are included."},"call_type":{"anyOf":[{"$ref":"#/components/schemas/CallType"},{"type":"null"}],"description":"Filter by call type (inbound or outbound)."},"call_statuses":{"anyOf":[{"items":{"$ref":"#/components/schemas/ConversationStatus"},"type":"array"},{"type":"null"}],"title":"Call Statuses","description":"Filter by call statuses. If not provided, all statuses are included."}},"type":"object","title":"AnalyticsFiltersSchema"},"ApiCallActionSchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"timeout":{"type":"integer","title":"Timeout"},"inbound_config_ids":{"items":{"type":"string","format":"uuid4"},"type":"array","title":"Inbound Config Ids","description":"IDs of agents this action is assigned to"},"type":{"type":"string","const":"api_call","title":"Type"},"config":{"$ref":"#/components/schemas/ApiCallConfig"},"function":{"$ref":"#/components/schemas/ActionFunctionDef-Output"}},"type":"object","required":["created_at","updated_at","id","organization_id","name","timeout","type","config","function"],"title":"ApiCallActionSchema"},"ApiCallConfig":{"properties":{"method":{"$ref":"#/components/schemas/ActionMethod"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers"},"queryParams":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Queryparams"},"url":{"type":"string","title":"Url"},"body":{"title":"Body"}},"type":"object","required":["method","url"],"title":"ApiCallConfig","description":"Configuration for an API-call action."},"AppendMessageEvent":{"properties":{"message":{"type":"string","minLength":1,"title":"Message","description":"The message coming from the user"}},"type":"object","required":["message"],"title":"AppendMessageEvent"},"AssistantMessage-Input":{"properties":{"role":{"type":"string","const":"assistant","title":"Role","default":"assistant"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content","description":"Mock response content (null when message is evaluated)"},"tool_calls":{"anyOf":[{"items":{"$ref":"#/components/schemas/ToolCall"},"type":"array"},{"type":"null"}],"title":"Tool Calls","description":"mock tool/function calls (null when message is evaluated)"},"judge_plan":{"anyOf":[{"$ref":"#/components/schemas/JudgePlan"},{"type":"null"}],"description":"Evaluation criteria (present when message should be evaluated)"},"continue_plan":{"anyOf":[{"$ref":"#/components/schemas/ContinuePlan"},{"type":"null"}],"description":"Continue behavior after evaluation"}},"type":"object","title":"AssistantMessage","description":"Assistant/LLM message in conversation","examples":[{"content":"Hello! How can I help you?","role":"assistant"},{"continue_plan":{"exit_on_failure_enabled":true},"judge_plan":{"enabled":true,"expected_content":"Hello! How can I help you?","type":"exact_match"},"role":"assistant"}]},"AssistantMessage-Output":{"properties":{"role":{"type":"string","const":"assistant","title":"Role","default":"assistant"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content","description":"Mock response content (null when message is evaluated)"},"tool_calls":{"anyOf":[{"items":{"$ref":"#/components/schemas/ToolCall"},"type":"array"},{"type":"null"}],"title":"Tool Calls","description":"mock tool/function calls (null when message is evaluated)"},"judge_plan":{"anyOf":[{"$ref":"#/components/schemas/JudgePlan"},{"type":"null"}],"description":"Evaluation criteria (present when message should be evaluated)"},"continue_plan":{"anyOf":[{"$ref":"#/components/schemas/ContinuePlan"},{"type":"null"}],"description":"Continue behavior after evaluation"}},"type":"object","title":"AssistantMessage","description":"Assistant/LLM message in conversation","examples":[{"content":"Hello! How can I help you?","role":"assistant"},{"continue_plan":{"exit_on_failure_enabled":true},"judge_plan":{"enabled":true,"expected_content":"Hello! How can I help you?","type":"exact_match"},"role":"assistant"}]},"AutoStructureResponse":{"properties":{"knowledge_bases":{"items":{"$ref":"#/components/schemas/KnowledgeBaseSchema"},"type":"array","title":"Knowledge Bases","description":"List of auto-generated knowledge bases"}},"type":"object","required":["knowledge_bases"],"title":"AutoStructureResponse","description":"Response schema when auto_structure is enabled, containing multiple KBs."},"AvailabilityHour":{"properties":{"startHour":{"type":"string","pattern":"^(?:2[0-3]|[01]?\\d):[0-5]\\d$","title":"Starthour"},"endHour":{"type":"string","pattern":"^(?:2[0-3]|[01]?\\d):[0-5]\\d$","title":"Endhour"}},"type":"object","required":["startHour","endHour"],"title":"AvailabilityHour"},"AvailabilityScheduleDay":{"properties":{"dayOfWeek":{"type":"string","enum":["MO","TU","WE","TH","FR","SA","SU"],"title":"Dayofweek"},"hours":{"items":{"$ref":"#/components/schemas/AvailabilityHour"},"type":"array","title":"Hours"}},"type":"object","required":["dayOfWeek"],"title":"AvailabilityScheduleDay"},"BarInsightConfigSchema-Input":{"properties":{"queries":{"items":{"$ref":"#/components/schemas/QuerySchema-Input"},"type":"array","minItems":1,"title":"Queries"},"time_range":{"$ref":"#/components/schemas/TimeRangeFilterWithIntervalSchema"},"group_by":{"items":{"type":"string"},"type":"array","title":"Group By"}},"type":"object","required":["queries"],"title":"BarInsightConfigSchema"},"BarInsightConfigSchema-Output":{"properties":{"queries":{"items":{"$ref":"#/components/schemas/QuerySchema-Output"},"type":"array","minItems":1,"title":"Queries"},"time_range":{"$ref":"#/components/schemas/TimeRangeFilterWithIntervalSchema"},"group_by":{"items":{"type":"string"},"type":"array","title":"Group By"}},"type":"object","required":["queries"],"title":"BarInsightConfigSchema"},"BarInsightDefinition":{"properties":{"name":{"type":"string","title":"Name","description":"Insight name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Insight description"},"type":{"type":"string","const":"bar","title":"Type"},"config":{"$ref":"#/components/schemas/BarInsightConfigSchema-Input"}},"type":"object","required":["name","type","config"],"title":"BarInsightDefinition"},"BarInsightResponse":{"properties":{"name":{"type":"string","title":"Name","description":"Insight name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Insight description"},"type":{"type":"string","const":"bar","title":"Type"},"config":{"$ref":"#/components/schemas/BarInsightConfigSchema-Output"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid","title":"Organization Id","description":"Organization ID this insight belongs to"}},"type":"object","required":["name","type","config","created_at","updated_at","id","organization_id"],"title":"BarInsightResponse"},"Body_auto_structure_knowledge_base_api_v1_knowledge_base_auto_structure_post":{"properties":{"type":{"type":"string","enum":["file","text"],"title":"Type","description":"Input type"},"file":{"anyOf":[{"type":"string","format":"binary"},{"type":"null"}],"title":"File","description":"File to process (required if type is 'file')"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content","description":"Text content (required if type is 'text')"}},"type":"object","required":["type"],"title":"Body_auto_structure_knowledge_base_api_v1_knowledge_base_auto_structure_post"},"Body_create_knowledge_base_api_v1_knowledge_base_post":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the knowledge base entry"},"type":{"type":"string","enum":["file","text"],"title":"Type","description":"Knowledge base type"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description used by LLM to understand when to use KB as a tool"},"use_as_tool":{"type":"boolean","title":"Use As Tool","description":"Enable to register this KB as an LLM tool","default":false},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content","description":"Text content (required if type is 'text')"},"file":{"anyOf":[{"type":"string","format":"binary"},{"type":"null"}],"title":"File","description":"File to upload (required if type is 'file')"}},"type":"object","required":["name","type"],"title":"Body_create_knowledge_base_api_v1_knowledge_base_post"},"BooleanSchema":{"properties":{"description":{"type":"string","title":"Description"},"type":{"type":"string","const":"boolean","title":"Type"}},"type":"object","required":["description","type"],"title":"BooleanSchema"},"BulkOutboundCallDestination":{"properties":{"to_number":{"type":"string","title":"To Number","description":"The phone / extension number to call"},"is_extension":{"type":"boolean","title":"Is Extension","description":"Set to true if to_number is an extension (1-8 digits only) to bypass international number validation","default":false},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata","description":"Any extra metadata for call"},"scheduled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Scheduled At","description":"By default the calls will be scheduled immediately. Setting this is going to override the global scheduled_at."},"latest_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Latest At","description":"latest datetime for outbound calls to be placed. if outbound calls aren't placed after this datetime, they will be marked as cancelled. Setting this is going to override the global scheduled_at."}},"type":"object","required":["to_number"],"title":"BulkOutboundCallDestination"},"Call":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The organization id this call belongs to"},"from_number":{"type":"string","title":"From Number","description":"The number that intitiated the call."},"to_number":{"type":"string","title":"To Number","description":"The destination number of the call."},"status":{"$ref":"#/components/schemas/ConversationStatus","description":"The status of the call"},"type":{"$ref":"#/components/schemas/CallType","description":"The type of the call. inbound (customer initiated) or outbound (organization initiated)."},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At","description":"the time the call started. the moment the line connected between the parties."},"phone_number_id":{"type":"string","format":"uuid4","title":"Phone Number Id","description":"the phone number id that this call happened on."},"agent_id":{"type":"string","format":"uuid4","title":"Agent Id","description":"the agent id that handled this call."},"duration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration","description":"the duration of the call in seconds."},"ended_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Ended At","description":"the time the call ended. the moment the line disconnected between the parties."},"outbound_call_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Outbound Call Id","description":"the outbound call id that generated this call attempt"},"metadata_":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata","description":"metadata of the call"},"call_recording":{"items":{"$ref":"#/components/schemas/CallRecording"},"type":"array","title":"Call Recording","description":""},"call_transcript":{"items":{"$ref":"#/components/schemas/CallTranscript"},"type":"array","title":"Call Transcript","description":""}},"type":"object","required":["created_at","updated_at","id","organization_id","from_number","to_number","status","type","phone_number_id","agent_id","call_recording","call_transcript"],"title":"Call"},"CallAnalysisPlanResolutionEvaluationPlan":{"properties":{"status_prompts":{"$ref":"#/components/schemas/ResolutionEvaluationStatusPrompts"}},"type":"object","required":["status_prompts"],"title":"CallAnalysisPlanResolutionEvaluationPlan"},"CallFlowEdge":{"properties":{"type":{"type":"string","const":"condition","title":"Type"},"source":{"type":"string","title":"Source"},"target":{"type":"string","title":"Target"},"condition":{"$ref":"#/components/schemas/EdgeCondition"}},"type":"object","required":["type","source","target","condition"],"title":"CallFlowEdge"},"CallFlowGraphV2-Input":{"properties":{"nodes":{"items":{"$ref":"#/components/schemas/CallFlowNode-Input"},"type":"array","title":"Nodes"},"edges":{"items":{"$ref":"#/components/schemas/CallFlowEdge"},"type":"array","title":"Edges"}},"type":"object","required":["nodes","edges"],"title":"CallFlowGraphV2"},"CallFlowGraphV2-Output":{"properties":{"nodes":{"items":{"$ref":"#/components/schemas/CallFlowNode-Output"},"type":"array","title":"Nodes"},"edges":{"items":{"$ref":"#/components/schemas/CallFlowEdge"},"type":"array","title":"Edges"}},"type":"object","required":["nodes","edges"],"title":"CallFlowGraphV2"},"CallFlowNode-Input":{"properties":{"name":{"type":"string","title":"Name"},"type":{"type":"string","const":"conversation","title":"Type"},"is_start":{"type":"boolean","title":"Is Start"},"metadata":{"$ref":"#/components/schemas/CallFlowNodeMetadata"},"prompt":{"type":"string","title":"Prompt"},"message_plan":{"anyOf":[{"$ref":"#/components/schemas/NodeMessagePlan"},{"type":"null"}],"deprecated":true},"run_llm_inference_on_enter":{"type":"boolean","title":"Run Llm Inference On Enter","description":"Send request to LLM as soon as the node is entered or wait for user interaction first.","default":true},"global_node_plan":{"$ref":"#/components/schemas/GlobalNodePlan"},"tools":{"items":{"$ref":"#/components/schemas/NodeTool"},"type":"array","title":"Tools"},"pre_actions":{"items":{"oneOf":[{"$ref":"#/components/schemas/EndConversationAction"},{"$ref":"#/components/schemas/SayAction"}],"discriminator":{"propertyName":"type","mapping":{"end_conversation":"#/components/schemas/EndConversationAction","tts_say":"#/components/schemas/SayAction"}}},"type":"array","title":"Pre Actions","default":[]},"post_actions":{"items":{"oneOf":[{"$ref":"#/components/schemas/EndConversationAction"},{"$ref":"#/components/schemas/ToolAction"}],"discriminator":{"propertyName":"type","mapping":{"end_conversation":"#/components/schemas/EndConversationAction","tool":"#/components/schemas/ToolAction"}}},"type":"array","title":"Post Actions","default":[]},"kbs":{"items":{"$ref":"#/components/schemas/NodeKnowledgeBase"},"type":"array","title":"Kbs","default":[]}},"type":"object","required":["name","type","is_start","metadata","prompt","global_node_plan","tools"],"title":"CallFlowNode"},"CallFlowNode-Output":{"properties":{"name":{"type":"string","title":"Name"},"type":{"type":"string","const":"conversation","title":"Type"},"is_start":{"type":"boolean","title":"Is Start"},"metadata":{"$ref":"#/components/schemas/CallFlowNodeMetadata"},"prompt":{"type":"string","title":"Prompt"},"message_plan":{"anyOf":[{"$ref":"#/components/schemas/NodeMessagePlan"},{"type":"null"}],"deprecated":true},"run_llm_inference_on_enter":{"type":"boolean","title":"Run Llm Inference On Enter","description":"Send request to LLM as soon as the node is entered or wait for user interaction first.","default":true},"global_node_plan":{"$ref":"#/components/schemas/GlobalNodePlan"},"tools":{"items":{"$ref":"#/components/schemas/NodeTool"},"type":"array","title":"Tools"},"pre_actions":{"items":{"oneOf":[{"$ref":"#/components/schemas/EndConversationAction"},{"$ref":"#/components/schemas/SayAction"}],"discriminator":{"propertyName":"type","mapping":{"end_conversation":"#/components/schemas/EndConversationAction","tts_say":"#/components/schemas/SayAction"}}},"type":"array","title":"Pre Actions","default":[]},"post_actions":{"items":{"oneOf":[{"$ref":"#/components/schemas/EndConversationAction"},{"$ref":"#/components/schemas/ToolAction"}],"discriminator":{"propertyName":"type","mapping":{"end_conversation":"#/components/schemas/EndConversationAction","tool":"#/components/schemas/ToolAction"}}},"type":"array","title":"Post Actions","default":[]},"kbs":{"items":{"$ref":"#/components/schemas/NodeKnowledgeBase"},"type":"array","title":"Kbs","default":[]}},"type":"object","required":["name","type","is_start","metadata","prompt","global_node_plan","tools"],"title":"CallFlowNode"},"CallFlowNodeMetadata":{"properties":{"position":{"$ref":"#/components/schemas/NodePosition"}},"type":"object","required":["position"],"title":"CallFlowNodeMetadata"},"CallFlowSchema":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"name":{"type":"string","title":"Name"},"graph_data":{"additionalProperties":true,"type":"object","title":"Graph Data"},"version":{"type":"integer","title":"Version"}},"type":"object","required":["id","name","graph_data","version"],"title":"CallFlowSchema"},"CallFlowV1":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The organization id this call flow belongs to"},"name":{"type":"string","title":"Name","description":"The name of the call flow"},"flow":{"type":"string","title":"Flow","description":"please don't use this field, it will be removed in future releases","default":"","deprecated":true},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"description of call flow for users to have more context or summary of the call flow."},"version":{"type":"integer","const":1,"title":"Version"},"graph_data":{"additionalProperties":true,"type":"object","title":"Graph Data","description":"the graph data"}},"type":"object","required":["created_at","updated_at","id","organization_id","name","version","graph_data"],"title":"CallFlowV1"},"CallFlowV2":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The organization id this call flow belongs to"},"name":{"type":"string","title":"Name","description":"The name of the call flow"},"flow":{"type":"string","title":"Flow","description":"please don't use this field, it will be removed in future releases","default":"","deprecated":true},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"description of call flow for users to have more context or summary of the call flow."},"version":{"type":"integer","const":2,"title":"Version"},"graph_data":{"$ref":"#/components/schemas/CallFlowGraphV2-Output","description":"the graph data"}},"type":"object","required":["created_at","updated_at","id","organization_id","name","version","graph_data"],"title":"CallFlowV2"},"CallListExportCsvRequest":{"properties":{"status":{"anyOf":[{"$ref":"#/components/schemas/ConversationStatus"},{"items":{"$ref":"#/components/schemas/ConversationStatus"},"type":"array"},{"type":"null"}],"title":"Status","description":"Filter by call status (supports multiple values)"},"phone_number_id":{"anyOf":[{"type":"string","format":"uuid4"},{"items":{"type":"string","format":"uuid4"},"type":"array"},{"type":"null"}],"title":"Phone Number Id","description":"Filter by phone number ID (supports multiple values)"},"agent_id":{"anyOf":[{"type":"string","format":"uuid4"},{"items":{"type":"string","format":"uuid4"},"type":"array"},{"type":"null"}],"title":"Agent Id","description":"Filter by agent ID (supports multiple values)"},"call_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Call Id","description":"Filter by specific call ID"},"from_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From Number","description":"Filter by from_number"},"to_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Number","description":"Filter by to_number"},"min_duration":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Min Duration","description":"Minimum duration in seconds"},"max_duration":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Max Duration","description":"Maximum duration in seconds"},"type":{"anyOf":[{"$ref":"#/components/schemas/CallType"},{"type":"null"}],"description":"Call type to fetch. By default inbound and outbound calls are fetched."},"time_range":{"$ref":"#/components/schemas/TimeRangeFilterSchema","description":"Time range for filtering calls by started_at. Supports absolute ISO 8601, relative ('-7d', '-1m'), and 'now'."},"filters":{"anyOf":[{"$ref":"#/components/schemas/FilterGroupSchema-Input"},{"type":"null"}],"description":"Advance filter groups with AND/OR operators. Supports Call table columns (e.g. 'agent_id', 'status') and structured output value references (e.g. 'structured_output.{uuid}.value')."},"include_structured_outputs":{"type":"boolean","title":"Include Structured Outputs","description":"When true, structured output results are included as columns in the exported CSV. Format 'SO.{id} ({name})'","default":false}},"type":"object","title":"CallListExportCsvRequest"},"CallListExportCsvResponse":{"properties":{"url":{"type":"string","title":"Url","description":"CSV file URL"}},"type":"object","required":["url"],"title":"CallListExportCsvResponse"},"CallListRequest":{"properties":{"status":{"anyOf":[{"$ref":"#/components/schemas/ConversationStatus"},{"items":{"$ref":"#/components/schemas/ConversationStatus"},"type":"array"},{"type":"null"}],"title":"Status","description":"Filter by call status (supports multiple values)"},"phone_number_id":{"anyOf":[{"type":"string","format":"uuid4"},{"items":{"type":"string","format":"uuid4"},"type":"array"},{"type":"null"}],"title":"Phone Number Id","description":"Filter by phone number ID (supports multiple values)"},"agent_id":{"anyOf":[{"type":"string","format":"uuid4"},{"items":{"type":"string","format":"uuid4"},"type":"array"},{"type":"null"}],"title":"Agent Id","description":"Filter by agent ID (supports multiple values)"},"call_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Call Id","description":"Filter by specific call ID"},"from_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From Number","description":"Filter by from_number"},"to_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Number","description":"Filter by to_number"},"min_duration":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Min Duration","description":"Minimum duration in seconds"},"max_duration":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Max Duration","description":"Maximum duration in seconds"},"type":{"anyOf":[{"$ref":"#/components/schemas/CallType"},{"type":"null"}],"description":"Call type to fetch. By default inbound and outbound calls are fetched."},"time_range":{"$ref":"#/components/schemas/TimeRangeFilterSchema","description":"Time range for filtering calls by started_at. Supports absolute ISO 8601, relative ('-7d', '-1m'), and 'now'."},"filters":{"anyOf":[{"$ref":"#/components/schemas/FilterGroupSchema-Input"},{"type":"null"}],"description":"Advance filter groups with AND/OR operators. Supports Call table columns (e.g. 'agent_id', 'status') and structured output value references (e.g. 'structured_output.{uuid}.value')."},"pagination":{"$ref":"#/components/schemas/PaginationParamsBody","description":"Pagination parameters."}},"type":"object","title":"CallListRequest","description":"List calls request body (includes pagination)."},"CallRecording":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"stereo recording of both the user and the agent, where the left channel contains user audio and the right channel contains agent audio. URL is valid for 24 hours."}},"type":"object","required":["id"],"title":"CallRecording"},"CallStructuredOutputResult":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"structured_output":{"$ref":"#/components/schemas/StructuredOutputDefinition","description":"Structured output definition for this result."},"structured_output_id":{"type":"string","format":"uuid4","title":"Structured Output Id","description":"Structured output id that this result is based on."},"value":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"},{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"null"}],"title":"Value","description":"The structured output result value. The format depends on the structured output json schema. e.g, if schema type is 'number', the output value here will be integer"},"found":{"type":"boolean","title":"Found","description":"If the AI analyser found explicit/implicit mentions of the requiredsturcutred output in the transcript.","default":false}},"type":"object","required":["created_at","updated_at","id","structured_output","structured_output_id","value"],"title":"CallStructuredOutputResult"},"CallTranscript":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"open_ai_format":{"anyOf":[{"items":{},"type":"array"},{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Open Ai Format","description":"the context that got generated from the call"}},"type":"object","required":["id","open_ai_format"],"title":"CallTranscript"},"CallTransferType":{"type":"string","enum":["blind_transfer","warm_transfer","sip_request"],"title":"CallTransferType"},"CallType":{"type":"string","enum":["inbound","outbound"],"title":"CallType"},"CallsAnalyticsRequest":{"properties":{"time_range":{"$ref":"#/components/schemas/TimeRangeFilterSchema","description":"Time range for analytics query."},"filters":{"$ref":"#/components/schemas/AnalyticsFiltersSchema","description":"Optional filters to apply to the analytics query."}},"type":"object","title":"CallsAnalyticsRequest"},"CallsAnalyticsResponse":{"properties":{"calls_total":{"type":"integer","title":"Calls Total","description":"Total number of calls in the time range."},"calls_avg_duration":{"type":"integer","title":"Calls Avg Duration","description":"Average call duration in seconds."},"calls_missed":{"type":"integer","title":"Calls Missed","description":"Number of missed/failed calls (failed, busy, no_answer)."},"calls_answered":{"type":"integer","title":"Calls Answered","description":"Number of successfully answered calls (completed)."},"resolution_evaluation":{"$ref":"#/components/schemas/EvaluationChart","description":"Resolution evaluation breakdown."},"calls_by_agent":{"anyOf":[{"items":{"$ref":"#/components/schemas/KeyValue"},"type":"array"},{"type":"null"}],"title":"Calls By Agent","description":"Call count breakdown by agent."},"calls_by_week_hours":{"items":{"$ref":"#/components/schemas/CallsByWeekHours"},"type":"array","title":"Calls By Week Hours","description":"Call distribution by day of week and hour."}},"type":"object","required":["calls_total","calls_avg_duration","calls_missed","calls_answered"],"title":"CallsAnalyticsResponse"},"CallsByWeekHours":{"properties":{"day":{"type":"string","title":"Day"},"hour":{"type":"integer","title":"Hour"},"calls":{"type":"integer","title":"Calls"}},"type":"object","required":["day","hour","calls"],"title":"CallsByWeekHours"},"CampaignAnalyticsResponse":{"properties":{"outbound_calls_scheduled":{"type":"integer","title":"Outbound Calls Scheduled"},"outbound_calls_made":{"type":"integer","title":"Outbound Calls Made"},"outbound_calls_answered":{"type":"integer","title":"Outbound Calls Answered"},"outbound_calls_failed":{"type":"integer","title":"Outbound Calls Failed"},"first_attempt_answered_calls":{"type":"integer","title":"First Attempt Answered Calls"},"average_attempts_to_answer_call":{"type":"number","title":"Average Attempts To Answer Call"},"average_call_duration":{"type":"integer","title":"Average Call Duration"}},"type":"object","required":["outbound_calls_scheduled","outbound_calls_made","outbound_calls_answered","outbound_calls_failed","first_attempt_answered_calls","average_attempts_to_answer_call","average_call_duration"],"title":"CampaignAnalyticsResponse"},"CampaignDestinationSchema":{"properties":{"to_number":{"type":"string","title":"To Number"},"meta_data":{"additionalProperties":true,"type":"object","title":"Meta Data"}},"type":"object","required":["to_number","meta_data"],"title":"CampaignDestinationSchema"},"CampaignDetailsSchema":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid","title":"Organization Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"phone_number_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Phone Number Id"},"agent_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Id"},"retry_policy_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Retry Policy Id"},"status":{"$ref":"#/components/schemas/CampaignStatus"},"type":{"$ref":"#/components/schemas/CampaignType"},"call_flow":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Flow"},"desired_outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Desired Outcome"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At"},"retry_policy":{"anyOf":[{"$ref":"#/components/schemas/RetryPolicy"},{"type":"null"}]},"agent":{"anyOf":[{"$ref":"#/components/schemas/InboundConfigSchema"},{"type":"null"}]},"phone_number":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/MawjPhoneNumber"},{"$ref":"#/components/schemas/SipRegisterPhoneNumber"},{"$ref":"#/components/schemas/MaqsamPhoneNumber"},{"$ref":"#/components/schemas/LiveKitPhoneNumber"}],"discriminator":{"propertyName":"type","mapping":{"livekit":"#/components/schemas/LiveKitPhoneNumber","maqsam":"#/components/schemas/MaqsamPhoneNumber","mawj":"#/components/schemas/MawjPhoneNumber","sip_register":"#/components/schemas/SipRegisterPhoneNumber"}}},{"type":"null"}],"title":"Phone Number"},"phone_numbers":{"items":{"$ref":"#/components/schemas/CampaignPhoneNumbersSchema"},"type":"array","title":"Phone Numbers"}},"type":"object","required":["id","organization_id","name","description","phone_number_id","agent_id","retry_policy_id","status","type","call_flow","desired_outcome","created_at","updated_at","retry_policy","agent","phone_number","phone_numbers"],"title":"CampaignDetailsSchema"},"CampaignInsightsSchema":{"properties":{"calls_scheduled":{"type":"integer","title":"Calls Scheduled"},"calls_made":{"type":"integer","title":"Calls Made"},"calls_answered":{"type":"integer","title":"Calls Answered"},"average_call_duration":{"type":"integer","title":"Average Call Duration"}},"type":"object","required":["calls_scheduled","calls_made","calls_answered","average_call_duration"],"title":"CampaignInsightsSchema"},"CampaignPhoneNumbersSchema":{"properties":{"to_number":{"type":"string","title":"To Number"},"meta_data":{"additionalProperties":true,"type":"object","title":"Meta Data"}},"type":"object","required":["to_number","meta_data"],"title":"CampaignPhoneNumbersSchema"},"CampaignSchema":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"CampaignSchema"},"CampaignStatus":{"type":"string","enum":["draft","scheduled","active","paused","completed"],"title":"CampaignStatus"},"CampaignType":{"type":"string","enum":["research","sales","reminders","collect_and_verify","retention","general"],"title":"CampaignType"},"ChatConversationSchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"Organization associated with this conversation"},"reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Id","description":"Custom reference id for conversation in your system"},"chat_connector_id":{"type":"string","format":"uuid4","title":"Chat Connector Id","description":"Chat connector id used in this conversation"},"meta_data":{"additionalProperties":true,"type":"object","title":"Meta Data","description":"Conversation metadata"},"active":{"type":"boolean","title":"Active","description":"If the conversation is active or not"},"chat_user":{"$ref":"#/components/schemas/ChatUserSchema"}},"type":"object","required":["created_at","updated_at","id","organization_id","chat_connector_id","meta_data","active","chat_user"],"title":"ChatConversationSchema"},"ChatUserSchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid","title":"Organization Id","description":"Organization id"},"external_id":{"type":"string","title":"External Id","description":"User identifier in your system"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"User name"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"User phone in E.164 standard format"}},"type":"object","required":["created_at","updated_at","id","organization_id","external_id"],"title":"ChatUserSchema"},"ContinuePlan":{"properties":{"exit_on_failure_enabled":{"type":"boolean","title":"Exit On Failure Enabled","description":"Stop test execution if this evaluation fails","default":false},"content_override":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Override","description":"Override assistant response content if evaluation fails"},"tool_calls_override":{"anyOf":[{"items":{"$ref":"#/components/schemas/ToolCall"},"type":"array"},{"type":"null"}],"title":"Tool Calls Override","description":"Override tool calls if evaluation fails"}},"type":"object","title":"ContinuePlan","description":"Behavior control after evaluation","examples":[{"exit_on_failure_enabled":true},{"content_override":"Let me help you with that.","exit_on_failure_enabled":false}]},"ConversationBasicInfoSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Conversation ID"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At","description":"Conversation start timestamp"},"ended_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Ended At","description":"Conversation ended timestamp"},"duration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration","description":"Conversation duration in seconds"},"call":{"anyOf":[{"$ref":"#/components/schemas/ConversationCallBasicInfoSchema"},{"type":"null"}],"description":"Available if conversation is call."}},"type":"object","required":["id"],"title":"ConversationBasicInfoSchema"},"ConversationCallBasicInfoSchema":{"properties":{"from_number":{"type":"string","title":"From Number","description":"Caller phone number"},"to_number":{"type":"string","title":"To Number","description":"Called phone number"}},"type":"object","required":["from_number","to_number"],"title":"ConversationCallBasicInfoSchema"},"ConversationStatus":{"type":"string","enum":["pending","in_progress","completed","failed","busy","no_answer"],"title":"ConversationStatus"},"CreateAgentRule":{"properties":{"agent_rules_category_id":{"type":"string","format":"uuid","title":"Agent Rules Category Id","description":"Category to place the rule under"},"title":{"type":"string","maxLength":500,"minLength":1,"title":"Title","description":"Rule title"},"content":{"type":"string","minLength":1,"title":"Content","description":"Rule content / instructions"}},"type":"object","required":["agent_rules_category_id","title","content"],"title":"CreateAgentRule","description":"Request body to create an agent rule."},"CreateApiCallAction":{"properties":{"name":{"type":"string","minLength":1,"title":"Name","description":"Action name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"timeout":{"type":"integer","minimum":100.0,"title":"Timeout","description":"Timeout in milliseconds","default":10000},"inbound_config_ids":{"anyOf":[{"items":{"type":"string","format":"uuid4"},"type":"array"},{"type":"null"}],"title":"Inbound Config Ids","description":"IDs of agents this action is assigned to"},"type":{"type":"string","const":"api_call","title":"Type"},"config":{"$ref":"#/components/schemas/ApiCallConfig"},"function":{"$ref":"#/components/schemas/ActionFunctionDef-Input","description":"Function schema for input parameters"}},"type":"object","required":["name","type","config","function"],"title":"CreateApiCallAction"},"CreateBulkOutboundCallRequest":{"properties":{"phone_number_id":{"type":"string","format":"uuid4","title":"Phone Number Id"},"agent_id":{"type":"string","format":"uuid4","title":"Agent Id"},"destinations":{"items":{"$ref":"#/components/schemas/BulkOutboundCallDestination"},"type":"array","maxItems":5000,"title":"Destinations","description":"Outbound call destinations. Up to 5000 numbers can be submitted at a time."},"scheduled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Scheduled At","description":"By default the calls will be scheduled immediately"},"latest_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Latest At","description":"latest datetime for outbound calls to be placed. if outbound calls aren't placed after this datetime, they will be marked as cancelled."},"retry_policy":{"$ref":"#/components/schemas/CreateRetryPolicy","description":"Specify a retry policy or default will be used"}},"type":"object","required":["phone_number_id","agent_id","destinations"],"title":"CreateBulkOutboundCallRequest"},"CreateBulkOutboundCallResponse":{"properties":{"organization_id":{"type":"string","format":"uuid4","title":"Organization Id"},"phone_number_id":{"type":"string","format":"uuid4","title":"Phone Number Id"},"agent_id":{"type":"string","format":"uuid4","title":"Agent Id"},"retry_policy":{"$ref":"#/components/schemas/RetryPolicy"},"destinations":{"items":{"$ref":"#/components/schemas/OutboundCall"},"type":"array","title":"Destinations"}},"type":"object","required":["organization_id","phone_number_id","agent_id","retry_policy","destinations"],"title":"CreateBulkOutboundCallResponse"},"CreateCallFlowV1":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the call flow"},"flow":{"type":"string","title":"Flow","description":"please don't use this field, it will be removed in future releases","default":"","deprecated":true},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"description of call flow for users to have more context or summary of the call flow."},"version":{"type":"integer","const":1,"title":"Version"},"graph_data":{"additionalProperties":true,"type":"object","title":"Graph Data","description":"the graph data"}},"type":"object","required":["name","version","graph_data"],"title":"CreateCallFlowV1"},"CreateCallFlowV2":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the call flow"},"flow":{"type":"string","title":"Flow","description":"please don't use this field, it will be removed in future releases","default":"","deprecated":true},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"description of call flow for users to have more context or summary of the call flow."},"version":{"type":"integer","const":2,"title":"Version"},"graph_data":{"$ref":"#/components/schemas/CallFlowGraphV2-Input","description":"the graph data"}},"type":"object","required":["name","version","graph_data"],"title":"CreateCallFlowV2"},"CreateCampaignRequest":{"properties":{"name":{"type":"string","title":"Name"},"type":{"$ref":"#/components/schemas/CampaignType"},"agent_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Agent Id"}},"type":"object","required":["name","type","agent_id"],"title":"CreateCampaignRequest"},"CreateChatUser":{"properties":{"external_id":{"type":"string","maxLength":256,"minLength":1,"title":"External Id","description":"User identifier on your system. example: phone number or DB id. This id will be used to uniquely identify each chat user and it's conversations."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"User name. If provided, it will be embeded into agent prompt config"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"User phone number. If provided, it will embed into agent prompt config. It must be in E.164 phone number format"}},"type":"object","required":["external_id"],"title":"CreateChatUser"},"CreateConversation":{"properties":{"connector_id":{"type":"string","format":"uuid4","title":"Connector Id","description":"Chat connector id"},"chat_user_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Chat User Id","description":"Existing chat user UUID. If provided, it will be given priority over user_external_id. We recommend using explicitly provided APIs for managing chat users to ensure consistent behavior."},"user_external_id":{"anyOf":[{"type":"string","maxLength":256,"minLength":1},{"type":"null"}],"title":"User External Id","description":"User identifier on your system. example: phone number or DB id. This id will be used to uniquely identify each chat user and it's conversations"},"user_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Name","description":"User name. If provided, it will be embeded into agent prompt config"},"user_phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Phone","description":"User phone number. If provided, it will embed into agent prompt config. It must be in E.164 phone number format"},"conversation_reference_id":{"anyOf":[{"type":"string","maxLength":45,"minLength":1},{"type":"null"}],"title":"Conversation Reference Id","description":"Custom user's conversation reference id in your system. If provided, it will be used to get / create existing conversation of the user. It is helpful to reference conversations via internal identifiers in your system."},"meta_data":{"additionalProperties":true,"type":"object","title":"Meta Data","description":"Any meta_data (key/value). It will be embeded into agent prompt as dynamic conversation context.","default":{}}},"type":"object","required":["connector_id"],"title":"CreateConversation"},"CreateGoogleSheetsRowAppendAction":{"properties":{"name":{"type":"string","minLength":1,"title":"Name","description":"Action name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"timeout":{"type":"integer","minimum":100.0,"title":"Timeout","description":"Timeout in milliseconds","default":10000},"inbound_config_ids":{"anyOf":[{"items":{"type":"string","format":"uuid4"},"type":"array"},{"type":"null"}],"title":"Inbound Config Ids","description":"IDs of agents this action is assigned to"},"type":{"type":"string","const":"google.sheets.row.append","title":"Type"},"config":{"$ref":"#/components/schemas/GoogleSheetsRowAppendConfig"},"function":{"$ref":"#/components/schemas/ActionFunctionDef-Input","description":"Function schema for input parameters"}},"type":"object","required":["name","type","config","function"],"title":"CreateGoogleSheetsRowAppendAction"},"CreateKnowledgeBaseAction":{"properties":{"name":{"type":"string","maxLength":64,"minLength":1,"pattern":"^[\\w \\-]*\\w[\\w \\-]*$","title":"Name","description":"Action name. Used as the LLM tool name -- must match ``^[\\w-]{1,64}$`` (letters, digits, underscore, hyphen)."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"timeout":{"type":"integer","minimum":100.0,"title":"Timeout","description":"Timeout in milliseconds","default":10000},"inbound_config_ids":{"anyOf":[{"items":{"type":"string","format":"uuid4"},"type":"array"},{"type":"null"}],"title":"Inbound Config Ids","description":"IDs of agents this action is assigned to"},"type":{"type":"string","const":"knowledge_base","title":"Type"},"config":{"$ref":"#/components/schemas/KnowledgeBaseActionConfig"},"function":{"type":"null","title":"Function","description":"Function schema is auto-generated at runtime from the referenced knowledge bases"}},"type":"object","required":["name","type","config"],"title":"CreateKnowledgeBaseAction"},"CreateLiveKitPhoneNumber":{"properties":{"name":{"type":"string","title":"Name","description":"Phone number name"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Is phone number active and accepting calls","default":false},"inbound_config_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Inbound Config Id","description":"Inbound config/agent ID"},"type":{"type":"string","const":"livekit","title":"Type"},"config":{"$ref":"#/components/schemas/LiveKitPhoneNumberConfig"}},"type":"object","required":["name","type","config"],"title":"CreateLiveKitPhoneNumber"},"CreateMCPAction":{"properties":{"name":{"type":"string","minLength":1,"title":"Name","description":"Action name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"timeout":{"type":"integer","minimum":100.0,"title":"Timeout","description":"Timeout in milliseconds","default":10000},"inbound_config_ids":{"anyOf":[{"items":{"type":"string","format":"uuid4"},"type":"array"},{"type":"null"}],"title":"Inbound Config Ids","description":"IDs of agents this action is assigned to"},"type":{"type":"string","const":"mcp","title":"Type"},"config":{"$ref":"#/components/schemas/MCPConfig-Input"},"function":{"type":"null","title":"Function","description":"MCP does not support function schema"}},"type":"object","required":["name","type","config"],"title":"CreateMCPAction"},"CreateMaqsamPhoneNumber":{"properties":{"name":{"type":"string","title":"Name","description":"Phone number name"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Is phone number active and accepting calls","default":false},"inbound_config_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Inbound Config Id","description":"Inbound config/agent ID"},"type":{"type":"string","const":"maqsam","title":"Type"},"config":{"$ref":"#/components/schemas/MaqsamPhoneNumberConfig"}},"type":"object","required":["name","type","config"],"title":"CreateMaqsamPhoneNumber"},"CreateMawjPhoneNumber":{"properties":{"name":{"type":"string","title":"Name","description":"Phone number name"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Is phone number active and accepting calls","default":false},"inbound_config_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Inbound Config Id","description":"Inbound config/agent ID"},"type":{"type":"string","const":"mawj","title":"Type"},"config":{"$ref":"#/components/schemas/InhousePhoneNumberConfig"}},"type":"object","required":["name","type","config"],"title":"CreateMawjPhoneNumber"},"CreateOutboundCallRequest":{"properties":{"phone_number_id":{"type":"string","format":"uuid4","title":"Phone Number Id"},"agent_id":{"type":"string","format":"uuid4","title":"Agent Id"},"to_number":{"type":"string","title":"To Number","description":"The phone / extension number to call"},"is_extension":{"type":"boolean","title":"Is Extension","description":"Set to true if to_number is an extension (1-8 digits only) to bypass international number validation","default":false},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata","description":"Any extra metadata for call","default":{}},"scheduled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Scheduled At","description":"By default the call will be scheduled immediately"},"latest_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Latest At","description":"latest datetime for the outbound call to be placed. if the outbound call isn't placed after this datetime, it will be marked as cancelled."},"retry_policy":{"$ref":"#/components/schemas/CreateRetryPolicy","description":"Specify a retry policy or default will be used"}},"type":"object","required":["phone_number_id","agent_id","to_number"],"title":"CreateOutboundCallRequest"},"CreateOutboundCallResponse":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"the organization id that owns the outbound call."},"phone_number_id":{"type":"string","format":"uuid4","title":"Phone Number Id","description":"The phone number that is going to be used for the outbound call."},"to_number":{"type":"string","title":"To Number","description":"the destination of the outbound call."},"agent_id":{"type":"string","format":"uuid4","title":"Agent Id","description":"the agent id that is going to handle the outbound call."},"status":{"$ref":"#/components/schemas/OutboundCallStatus","description":"current status of the outbound call."},"retry_number":{"type":"integer","title":"Retry Number","description":"how many retry attempts did the outbound make so far."},"scheduled_at":{"type":"string","format":"date-time","title":"Scheduled At","description":"initial datetime for the outbound call to be placed."},"latest_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Latest At","description":"latest datetime for the outbound call to be placed. if the outbound call isn't placed after this datetime, it will be marked as cancelled."},"marked_to_be_canceled":{"type":"boolean","title":"Marked To Be Canceled","description":"if the outbound call is in the process of being cancelled, this flag will be true."},"next_retry_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Retry Time","description":"If set, it will indicate the next attempt datetime of the outbound call."},"latest_call_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Latest Call Id","description":"the call id of the last attemept made for the outbound call."},"metadata_":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata","description":"metadata passed for the outbound call."},"campaign_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Campaign Id","description":"campaign id of outbound call."},"retry_policy_id":{"type":"string","format":"uuid4","title":"Retry Policy Id","description":"retry policy the outbound call uses."},"retry_policy":{"anyOf":[{"$ref":"#/components/schemas/RetryPolicy"},{"type":"null"}],"description":"retry policy used for this outbound call."}},"type":"object","required":["created_at","updated_at","id","organization_id","phone_number_id","to_number","agent_id","status","retry_number","scheduled_at","marked_to_be_canceled","retry_policy_id"],"title":"CreateOutboundCallResponse"},"CreateRetryPolicy":{"properties":{"initial_interval_ms":{"type":"integer","minimum":60000.0,"title":"Initial Interval Ms","description":"Minimun initial interval between retries (min: 1 minute)","default":60000},"maximum_interval_ms":{"anyOf":[{"type":"integer","maximum":604800000.0},{"type":"null"}],"title":"Maximum Interval Ms","description":"Maximum interval between retries (max: 7 days)"},"backoff_coefficient":{"anyOf":[{"type":"number"},{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"}],"title":"Backoff Coefficient","description":"Used for calculating next retry attempt","default":"1"},"maximum_attempts":{"type":"integer","minimum":1.0,"title":"Maximum Attempts","description":"Maximum call attempts (min: 1)","default":1},"minimum_attempt_time":{"type":"string","format":"time","title":"Minimum Attempt Time","description":"Minimum time for attempt","default":"00:00:00","examples":["0500","05:00"]},"maximum_attempt_time":{"type":"string","format":"time","title":"Maximum Attempt Time","description":"Maximum time for attempt","default":"23:59:00","examples":["1500","15:00"]},"attempt_days":{"items":{"$ref":"#/components/schemas/DayOfWeek"},"type":"array","title":"Attempt Days","description":"Days of call attempt","default":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]}},"type":"object","title":"CreateRetryPolicy"},"CreateSipRegisterPhoneNumber":{"properties":{"name":{"type":"string","title":"Name","description":"Phone number name"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Is phone number active and accepting calls","default":false},"inbound_config_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Inbound Config Id","description":"Inbound config/agent ID"},"type":{"type":"string","const":"sip_register","title":"Type"},"config":{"$ref":"#/components/schemas/CreateSipRegisterPhoneNumberConfig"}},"type":"object","required":["name","type","config"],"title":"CreateSipRegisterPhoneNumber"},"CreateSipRegisterPhoneNumberConfig":{"properties":{"number":{"type":"string","title":"Number","description":"Phone number"},"username":{"type":"string","title":"Username","description":"SIP username"},"password":{"type":"string","title":"Password","description":"SIP password"},"includeAuth":{"type":"boolean","title":"Includeauth","default":false},"overrideToEnabled":{"type":"boolean","title":"Overridetoenabled","default":false},"toNumberPrefix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tonumberprefix"},"fromEnableLeadingPlus":{"type":"boolean","title":"Fromenableleadingplus","default":true},"sip_request_defaults":{"anyOf":[{"$ref":"#/components/schemas/SipRequestDefaults"},{"type":"null"}],"description":"Optional default SIP request headers emitted at call start."}},"type":"object","required":["number","username","password"],"title":"CreateSipRegisterPhoneNumberConfig","description":"Limited config for creating SIP register (excludes Jambonz-managed fields)"},"CreateTransferCallAction":{"properties":{"name":{"type":"string","minLength":1,"title":"Name","description":"Action name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"timeout":{"type":"integer","minimum":100.0,"title":"Timeout","description":"Timeout in milliseconds","default":10000},"inbound_config_ids":{"anyOf":[{"items":{"type":"string","format":"uuid4"},"type":"array"},{"type":"null"}],"title":"Inbound Config Ids","description":"IDs of agents this action is assigned to"},"type":{"type":"string","const":"transfer_call","title":"Type"},"config":{"$ref":"#/components/schemas/TransferCallConfig-Input"},"function":{"type":"null","title":"Function"}},"type":"object","required":["name","type","config"],"title":"CreateTransferCallAction"},"CreateTransferChatRespondioAction":{"properties":{"name":{"type":"string","minLength":1,"title":"Name","description":"Action name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"timeout":{"type":"integer","minimum":100.0,"title":"Timeout","description":"Timeout in milliseconds","default":10000},"inbound_config_ids":{"anyOf":[{"items":{"type":"string","format":"uuid4"},"type":"array"},{"type":"null"}],"title":"Inbound Config Ids","description":"IDs of agents this action is assigned to"},"type":{"type":"string","const":"transfer_chat_respondio","title":"Type"},"config":{"$ref":"#/components/schemas/TransferChatRespondioConfig"},"function":{"type":"null","title":"Function","description":"Does not support function schema"}},"type":"object","required":["name","type","config"],"title":"CreateTransferChatRespondioAction"},"CustomActionLookupSchema":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"type":{"$ref":"#/components/schemas/ActionType"}},"type":"object","required":["id","name","type"],"title":"CustomActionLookupSchema","description":"Schema for custom action lookup."},"DayOfWeek":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"title":"DayOfWeek"},"DeleteCampaignResponse":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"DeleteCampaignResponse"},"EdgeCondition":{"properties":{"type":{"type":"string","const":"ai","title":"Type"},"prompt":{"type":"string","title":"Prompt"}},"type":"object","required":["type","prompt"],"title":"EdgeCondition"},"EndConversationAction":{"properties":{"type":{"type":"string","const":"end_conversation","title":"Type"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text","description":"message to say right before ending the conversation"}},"type":"object","required":["type"],"title":"EndConversationAction"},"ErrorCategory":{"type":"string","enum":["validation","authentication","connection","server_error","rate_limit","unknown"],"title":"ErrorCategory"},"EvalRunFailReason":{"type":"string","enum":["duplicate_run_still_in_progress","eval_turn_failed","llm_inference_error","workflow_error"],"title":"EvalRunFailReason"},"EvalRunResult":{"properties":{"status":{"$ref":"#/components/schemas/JudgeResultStatus"},"fail_reason":{"anyOf":[{"$ref":"#/components/schemas/EvalRunFailReason"},{"type":"null"}]},"fail_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fail Message"},"messages":{"items":{"anyOf":[{"$ref":"#/components/schemas/UserMessage"},{"$ref":"#/components/schemas/RunAssistantMessage"},{"$ref":"#/components/schemas/ToolMessage"}]},"type":"array","title":"Messages","description":"Array of conversation messages"}},"type":"object","required":["status","messages"],"title":"EvalRunResult"},"EvalRunStatus":{"type":"string","enum":["running","done"],"title":"EvalRunStatus"},"EvalTestCaseCreate":{"properties":{"name":{"type":"string","maxLength":500,"minLength":1,"title":"Name","description":"Test case name"},"agent_id":{"type":"string","format":"uuid4","title":"Agent Id","description":"the agent id that is going to be tested."},"description":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Description","description":"Optional description of what this test validates"},"messages":{"items":{"anyOf":[{"$ref":"#/components/schemas/UserMessage"},{"$ref":"#/components/schemas/AssistantMessage-Input"},{"$ref":"#/components/schemas/ToolMessage"}]},"type":"array","minItems":1,"title":"Messages","description":"Array of conversation messages"}},"type":"object","required":["name","agent_id","messages"],"title":"EvalTestCaseCreate","description":"Schema for creating a new eval test case"},"EvalTestCaseResponse":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"Organization ID"},"agent_id":{"type":"string","format":"uuid4","title":"Agent Id","description":"the agent id that is going to be tested."},"name":{"type":"string","title":"Name","description":"Test case name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Test case description"},"messages":{"items":{"anyOf":[{"$ref":"#/components/schemas/UserMessage"},{"$ref":"#/components/schemas/AssistantMessage-Output"},{"$ref":"#/components/schemas/ToolMessage"}]},"type":"array","title":"Messages","description":"Array of conversation messages"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At","description":"Soft delete timestamp (null if not deleted)"}},"type":"object","required":["created_at","updated_at","id","organization_id","agent_id","name","messages"],"title":"EvalTestCaseResponse","description":"Response schema for eval test case with timestamps"},"EvalTestCaseRun":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"Organization ID"},"agent_id":{"type":"string","format":"uuid4","title":"Agent Id","description":"Agent ID"},"eval_test_case_id":{"type":"string","format":"uuid4","title":"Eval Test Case Id","description":"Eval Test Case ID"},"status":{"$ref":"#/components/schemas/EvalRunStatus","description":"status of the run, whether it's running or done."},"result":{"anyOf":[{"$ref":"#/components/schemas/EvalRunResult"},{"type":"null"}],"description":"the result of the run. not empty if status is `done`."},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At","description":"Soft delete timestamp (null if not deleted)"}},"type":"object","required":["created_at","updated_at","id","organization_id","agent_id","eval_test_case_id","status"],"title":"EvalTestCaseRun"},"EvalTestCaseRunCreate":{"properties":{"eval_test_case_id":{"type":"string","format":"uuid4","title":"Eval Test Case Id","description":"Eval Test Case ID"}},"type":"object","required":["eval_test_case_id"],"title":"EvalTestCaseRunCreate"},"EvalTestCaseUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":500,"minLength":1},{"type":"null"}],"title":"Name","description":"Test case name"},"agent_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Agent Id","description":"the agent id that is going to be tested."},"description":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Description","description":"Optional description of what this test validates"},"messages":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/UserMessage"},{"$ref":"#/components/schemas/AssistantMessage-Input"},{"$ref":"#/components/schemas/ToolMessage"}]},"type":"array","minItems":1},{"type":"null"}],"title":"Messages","description":"Array of conversation messages"}},"type":"object","title":"EvalTestCaseUpdate","description":"Schema for updating an eval test case - all fields optional"},"EvalTurnFailReason":{"type":"string","enum":["expected_content_and_tool_calls_not_matched","expected_content_not_matched","expected_tool_calls_not_matched","regex_timeout","regex_failure"],"title":"EvalTurnFailReason"},"EvaluationChart":{"properties":{"data":{"anyOf":[{"items":{"$ref":"#/components/schemas/KeyValue"},"type":"array"},{"type":"null"}],"title":"Data"},"percentage_calls":{"type":"number","title":"Percentage Calls","default":0.0}},"type":"object","title":"EvaluationChart"},"FileType":{"type":"string","enum":["pdf","text","docx"],"title":"FileType"},"FilterGroupSchema-Input":{"properties":{"operator":{"$ref":"#/components/schemas/FilterLogicalOperator","description":"Logical operator (AND/OR) to combine filters"},"filters":{"items":{"anyOf":[{"$ref":"#/components/schemas/FilterGroupSchema-Input"},{"$ref":"#/components/schemas/FilterSchema"}]},"type":"array","minItems":1,"title":"Filters","description":"List of filters or filter groups to combine"}},"type":"object","required":["operator","filters"],"title":"FilterGroupSchema"},"FilterGroupSchema-Output":{"properties":{"operator":{"$ref":"#/components/schemas/FilterLogicalOperator","description":"Logical operator (AND/OR) to combine filters"},"filters":{"items":{"anyOf":[{"$ref":"#/components/schemas/FilterGroupSchema-Output"},{"$ref":"#/components/schemas/FilterSchema"}]},"type":"array","minItems":1,"title":"Filters","description":"List of filters or filter groups to combine"}},"type":"object","required":["operator","filters"],"title":"FilterGroupSchema"},"FilterLogicalOperator":{"type":"string","enum":["and","or"],"title":"FilterLogicalOperator"},"FilterOperation":{"type":"string","enum":["=","!=",">","<",">=","<=","in","not_in","like","is_null","is_not_null","exists","not_exists"],"title":"FilterOperation"},"FilterSchema":{"properties":{"column":{"type":"string","title":"Column","description":"Column reference (e.g., 'call.status')"},"operator":{"$ref":"#/components/schemas/FilterOperation","description":"Comparison operator"},"value":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"string","format":"date-time"}]},"type":"array"},{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"string","format":"date-time"},{"type":"null"}],"title":"Value","description":"Value to compare (not needed for is_null/is_not_null)"}},"type":"object","required":["column","operator"],"title":"FilterSchema"},"Forbidden":{"properties":{"error_code":{"type":"string","const":"Forbidden","title":"Error Code","examples":["Forbidden"]},"message":{"type":"string","title":"Message"},"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Data"}},"type":"object","required":["error_code","message"],"title":"Forbidden"},"FunctionParametersDef-Input":{"properties":{"type":{"type":"string","const":"object","title":"Type","default":"object"},"required":{"items":{"type":"string"},"type":"array","title":"Required"},"properties":{"additionalProperties":{"$ref":"#/components/schemas/FunctionPropertyDef-Input"},"type":"object","title":"Properties"}},"type":"object","title":"FunctionParametersDef","description":"JSON-Schema-like parameters block."},"FunctionParametersDef-Output":{"properties":{"type":{"type":"string","const":"object","title":"Type","default":"object"},"required":{"items":{"type":"string"},"type":"array","title":"Required"},"properties":{"additionalProperties":{"$ref":"#/components/schemas/FunctionPropertyDef-Output"},"type":"object","title":"Properties"}},"type":"object","title":"FunctionParametersDef","description":"JSON-Schema-like parameters block."},"FunctionPropertyDef-Input":{"properties":{"type":{"type":"string","enum":["string","integer","number","boolean"],"title":"Type","description":"Parameter data type"},"description":{"type":"string","title":"Description","description":"Parameter description for agent","default":""},"order":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Order","description":"Order of parameter"},"enum":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Enum","description":"Enum values (only valid when type is 'string')"},"mawjValue":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mawjvalue","description":"Mawj value override for this parameter"}},"type":"object","required":["type"],"title":"FunctionPropertyDef","description":"A single property inside ``parameters.properties``."},"FunctionPropertyDef-Output":{"additionalProperties":true,"type":"object"},"GetCampaignDetailsResponse":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid","title":"Organization Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"phone_number_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Phone Number Id"},"agent_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Id"},"retry_policy_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Retry Policy Id"},"status":{"$ref":"#/components/schemas/CampaignStatus"},"type":{"$ref":"#/components/schemas/CampaignType"},"call_flow":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Flow"},"desired_outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Desired Outcome"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At"},"retry_policy":{"anyOf":[{"$ref":"#/components/schemas/RetryPolicy"},{"type":"null"}]},"agent":{"anyOf":[{"$ref":"#/components/schemas/InboundConfigSchema"},{"type":"null"}]},"phone_number":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/MawjPhoneNumber"},{"$ref":"#/components/schemas/SipRegisterPhoneNumber"},{"$ref":"#/components/schemas/MaqsamPhoneNumber"},{"$ref":"#/components/schemas/LiveKitPhoneNumber"}],"discriminator":{"propertyName":"type","mapping":{"livekit":"#/components/schemas/LiveKitPhoneNumber","maqsam":"#/components/schemas/MaqsamPhoneNumber","mawj":"#/components/schemas/MawjPhoneNumber","sip_register":"#/components/schemas/SipRegisterPhoneNumber"}}},{"type":"null"}],"title":"Phone Number"},"phone_numbers":{"items":{"$ref":"#/components/schemas/CampaignPhoneNumbersSchema"},"type":"array","title":"Phone Numbers"},"insights":{"anyOf":[{"$ref":"#/components/schemas/CampaignInsightsSchema"},{"type":"null"}]}},"type":"object","required":["id","organization_id","name","description","phone_number_id","agent_id","retry_policy_id","status","type","call_flow","desired_outcome","created_at","updated_at","retry_policy","agent","phone_number","phone_numbers"],"title":"GetCampaignDetailsResponse"},"GlobalNodePlan":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":false},"enter_condition":{"anyOf":[{"type":"string","minLength":3},{"type":"null"}],"title":"Enter Condition"}},"type":"object","title":"GlobalNodePlan"},"GoogleSheetsActionSchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"timeout":{"type":"integer","title":"Timeout"},"inbound_config_ids":{"items":{"type":"string","format":"uuid4"},"type":"array","title":"Inbound Config Ids","description":"IDs of agents this action is assigned to"},"type":{"type":"string","const":"google.sheets.row.append","title":"Type"},"config":{"$ref":"#/components/schemas/GoogleSheetsRowAppendConfig"},"function":{"$ref":"#/components/schemas/ActionFunctionDef-Output"}},"type":"object","required":["created_at","updated_at","id","organization_id","name","timeout","type","config","function"],"title":"GoogleSheetsActionSchema"},"GoogleSheetsRowAppendConfig":{"properties":{"spreadSheetId":{"type":"string","title":"Spreadsheetid","description":"Google Sheet ID"},"range":{"type":"string","title":"Range","description":"Sheet range, e.g. Sheet1!A1:B2"}},"type":"object","required":["spreadSheetId","range"],"title":"GoogleSheetsRowAppendConfig","description":"Configuration for a Google Sheets row-append action."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"IDSchema":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."}},"type":"object","required":["id"],"title":"IDSchema"},"ImprovementCategorySchema":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"slug":{"type":"string","title":"Slug","description":"Category slug identifier"},"name":{"type":"string","title":"Name","description":"Category display name"},"description":{"type":"string","title":"Description","description":"Category description"}},"type":"object","required":["id","slug","name","description"],"title":"ImprovementCategorySchema"},"ImprovementCategoryWithTopicsSchema":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"slug":{"type":"string","title":"Slug","description":"Category slug identifier"},"name":{"type":"string","title":"Name","description":"Category display name"},"description":{"type":"string","title":"Description","description":"Category description"},"topics":{"items":{"$ref":"#/components/schemas/ImprovementTopicBriefSchema"},"type":"array","title":"Topics"}},"type":"object","required":["id","slug","name","description","topics"],"title":"ImprovementCategoryWithTopicsSchema"},"ImprovementOccurrenceSchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"improvement_topic_id":{"type":"string","format":"uuid","title":"Improvement Topic Id","description":"Related improvement topic ID"},"conversation_id":{"type":"string","format":"uuid","title":"Conversation Id","description":"Related conversation ID"},"details":{"$ref":"#/components/schemas/OccurrenceDetails","description":"Occurrence details including evidence"},"conversation":{"$ref":"#/components/schemas/ConversationBasicInfoSchema","description":"Basic conversation information"}},"type":"object","required":["created_at","updated_at","id","improvement_topic_id","conversation_id","details","conversation"],"title":"ImprovementOccurrenceSchema"},"ImprovementTopicBriefSchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid","title":"Organization Id","description":"Organization ID"},"agent_id":{"type":"string","format":"uuid","title":"Agent Id","description":"Agent ID"},"improvement_category_id":{"type":"string","format":"uuid","title":"Improvement Category Id","description":"Improvement category ID"},"title":{"type":"string","title":"Title","description":"Topic title"},"description":{"type":"string","title":"Description","description":"Topic description"},"status":{"$ref":"#/components/schemas/ImprovementTopicStatus","description":"Topic status"},"last_occurred_at":{"type":"string","format":"date-time","title":"Last Occurred At","description":"Last occurrence timestamp"},"resolved_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Resolved At","description":"Resolution timestamp"},"occurrence_count":{"type":"integer","title":"Occurrence Count","description":"Number of occurrences in the time range"}},"type":"object","required":["created_at","updated_at","id","organization_id","agent_id","improvement_category_id","title","description","status","last_occurred_at","occurrence_count"],"title":"ImprovementTopicBriefSchema"},"ImprovementTopicSchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid","title":"Organization Id","description":"Organization ID"},"agent_id":{"type":"string","format":"uuid","title":"Agent Id","description":"Agent ID"},"improvement_category_id":{"type":"string","format":"uuid","title":"Improvement Category Id","description":"Improvement category ID"},"title":{"type":"string","title":"Title","description":"Topic title"},"description":{"type":"string","title":"Description","description":"Topic description"},"status":{"$ref":"#/components/schemas/ImprovementTopicStatus","description":"Topic status"},"last_occurred_at":{"type":"string","format":"date-time","title":"Last Occurred At","description":"Last occurrence timestamp"},"resolved_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Resolved At","description":"Resolution timestamp"}},"type":"object","required":["created_at","updated_at","id","organization_id","agent_id","improvement_category_id","title","description","status","last_occurred_at"],"title":"ImprovementTopicSchema"},"ImprovementTopicStatus":{"type":"string","enum":["open","resolved","deferred","archived","duplicate"],"title":"ImprovementTopicStatus"},"ImprovementTopicUpdateStatus":{"properties":{"status":{"$ref":"#/components/schemas/ImprovementTopicStatus","description":"Updated status for the topic."}},"type":"object","required":["status"],"title":"ImprovementTopicUpdateStatus"},"ImprovementTopicWithCategorySchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid","title":"Organization Id","description":"Organization ID"},"agent_id":{"type":"string","format":"uuid","title":"Agent Id","description":"Agent ID"},"improvement_category_id":{"type":"string","format":"uuid","title":"Improvement Category Id","description":"Improvement category ID"},"title":{"type":"string","title":"Title","description":"Topic title"},"description":{"type":"string","title":"Description","description":"Topic description"},"status":{"$ref":"#/components/schemas/ImprovementTopicStatus","description":"Topic status"},"last_occurred_at":{"type":"string","format":"date-time","title":"Last Occurred At","description":"Last occurrence timestamp"},"resolved_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Resolved At","description":"Resolution timestamp"},"occurrence_count":{"type":"integer","title":"Occurrence Count","description":"Total number of occurrences for this topic."},"improvement_category":{"$ref":"#/components/schemas/ImprovementCategorySchema","description":"Category details"}},"type":"object","required":["created_at","updated_at","id","organization_id","agent_id","improvement_category_id","title","description","status","last_occurred_at","occurrence_count","improvement_category"],"title":"ImprovementTopicWithCategorySchema"},"InboundConfigActionSchema":{"properties":{"action_id":{"type":"string","format":"uuid","title":"Action Id"}},"type":"object","required":["action_id"],"title":"InboundConfigActionSchema"},"InboundConfigKnowledgeBaseSchema":{"properties":{"knowledge_base_id":{"type":"string","format":"uuid","title":"Knowledge Base Id"}},"type":"object","required":["knowledge_base_id"],"title":"InboundConfigKnowledgeBaseSchema"},"InboundConfigLookupSchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"name":{"type":"string","title":"Name"},"calls_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Calls Count"}},"type":"object","required":["created_at","updated_at","id","name"],"title":"InboundConfigLookupSchema","description":"Schema for inbound config lookup."},"InboundConfigSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"initial_message":{"type":"string","title":"Initial Message"},"call_flow_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Call Flow Id"},"call_flow":{"anyOf":[{"$ref":"#/components/schemas/CallFlowSchema"},{"type":"null"}]},"inbound_config_to_knowledge_base":{"items":{"$ref":"#/components/schemas/InboundConfigKnowledgeBaseSchema"},"type":"array","title":"Inbound Config To Knowledge Base"},"inbound_config_to_action":{"items":{"$ref":"#/components/schemas/InboundConfigActionSchema"},"type":"array","title":"Inbound Config To Action"}},"type":"object","required":["id","name","initial_message","call_flow_id","call_flow"],"title":"InboundConfigSchema"},"InboundConfigToKnowledgeBaseSchema":{"properties":{"inbound_config_id":{"type":"string","format":"uuid4","title":"Inbound Config Id","description":"ID of the inbound config (agent)"}},"type":"object","required":["inbound_config_id"],"title":"InboundConfigToKnowledgeBaseSchema","description":"Schema for the relationship between inbound config and knowledge base."},"InhousePhoneNumberConfig":{"properties":{"sip_request_defaults":{"anyOf":[{"$ref":"#/components/schemas/SipRequestDefaults"},{"type":"null"}],"description":"Optional default SIP request headers emitted at call start."}},"type":"object","title":"InhousePhoneNumberConfig","description":"Config for inhouse/mawj phone numbers."},"InsightBoardCreate":{"properties":{"name":{"type":"string","title":"Name","description":"Insight board name"},"agent_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Id","description":"Agent id"},"config":{"additionalProperties":true,"type":"object","title":"Config","description":"Insight board config","default":{}}},"type":"object","required":["name"],"title":"InsightBoardCreate"},"InsightBoardItemConfig":{"properties":{"position":{"anyOf":[{"$ref":"#/components/schemas/InsightBoardItemConfigPosition"},{"type":"null"}]},"size":{"anyOf":[{"$ref":"#/components/schemas/InsightBoardItemConfigSize"},{"type":"null"}]},"show_legend":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Show Legend","default":false}},"type":"object","title":"InsightBoardItemConfig"},"InsightBoardItemConfigPosition":{"properties":{"x":{"type":"integer","title":"X"},"y":{"type":"integer","title":"Y"}},"type":"object","required":["x","y"],"title":"InsightBoardItemConfigPosition"},"InsightBoardItemConfigSize":{"properties":{"w":{"type":"integer","title":"W"},"h":{"type":"integer","title":"H"}},"type":"object","required":["w","h"],"title":"InsightBoardItemConfigSize"},"InsightBoardItemSchema":{"properties":{"insight_id":{"type":"string","format":"uuid","title":"Insight Id","description":"Insight id"},"config":{"additionalProperties":true,"type":"object","title":"Config","description":"Config related with insight board item"},"insight":{"oneOf":[{"$ref":"#/components/schemas/TextInsightResponse"},{"$ref":"#/components/schemas/PieInsightResponse"},{"$ref":"#/components/schemas/BarInsightResponse"},{"$ref":"#/components/schemas/LineInsightResponse"}],"title":"Insight","description":"Insight details","discriminator":{"propertyName":"type","mapping":{"bar":"#/components/schemas/BarInsightResponse","line":"#/components/schemas/LineInsightResponse","pie":"#/components/schemas/PieInsightResponse","text":"#/components/schemas/TextInsightResponse"}}}},"type":"object","required":["insight_id","config","insight"],"title":"InsightBoardItemSchema"},"InsightBoardItemUpdate":{"properties":{"insight_id":{"type":"string","format":"uuid","title":"Insight Id","description":"Insight id"},"config":{"$ref":"#/components/schemas/InsightBoardItemConfig","description":"Config related with insight board item"}},"type":"object","required":["insight_id","config"],"title":"InsightBoardItemUpdate","description":"It only update the board item config. For addition / deletion of insight from a\nboard, please use the insight create / delete APIs respectively.\nExisting insight cannot be linked to a board"},"InsightBoardSchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid","title":"Organization Id","description":"Organization ID"},"name":{"type":"string","title":"Name","description":"Insight board name"},"agent_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Id","description":"Agent id"},"config":{"additionalProperties":true,"type":"object","title":"Config","description":"Insight board config"}},"type":"object","required":["created_at","updated_at","id","organization_id","name","config"],"title":"InsightBoardSchema"},"InsightBoardUpdate":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Insight board name"},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Config","description":"Insight board config"},"items":{"anyOf":[{"items":{"$ref":"#/components/schemas/InsightBoardItemUpdate"},"type":"array"},{"type":"null"}],"title":"Items","description":"Insight board items list with config"}},"type":"object","title":"InsightBoardUpdate"},"InsightBoardWithItemsSchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid","title":"Organization Id","description":"Organization ID"},"name":{"type":"string","title":"Name","description":"Insight board name"},"agent_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Id","description":"Agent id"},"config":{"additionalProperties":true,"type":"object","title":"Config","description":"Insight board config"},"items":{"items":{"$ref":"#/components/schemas/InsightBoardItemSchema"},"type":"array","title":"Items","description":"Insight board items with config and insight details"}},"type":"object","required":["created_at","updated_at","id","organization_id","name","config","items"],"title":"InsightBoardWithItemsSchema"},"InsightCreateRequest":{"properties":{"definition":{"oneOf":[{"$ref":"#/components/schemas/TextInsightDefinition"},{"$ref":"#/components/schemas/PieInsightDefinition"},{"$ref":"#/components/schemas/BarInsightDefinition"},{"$ref":"#/components/schemas/LineInsightDefinition"}],"title":"Definition","description":"The insight definition to create","discriminator":{"propertyName":"type","mapping":{"bar":"#/components/schemas/BarInsightDefinition","line":"#/components/schemas/LineInsightDefinition","pie":"#/components/schemas/PieInsightDefinition","text":"#/components/schemas/TextInsightDefinition"}}},"insight_board_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Insight Board Id","description":"Insight board ID to associate this insight with"}},"type":"object","required":["definition"],"title":"InsightCreateRequest","description":"Request schema for creating an insight."},"InsightPreviewRequest":{"properties":{"definition":{"oneOf":[{"$ref":"#/components/schemas/TextInsightDefinition"},{"$ref":"#/components/schemas/PieInsightDefinition"},{"$ref":"#/components/schemas/BarInsightDefinition"},{"$ref":"#/components/schemas/LineInsightDefinition"}],"title":"Definition","description":"The insight definition to preview","discriminator":{"propertyName":"type","mapping":{"bar":"#/components/schemas/BarInsightDefinition","line":"#/components/schemas/LineInsightDefinition","pie":"#/components/schemas/PieInsightDefinition","text":"#/components/schemas/TextInsightDefinition"}}},"agent_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Id","description":"Filter results by agent ID. When provided, all query filters will be AND'd with agent_id = this value."}},"type":"object","required":["definition"],"title":"InsightPreviewRequest","description":"Request schema for previewing an insight definition."},"InsightPreviewResponse":{"properties":{"queries":{"items":{"$ref":"#/components/schemas/InsightPreviewResponseQuery"},"type":"array","title":"Queries","description":"Results for each query defined in the insight"}},"type":"object","required":["queries"],"title":"InsightPreviewResponse"},"InsightPreviewResponseQuery":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the query as specified in the input QuerySchema"},"results":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Results","description":"List of result rows with structure based on chart type:\n\nTEXT/PIE charts (grouped):\n  [{'agent_1': 100}, {'agent_2': 150}]\n  Each row has one key-value pair per group.\n\nLINE/BAR charts (time series):\n  [{'time': '2024-01-01T00:00:00', 'agent_1': 100, 'agent_2': 150},\n   {'time': '2024-01-02T00:00:00', 'agent_1': 120, 'agent_2': 130}]\n  Each row represents a time bucket with all group values.\n\nGroup keys are either single values or joined with '::' separator for multiple columns.\nNumeric values are rounded to 2 decimal places."},"total_count":{"type":"integer","title":"Total Count","description":"Total number of result rows. For grouped results: number of unique groups. For time series: number of time buckets."},"labels":{"items":{"type":"string"},"type":"array","title":"Labels","description":"List of group labels present in the results.\n\nTEXT/PIE charts: All unique group keys (e.g., ['agent_1', 'agent_2'])\nLINE/BAR charts: All unique group keys excluding 'time' (sorted alphabetically)\n\nGroup labels with multiple columns use '::' separator (e.g., 'agent_123::completed').\nIf no grouping, defaults to ['result']."},"label_map":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Label Map","description":"Optional mapping from raw label keys to human-readable display names.\n\nPresent when group_by includes columns with ID values (e.g., agent_id).\nMaps each raw label to its resolved display name.\nExample: {'1ce74c86-...': 'Sales Bot', '1ce74c86-...::completed': 'Sales Bot::completed'}"}},"type":"object","required":["name","results","total_count","labels"],"title":"InsightPreviewResponseQuery"},"InsightRunRequest":{"properties":{"time_range":{"anyOf":[{"$ref":"#/components/schemas/TimeRangeFilterSchema"},{"$ref":"#/components/schemas/TimeRangeFilterWithIntervalSchema"},{"type":"null"}],"title":"Time Range","description":"Override the saved query's time range"},"agent_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Id","description":"Filter results by agent ID. When provided, all query filters will be AND'd with agent_id = this value."}},"type":"object","title":"InsightRunRequest","description":"Request schema for running a saved insight with optional overrides."},"InsightUpdateRequest":{"properties":{"definition":{"oneOf":[{"$ref":"#/components/schemas/TextInsightDefinition"},{"$ref":"#/components/schemas/PieInsightDefinition"},{"$ref":"#/components/schemas/BarInsightDefinition"},{"$ref":"#/components/schemas/LineInsightDefinition"}],"title":"Definition","description":"The updated insight definition","discriminator":{"propertyName":"type","mapping":{"bar":"#/components/schemas/BarInsightDefinition","line":"#/components/schemas/LineInsightDefinition","pie":"#/components/schemas/PieInsightDefinition","text":"#/components/schemas/TextInsightDefinition"}}}},"type":"object","required":["definition"],"title":"InsightUpdateRequest","description":"Request schema for updating an insight."},"JudgePlan":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Whether to evaluate this message","default":true},"type":{"$ref":"#/components/schemas/JudgeType","description":"Evaluation method"},"expected_content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expected Content","description":"Expected content for matching."},"expected_tool_calls":{"anyOf":[{"items":{"$ref":"#/components/schemas/ToolCall"},"type":"array"},{"type":"null"}],"title":"Expected Tool Calls","description":"Expected tool/function calls to validate"}},"type":"object","required":["type"],"title":"JudgePlan","description":"Evaluation criteria for assistant messages","examples":[{"enabled":true,"expected_content":"Hello! How can I help you?","type":"exact_match"},{"enabled":true,"expected_content":".*(help|assist).*","type":"regex_match"},{"enabled":true,"expected_tool_calls":[{"arguments":{"date":"2025-01-20"},"name":"bookAppointment"}],"type":"exact_match"}]},"JudgeResult":{"properties":{"expected":{"$ref":"#/components/schemas/JudgePlan"},"status":{"$ref":"#/components/schemas/JudgeResultStatus"},"fail_reason":{"anyOf":[{"$ref":"#/components/schemas/EvalTurnFailReason"},{"type":"null"}]}},"type":"object","required":["expected","status"],"title":"JudgeResult"},"JudgeResultStatus":{"type":"string","enum":["pass","fail"],"title":"JudgeResultStatus","description":"judge result"},"JudgeType":{"type":"string","enum":["exact_match","regex_match"],"title":"JudgeType","description":"Evaluation/judge types"},"KeyValue":{"properties":{"name":{"type":"string","title":"Name"},"value":{"type":"integer","title":"Value"}},"type":"object","required":["name","value"],"title":"KeyValue"},"KnowledgeBaseActionConfig":{"properties":{"knowledge_base_ids":{"items":{"type":"string","format":"uuid4"},"type":"array","minItems":1,"title":"Knowledge Base Ids","description":"IDs of knowledge bases available through this tool"}},"type":"object","required":["knowledge_base_ids"],"title":"KnowledgeBaseActionConfig","description":"Configuration for a knowledge-base retrieval action.\n\nThe LLM sees a single tool with a topic enum parameter whose values\nare the names of the referenced knowledge bases. The handler resolves\nthe selected topic to a KB and returns its content."},"KnowledgeBaseActionSchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"timeout":{"type":"integer","title":"Timeout"},"inbound_config_ids":{"items":{"type":"string","format":"uuid4"},"type":"array","title":"Inbound Config Ids","description":"IDs of agents this action is assigned to"},"type":{"type":"string","const":"knowledge_base","title":"Type"},"config":{"$ref":"#/components/schemas/KnowledgeBaseActionConfig"},"function":{"type":"null","title":"Function"}},"type":"object","required":["created_at","updated_at","id","organization_id","name","timeout","type","config"],"title":"KnowledgeBaseActionSchema"},"KnowledgeBaseLookupSchema":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"KnowledgeBaseLookupSchema","description":"Schema for knowledgebase lookup."},"KnowledgeBaseSchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"Organization ID"},"name":{"type":"string","title":"Name","description":"Name of the knowledge base entry"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the knowledge base. If use_as_tool is true, it is used by the LLM as tool description."},"fileName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filename","description":"Original file name"},"fileType":{"$ref":"#/components/schemas/FileType","description":"Type of file (pdf, text, docx, etc)"},"content":{"type":"string","title":"Content","description":"Knowledge base text content"},"use_as_tool":{"type":"boolean","title":"Use As Tool","description":"When enabled, this KB is explicitly registered as an LLM tool. The LLM can actively call this KB when needed. ","default":false},"inbound_config_to_knowledge_base":{"items":{"$ref":"#/components/schemas/InboundConfigToKnowledgeBaseSchema"},"type":"array","title":"Inbound Config To Knowledge Base","description":"List of inbound configs (agents) this knowledge base is attached to"}},"type":"object","required":["created_at","updated_at","id","organization_id","name","fileType","content"],"title":"KnowledgeBaseSchema","description":"Knowledge Base entry schema."},"LatestCallConversationSchema":{"properties":{"status":{"$ref":"#/components/schemas/ConversationStatus"},"duration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration"}},"type":"object","required":["status","duration"],"title":"LatestCallConversationSchema"},"LatestCallSchema":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"conversation":{"$ref":"#/components/schemas/LatestCallConversationSchema"}},"type":"object","required":["id","conversation"],"title":"LatestCallSchema"},"LineInsightConfigSchema-Input":{"properties":{"queries":{"items":{"$ref":"#/components/schemas/QuerySchema-Input"},"type":"array","minItems":1,"title":"Queries"},"time_range":{"$ref":"#/components/schemas/TimeRangeFilterWithIntervalSchema"},"group_by":{"items":{"type":"string"},"type":"array","title":"Group By"}},"type":"object","required":["queries"],"title":"LineInsightConfigSchema"},"LineInsightConfigSchema-Output":{"properties":{"queries":{"items":{"$ref":"#/components/schemas/QuerySchema-Output"},"type":"array","minItems":1,"title":"Queries"},"time_range":{"$ref":"#/components/schemas/TimeRangeFilterWithIntervalSchema"},"group_by":{"items":{"type":"string"},"type":"array","title":"Group By"}},"type":"object","required":["queries"],"title":"LineInsightConfigSchema"},"LineInsightDefinition":{"properties":{"name":{"type":"string","title":"Name","description":"Insight name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Insight description"},"type":{"type":"string","const":"line","title":"Type"},"config":{"$ref":"#/components/schemas/LineInsightConfigSchema-Input"}},"type":"object","required":["name","type","config"],"title":"LineInsightDefinition"},"LineInsightResponse":{"properties":{"name":{"type":"string","title":"Name","description":"Insight name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Insight description"},"type":{"type":"string","const":"line","title":"Type"},"config":{"$ref":"#/components/schemas/LineInsightConfigSchema-Output"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid","title":"Organization Id","description":"Organization ID this insight belongs to"}},"type":"object","required":["name","type","config","created_at","updated_at","id","organization_id"],"title":"LineInsightResponse"},"ListCampaignsResponse":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid","title":"Organization Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"phone_number_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Phone Number Id"},"agent_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Id"},"retry_policy_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Retry Policy Id"},"status":{"$ref":"#/components/schemas/CampaignStatus"},"type":{"$ref":"#/components/schemas/CampaignType"},"call_flow":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Flow"},"desired_outcome":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Desired Outcome"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At"}},"type":"object","required":["id","organization_id","name","description","phone_number_id","agent_id","retry_policy_id","status","type","call_flow","desired_outcome","created_at","updated_at"],"title":"ListCampaignsResponse"},"ListPhoneNumbersResponse":{"properties":{"items":{"items":{"oneOf":[{"$ref":"#/components/schemas/MawjPhoneNumber"},{"$ref":"#/components/schemas/SipRegisterPhoneNumber"},{"$ref":"#/components/schemas/MaqsamPhoneNumber"},{"$ref":"#/components/schemas/LiveKitPhoneNumber"}],"discriminator":{"propertyName":"type","mapping":{"livekit":"#/components/schemas/LiveKitPhoneNumber","maqsam":"#/components/schemas/MaqsamPhoneNumber","mawj":"#/components/schemas/MawjPhoneNumber","sip_register":"#/components/schemas/SipRegisterPhoneNumber"}}},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"ListPhoneNumbersResponse"},"ListResource_AgentRulesCategorySchema_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AgentRulesCategorySchema"},"type":"array","title":"Items"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object","required":["items","pagination"],"title":"ListResource[AgentRulesCategorySchema]"},"ListResource_CallStructuredOutputResult_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CallStructuredOutputResult"},"type":"array","title":"Items"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object","required":["items","pagination"],"title":"ListResource[CallStructuredOutputResult]"},"ListResource_Call_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Call"},"type":"array","title":"Items"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object","required":["items","pagination"],"title":"ListResource[Call]"},"ListResource_ChatUserSchema_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ChatUserSchema"},"type":"array","title":"Items"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object","required":["items","pagination"],"title":"ListResource[ChatUserSchema]"},"ListResource_EvalTestCaseResponse_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/EvalTestCaseResponse"},"type":"array","title":"Items"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object","required":["items","pagination"],"title":"ListResource[EvalTestCaseResponse]"},"ListResource_EvalTestCaseRun_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/EvalTestCaseRun"},"type":"array","title":"Items"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object","required":["items","pagination"],"title":"ListResource[EvalTestCaseRun]"},"ListResource_ImprovementOccurrenceSchema_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ImprovementOccurrenceSchema"},"type":"array","title":"Items"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object","required":["items","pagination"],"title":"ListResource[ImprovementOccurrenceSchema]"},"ListResource_ImprovementTopicWithCategorySchema_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ImprovementTopicWithCategorySchema"},"type":"array","title":"Items"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object","required":["items","pagination"],"title":"ListResource[ImprovementTopicWithCategorySchema]"},"ListResource_InsightBoardSchema_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InsightBoardSchema"},"type":"array","title":"Items"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object","required":["items","pagination"],"title":"ListResource[InsightBoardSchema]"},"ListResource_KnowledgeBaseSchema_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/KnowledgeBaseSchema"},"type":"array","title":"Items"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object","required":["items","pagination"],"title":"ListResource[KnowledgeBaseSchema]"},"ListResource_ListCampaignsResponse_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ListCampaignsResponse"},"type":"array","title":"Items"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object","required":["items","pagination"],"title":"ListResource[ListCampaignsResponse]"},"ListResource_OrganizationApiKeySchema_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/OrganizationApiKeySchema"},"type":"array","title":"Items"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object","required":["items","pagination"],"title":"ListResource[OrganizationApiKeySchema]"},"ListResource_OutboundCallWithCampaignSchema_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/OutboundCallWithCampaignSchema"},"type":"array","title":"Items"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object","required":["items","pagination"],"title":"ListResource[OutboundCallWithCampaignSchema]"},"ListResource_StructuredOutputResultSchema_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/StructuredOutputResultSchema"},"type":"array","title":"Items"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object","required":["items","pagination"],"title":"ListResource[StructuredOutputResultSchema]"},"ListResource_StructuredOutput_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/StructuredOutput"},"type":"array","title":"Items"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object","required":["items","pagination"],"title":"ListResource[StructuredOutput]"},"ListResource_WebhookDelivery_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/WebhookDelivery"},"type":"array","title":"Items"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object","required":["items","pagination"],"title":"ListResource[WebhookDelivery]"},"ListResource_WebhookEndpoint_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/WebhookEndpoint"},"type":"array","title":"Items"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object","required":["items","pagination"],"title":"ListResource[WebhookEndpoint]"},"LiveKitPhoneNumber":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"name":{"type":"string","title":"Name","description":"Phone number name"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Is phone number active and accepting calls","default":false},"inbound_config_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Inbound Config Id","description":"Inbound config/agent ID"},"type":{"type":"string","const":"livekit","title":"Type"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id"},"config":{"$ref":"#/components/schemas/LiveKitPhoneNumberConfig"}},"type":"object","required":["created_at","updated_at","id","name","type","organization_id","config"],"title":"LiveKitPhoneNumber"},"LiveKitPhoneNumberConfig":{"properties":{"number":{"type":"string","title":"Number","description":"Phone number"}},"type":"object","required":["number"],"title":"LiveKitPhoneNumberConfig","description":"Config for livekit phone numbers (empty for now)"},"MCPActionSchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"timeout":{"type":"integer","title":"Timeout"},"inbound_config_ids":{"items":{"type":"string","format":"uuid4"},"type":"array","title":"Inbound Config Ids","description":"IDs of agents this action is assigned to"},"type":{"type":"string","const":"mcp","title":"Type"},"config":{"$ref":"#/components/schemas/MCPConfig-Output"},"function":{"type":"null","title":"Function"}},"type":"object","required":["created_at","updated_at","id","organization_id","name","timeout","type","config"],"title":"MCPActionSchema"},"MCPConfig-Input":{"properties":{"serverUrl":{"type":"string","title":"Serverurl","description":"MCP server URL"},"webhookSecret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhooksecret","description":"Auth secret passed via x-mawj-secret header"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers","description":"Additional HTTP headers"},"toolsMessages":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Toolsmessages","description":"Pre-tool-call messages per tool name"},"tools_configuration":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/ToolConfiguration-Input"},"type":"object"},{"type":"null"}],"title":"Tools Configuration","description":"Per-tool configuration overrides"}},"type":"object","required":["serverUrl"],"title":"MCPConfig","description":"Configuration for an MCP action."},"MCPConfig-Output":{"properties":{"serverUrl":{"type":"string","title":"Serverurl","description":"MCP server URL"},"webhookSecret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhooksecret","description":"Auth secret passed via x-mawj-secret header"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers","description":"Additional HTTP headers"},"toolsMessages":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Toolsmessages","description":"Pre-tool-call messages per tool name"},"tools_configuration":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/ToolConfiguration-Output"},"type":"object"},{"type":"null"}],"title":"Tools Configuration","description":"Per-tool configuration overrides"}},"type":"object","required":["serverUrl"],"title":"MCPConfig","description":"Configuration for an MCP action."},"MCPToolSchema":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["name"],"title":"MCPToolSchema","description":"Schema for individual MCP tool."},"MCPToolsListResponse":{"properties":{"tools":{"items":{"$ref":"#/components/schemas/MCPToolSchema"},"type":"array","title":"Tools"}},"type":"object","required":["tools"],"title":"MCPToolsListResponse","description":"Response containing list of MCP tools."},"MaqsamPhoneNumber":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"name":{"type":"string","title":"Name","description":"Phone number name"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Is phone number active and accepting calls","default":false},"inbound_config_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Inbound Config Id","description":"Inbound config/agent ID"},"type":{"type":"string","const":"maqsam","title":"Type"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id"},"config":{"$ref":"#/components/schemas/MaqsamPhoneNumberConfig"}},"type":"object","required":["created_at","updated_at","id","name","type","organization_id","config"],"title":"MaqsamPhoneNumber"},"MaqsamPhoneNumberConfig":{"properties":{"number":{"type":"string","title":"Number","description":"Phone number in E.164 format"},"maqsamAuthToken":{"type":"string","title":"Maqsamauthtoken"},"enableOutbound":{"type":"boolean","title":"Enableoutbound","default":false},"campaignIdentifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Campaignidentifier"},"accessKeyId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accesskeyid"},"accessSecret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accesssecret"}},"type":"object","required":["number","maqsamAuthToken"],"title":"MaqsamPhoneNumberConfig","description":"Config for Maqsam phone numbers"},"MawjPhoneNumber":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"name":{"type":"string","title":"Name","description":"Phone number name"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Is phone number active and accepting calls","default":false},"inbound_config_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Inbound Config Id","description":"Inbound config/agent ID"},"type":{"type":"string","const":"mawj","title":"Type"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id"},"config":{"$ref":"#/components/schemas/InhousePhoneNumberConfig"}},"type":"object","required":["created_at","updated_at","id","name","type","organization_id","config"],"title":"MawjPhoneNumber"},"MessageReceived":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier for the message record"},"created":{"type":"string","format":"date-time","title":"Created","description":"ISO 8601 timestamp when the message was created in the system"},"whatsappMessageId":{"type":"string","title":"Whatsappmessageid","description":"WhatsApp's unique message identifier (WAMID)"},"conversationId":{"type":"string","title":"Conversationid","description":"Unique identifier for the conversation thread"},"ticketId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticketid","description":"Unique identifier for the support ticket associated with this message"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text","description":"The actual text content of the message"},"type":{"$ref":"#/components/schemas/MessageType","description":"Type of message content"},"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"string"},{"type":"null"}],"title":"Data","description":"Additional data payload for non-text message types"},"sourceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sourceid","description":"Identifier for the message source (if applicable)"},"sourceUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sourceurl","description":"URL reference for the message source (if applicable)"},"timestamp":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timestamp","description":"Unix timestamp when the message was sent"},"owner":{"type":"boolean","title":"Owner","description":"Indicates if the message was sent by the account owner"},"eventType":{"type":"string","const":"message","title":"Eventtype","description":"Type of event this record represents"},"statusString":{"type":"string","title":"Statusstring","description":"Current status of the message"},"avatarUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Avatarurl","description":"URL to the sender's profile picture"},"assignedId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignedid","description":"Unique identifier of the operator assigned to handle this conversation"},"operatorName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Operatorname","description":"Full name of the assigned operator"},"operatorEmail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Operatoremail","description":"Email address of the assigned operator"},"waId":{"type":"string","title":"Waid","description":"WhatsApp ID of the message sender"},"senderName":{"type":"string","title":"Sendername","description":"Display name of the message sender"},"listReply":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Listreply","description":"Data for list selection replies (WhatsApp interactive messages)"},"interactiveButtonReply":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Interactivebuttonreply","description":"Data for interactive button replies"},"buttonReply":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Buttonreply","description":"Data for quick reply button responses"},"replyContextId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Replycontextid","description":"Reference ID for the message being replied to (empty if not a reply)"},"sourceType":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sourcetype","description":"Numeric code indicating the message source type"},"frequentlyForwarded":{"type":"boolean","title":"Frequentlyforwarded","description":"WhatsApp flag indicating if message has been forwarded multiple times","default":false},"forwarded":{"type":"boolean","title":"Forwarded","description":"Indicates if this message was forwarded","default":false}},"type":"object","required":["id","created","whatsappMessageId","conversationId","type","owner","eventType","statusString","waId","senderName"],"title":"MessageReceived"},"MessageType":{"type":"string","enum":["image","text","document","location","voice","audio","button","interactive","reaction","video","sticker","contacts","order","catalog","media_placeholder"],"title":"MessageType"},"MetricQuantities":{"properties":{"aggregation":{"$ref":"#/components/schemas/AggregationFunction"},"quantities":{"items":{"$ref":"#/components/schemas/MetricQuantity"},"type":"array","title":"Quantities"},"total":{"items":{"$ref":"#/components/schemas/MetricTotal"},"type":"array","title":"Total","description":"The total quantity for the period.","examples":[100.0]}},"type":"object","required":["aggregation","quantities","total"],"title":"MetricQuantities"},"MetricQuantity":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"The timestamp for the current period."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"The label of the quantity"},"quantity":{"type":"number","title":"Quantity","description":"The quantity for the current period.","examples":[10.0]}},"type":"object","required":["timestamp","quantity"],"title":"MetricQuantity"},"MetricTotal":{"properties":{"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"The label of the quantity"},"total":{"type":"number","title":"Total","description":"The total for the current period.","examples":[10.0]}},"type":"object","required":["total"],"title":"MetricTotal"},"NodeKnowledgeBase":{"properties":{"kb_id":{"type":"string","format":"uuid4","title":"Kb Id"}},"type":"object","required":["kb_id"],"title":"NodeKnowledgeBase"},"NodeMessagePlan":{"properties":{"first_message":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"First Message"},"run_llm_inference_on_enter":{"type":"boolean","title":"Run Llm Inference On Enter","default":true}},"type":"object","title":"NodeMessagePlan"},"NodePosition":{"properties":{"x":{"type":"number","title":"X"},"y":{"type":"number","title":"Y"}},"type":"object","required":["x","y"],"title":"NodePosition"},"NodeTool":{"properties":{"tool_id":{"type":"string","format":"uuid4","title":"Tool Id"},"names":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Names"}},"type":"object","required":["tool_id"],"title":"NodeTool"},"NumberSchema":{"properties":{"description":{"type":"string","title":"Description"},"type":{"type":"string","const":"number","title":"Type"},"maximum":{"type":"number","title":"Maximum"},"minimum":{"type":"number","title":"Minimum"}},"type":"object","required":["description","type"],"title":"NumberSchema","description":"Schema for 'number' type, including optional range constraints."},"ObjectSchema-Input":{"properties":{"description":{"type":"string","title":"Description"},"type":{"type":"string","const":"object","title":"Type"},"properties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringSchema"},{"$ref":"#/components/schemas/BooleanSchema"},{"$ref":"#/components/schemas/NumberSchema"},{"$ref":"#/components/schemas/ObjectSchema-Input"}]},"type":"object","title":"Properties"},"required":{"items":{"type":"string"},"type":"array","title":"Required"}},"type":"object","required":["description","type","properties","required"],"title":"ObjectSchema","description":"Schema for 'object' type, requiring properties and required fields."},"ObjectSchema-Output":{"properties":{"description":{"type":"string","title":"Description"},"type":{"type":"string","const":"object","title":"Type"},"properties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/StringSchema"},{"$ref":"#/components/schemas/BooleanSchema"},{"$ref":"#/components/schemas/NumberSchema"},{"$ref":"#/components/schemas/ObjectSchema-Output"}]},"type":"object","title":"Properties"},"required":{"items":{"type":"string"},"type":"array","title":"Required"}},"type":"object","required":["description","type","properties","required"],"title":"ObjectSchema","description":"Schema for 'object' type, requiring properties and required fields."},"OccurrenceDetails":{"properties":{"description":{"type":"string","title":"Description"},"evidence":{"items":{"$ref":"#/components/schemas/OccurrenceEvidence"},"type":"array","title":"Evidence"}},"type":"object","required":["description","evidence"],"title":"OccurrenceDetails"},"OccurrenceEvidence":{"properties":{"summary":{"type":"string","title":"Summary"}},"type":"object","required":["summary"],"title":"OccurrenceEvidence"},"OrganizationApiKeyCreate":{"properties":{"name":{"type":"string","title":"Name","description":"Organization api key name."},"scopes":{"items":{"$ref":"#/components/schemas/Scope"},"type":"array","minItems":1,"title":"Scopes","description":"List of scopes."}},"type":"object","required":["name","scopes"],"title":"OrganizationApiKeyCreate"},"OrganizationApiKeyCreateResponse":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"name":{"type":"string","title":"Name","description":"Organization api key name."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The organization id this api key belongs to."},"key_prefix":{"type":"string","title":"Key Prefix","description":"The masked api key."},"scopes":{"items":{"$ref":"#/components/schemas/Scope"},"type":"array","title":"Scopes","description":"Allowed list of scopes."},"key":{"type":"string","title":"Key","description":"The full api key."}},"type":"object","required":["created_at","updated_at","id","name","organization_id","key_prefix","scopes","key"],"title":"OrganizationApiKeyCreateResponse"},"OrganizationApiKeySchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"name":{"type":"string","title":"Name","description":"Organization api key name."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The organization id this api key belongs to."},"key_prefix":{"type":"string","title":"Key Prefix","description":"The masked api key."},"scopes":{"items":{"$ref":"#/components/schemas/Scope"},"type":"array","title":"Scopes","description":"Allowed list of scopes."}},"type":"object","required":["created_at","updated_at","id","name","organization_id","key_prefix","scopes"],"title":"OrganizationApiKeySchema"},"OrganizationApiKeyUpdate":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Organization api key name."},"scopes":{"anyOf":[{"items":{"$ref":"#/components/schemas/Scope"},"type":"array","minItems":1},{"type":"null"}],"title":"Scopes","description":"List of scopes."}},"type":"object","title":"OrganizationApiKeyUpdate"},"OutboundCall":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"the organization id that owns the outbound call."},"phone_number_id":{"type":"string","format":"uuid4","title":"Phone Number Id","description":"The phone number that is going to be used for the outbound call."},"to_number":{"type":"string","title":"To Number","description":"the destination of the outbound call."},"agent_id":{"type":"string","format":"uuid4","title":"Agent Id","description":"the agent id that is going to handle the outbound call."},"status":{"$ref":"#/components/schemas/OutboundCallStatus","description":"current status of the outbound call."},"retry_number":{"type":"integer","title":"Retry Number","description":"how many retry attempts did the outbound make so far."},"scheduled_at":{"type":"string","format":"date-time","title":"Scheduled At","description":"initial datetime for the outbound call to be placed."},"latest_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Latest At","description":"latest datetime for the outbound call to be placed. if the outbound call isn't placed after this datetime, it will be marked as cancelled."},"marked_to_be_canceled":{"type":"boolean","title":"Marked To Be Canceled","description":"if the outbound call is in the process of being cancelled, this flag will be true."},"next_retry_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Retry Time","description":"If set, it will indicate the next attempt datetime of the outbound call."},"latest_call_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Latest Call Id","description":"the call id of the last attemept made for the outbound call."},"metadata_":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata","description":"metadata passed for the outbound call."},"campaign_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Campaign Id","description":"campaign id of outbound call."},"retry_policy_id":{"type":"string","format":"uuid4","title":"Retry Policy Id","description":"retry policy the outbound call uses."},"retry_policy":{"anyOf":[{"$ref":"#/components/schemas/RetryPolicy"},{"type":"null"}],"description":"retry policy used for this outbound call."}},"type":"object","required":["created_at","updated_at","id","organization_id","phone_number_id","to_number","agent_id","status","retry_number","scheduled_at","marked_to_be_canceled","retry_policy_id"],"title":"OutboundCall"},"OutboundCallStatus":{"type":"string","enum":["scheduled","in_progress","failed","completed","canceled"],"title":"OutboundCallStatus"},"OutboundCallWithCampaignSchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"the organization id that owns the outbound call."},"phone_number_id":{"type":"string","format":"uuid4","title":"Phone Number Id","description":"The phone number that is going to be used for the outbound call."},"to_number":{"type":"string","title":"To Number","description":"the destination of the outbound call."},"agent_id":{"type":"string","format":"uuid4","title":"Agent Id","description":"the agent id that is going to handle the outbound call."},"status":{"$ref":"#/components/schemas/OutboundCallStatus","description":"current status of the outbound call."},"retry_number":{"type":"integer","title":"Retry Number","description":"how many retry attempts did the outbound make so far."},"scheduled_at":{"type":"string","format":"date-time","title":"Scheduled At","description":"initial datetime for the outbound call to be placed."},"latest_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Latest At","description":"latest datetime for the outbound call to be placed. if the outbound call isn't placed after this datetime, it will be marked as cancelled."},"marked_to_be_canceled":{"type":"boolean","title":"Marked To Be Canceled","description":"if the outbound call is in the process of being cancelled, this flag will be true."},"next_retry_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Retry Time","description":"If set, it will indicate the next attempt datetime of the outbound call."},"latest_call_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Latest Call Id","description":"the call id of the last attemept made for the outbound call."},"metadata_":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata","description":"metadata passed for the outbound call."},"campaign_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Campaign Id","description":"campaign id of outbound call."},"retry_policy_id":{"type":"string","format":"uuid4","title":"Retry Policy Id","description":"retry policy the outbound call uses."},"retry_policy":{"anyOf":[{"$ref":"#/components/schemas/RetryPolicy"},{"type":"null"}],"description":"retry policy used for this outbound call."},"campaign":{"anyOf":[{"$ref":"#/components/schemas/CampaignSchema"},{"type":"null"}],"description":"campaign details if exist"},"latest_call":{"anyOf":[{"$ref":"#/components/schemas/LatestCallSchema"},{"type":"null"}],"description":"Latest call try details if exist"}},"type":"object","required":["created_at","updated_at","id","organization_id","phone_number_id","to_number","agent_id","status","retry_number","scheduled_at","marked_to_be_canceled","retry_policy_id"],"title":"OutboundCallWithCampaignSchema"},"Pagination":{"properties":{"total_count":{"type":"integer","title":"Total Count"},"max_page":{"type":"integer","title":"Max Page"}},"type":"object","required":["total_count","max_page"],"title":"Pagination"},"PaginationParamsBody":{"properties":{"page":{"type":"integer","exclusiveMinimum":0.0,"title":"Page","description":"Page number, defaults to 1.","default":1},"limit":{"type":"integer","exclusiveMinimum":0.0,"title":"Limit","description":"Size of a page, defaults to 10. Maximum is 50.","default":10}},"type":"object","title":"PaginationParamsBody"},"PhoneNumberDestination-Input":{"properties":{"description":{"type":"string","title":"Description"},"messageBeforeTransfer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Messagebeforetransfer"},"transferPlan":{"$ref":"#/components/schemas/TransferPlan"},"overrideFromHost":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Overridefromhost"},"availabilitySchedule":{"anyOf":[{"items":{"$ref":"#/components/schemas/AvailabilityScheduleDay"},"type":"array"},{"type":"null"}],"title":"Availabilityschedule"},"type":{"type":"string","const":"phone_number","title":"Type"},"phoneNumber":{"type":"string","title":"Phonenumber"},"extension":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Extension"}},"type":"object","required":["description","transferPlan","type","phoneNumber"],"title":"PhoneNumberDestination"},"PhoneNumberDestination-Output":{"properties":{"description":{"type":"string","title":"Description"},"messageBeforeTransfer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Messagebeforetransfer"},"transferPlan":{"$ref":"#/components/schemas/TransferPlan"},"overrideFromHost":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Overridefromhost"},"availabilitySchedule":{"anyOf":[{"items":{"$ref":"#/components/schemas/AvailabilityScheduleDay"},"type":"array"},{"type":"null"}],"title":"Availabilityschedule"},"type":{"type":"string","const":"phone_number","title":"Type"},"phoneNumber":{"type":"string","title":"Phonenumber"},"extension":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Extension"}},"type":"object","required":["description","transferPlan","type","phoneNumber"],"title":"PhoneNumberDestination"},"PhoneNumberLookupSchema":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"name":{"type":"string","title":"Name"},"type":{"$ref":"#/components/schemas/PhoneNumberType"},"active":{"type":"boolean","title":"Active"}},"type":"object","required":["id","name","type","active"],"title":"PhoneNumberLookupSchema","description":"Schema for phone number lookup."},"PhoneNumberType":{"type":"string","enum":["sip_register","mawj","maqsam","livekit"],"title":"PhoneNumberType"},"PieInsightConfigSchema-Input":{"properties":{"queries":{"items":{"$ref":"#/components/schemas/QuerySchema-Input"},"type":"array","minItems":1,"title":"Queries"},"time_range":{"$ref":"#/components/schemas/TimeRangeFilterSchema"},"group_by":{"items":{"type":"string"},"type":"array","title":"Group By"}},"type":"object","required":["queries"],"title":"PieInsightConfigSchema"},"PieInsightConfigSchema-Output":{"properties":{"queries":{"items":{"$ref":"#/components/schemas/QuerySchema-Output"},"type":"array","minItems":1,"title":"Queries"},"time_range":{"$ref":"#/components/schemas/TimeRangeFilterSchema"},"group_by":{"items":{"type":"string"},"type":"array","title":"Group By"}},"type":"object","required":["queries"],"title":"PieInsightConfigSchema"},"PieInsightDefinition":{"properties":{"name":{"type":"string","title":"Name","description":"Insight name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Insight description"},"type":{"type":"string","const":"pie","title":"Type"},"config":{"$ref":"#/components/schemas/PieInsightConfigSchema-Input"}},"type":"object","required":["name","type","config"],"title":"PieInsightDefinition"},"PieInsightResponse":{"properties":{"name":{"type":"string","title":"Name","description":"Insight name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Insight description"},"type":{"type":"string","const":"pie","title":"Type"},"config":{"$ref":"#/components/schemas/PieInsightConfigSchema-Output"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid","title":"Organization Id","description":"Organization ID this insight belongs to"}},"type":"object","required":["name","type","config","created_at","updated_at","id","organization_id"],"title":"PieInsightResponse"},"PlaceholderWebhookPayload":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"data":{"$ref":"#/components/schemas/Schema"},"type":{"type":"string","const":"placeholder.example","title":"Type","examples":["placeholder.example"]}},"type":"object","required":["timestamp","data","type"],"title":"PlaceholderWebhookPayload","description":"Sent when a call is finalized."},"ProcessedMessageResponse":{"properties":{"message":{"type":"string","title":"Message","description":"The message coming from the assistant"}},"type":"object","required":["message"],"title":"ProcessedMessageResponse"},"QuerySchema-Input":{"properties":{"name":{"type":"string","title":"Name","description":"Query name"},"column":{"type":"string","title":"Column","description":"Column name"},"operation":{"$ref":"#/components/schemas/AggregationOperation","description":"Aggregation operation"},"filters":{"anyOf":[{"$ref":"#/components/schemas/FilterGroupSchema-Input"},{"type":"null"}],"description":"Filter group with AND/OR logic support"}},"type":"object","required":["name","column","operation"],"title":"QuerySchema"},"QuerySchema-Output":{"properties":{"name":{"type":"string","title":"Name","description":"Query name"},"column":{"type":"string","title":"Column","description":"Column name"},"operation":{"$ref":"#/components/schemas/AggregationOperation","description":"Aggregation operation"},"filters":{"anyOf":[{"$ref":"#/components/schemas/FilterGroupSchema-Output"},{"type":"null"}],"description":"Filter group with AND/OR logic support"}},"type":"object","required":["name","column","operation"],"title":"QuerySchema"},"ResolutionEvaluationPlanDetailSchema":{"properties":{"resolution_evaluation_plan":{"anyOf":[{"$ref":"#/components/schemas/ResolutionEvaluationPlanSchema"},{"type":"null"}]},"resolution_default_status_prompts":{"anyOf":[{"$ref":"#/components/schemas/ResolutionEvaluationStatusPrompts"},{"type":"null"}]}},"type":"object","title":"ResolutionEvaluationPlanDetailSchema"},"ResolutionEvaluationPlanSchema":{"properties":{"active":{"type":"boolean","title":"Active"},"plan":{"$ref":"#/components/schemas/CallAnalysisPlanResolutionEvaluationPlan"}},"type":"object","required":["active","plan"],"title":"ResolutionEvaluationPlanSchema"},"ResolutionEvaluationPlanUpdateSchema":{"properties":{"active":{"type":"boolean","title":"Active","description":"Whether evaluation is enabled."},"plan":{"$ref":"#/components/schemas/CallAnalysisPlanResolutionEvaluationPlan","description":"Evaluation criteria"}},"type":"object","required":["active","plan"],"title":"ResolutionEvaluationPlanUpdateSchema"},"ResolutionEvaluationStatusPrompts":{"properties":{"resolved":{"type":"string","title":"Resolved"},"partially_resolved":{"type":"string","title":"Partially Resolved"},"unresolved":{"type":"string","title":"Unresolved"},"exclude":{"type":"string","title":"Exclude"},"incomplete":{"type":"string","title":"Incomplete"}},"type":"object","required":["resolved","partially_resolved","unresolved","exclude","incomplete"],"title":"ResolutionEvaluationStatusPrompts"},"ResourceAlreadyExists":{"properties":{"error_code":{"type":"string","const":"ResourceAlreadyExists","title":"Error Code","examples":["ResourceAlreadyExists"]},"message":{"type":"string","title":"Message"},"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Data"}},"type":"object","required":["error_code","message"],"title":"ResourceAlreadyExists"},"RetryPolicy":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id"},"is_default":{"type":"boolean","title":"Is Default"},"backoff_coefficient":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Backoff Coefficient"},"initial_interval_ms":{"type":"integer","title":"Initial Interval Ms"},"maximum_attempts":{"type":"integer","title":"Maximum Attempts"},"maximum_interval_ms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maximum Interval Ms"},"minimum_attempt_time":{"anyOf":[{"type":"string","format":"time"},{"type":"null"}],"title":"Minimum Attempt Time"},"maximum_attempt_time":{"anyOf":[{"type":"string","format":"time"},{"type":"null"}],"title":"Maximum Attempt Time"},"attempt_days":{"items":{"$ref":"#/components/schemas/DayOfWeek"},"type":"array","title":"Attempt Days"}},"type":"object","required":["id","organization_id","is_default","backoff_coefficient","initial_interval_ms","maximum_attempts","attempt_days"],"title":"RetryPolicy"},"RunAssistantMessage":{"properties":{"role":{"type":"string","const":"assistant","title":"Role","default":"assistant"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content","description":"Mock/Actual response content"},"tool_calls":{"anyOf":[{"items":{"$ref":"#/components/schemas/ToolCall"},"type":"array"},{"type":"null"}],"title":"Tool Calls","description":"Mock/Actual tool/function calls"},"judge_result":{"anyOf":[{"$ref":"#/components/schemas/JudgeResult"},{"type":"null"}],"description":"Evaluation result (present when message should be evaluated)"}},"type":"object","title":"RunAssistantMessage","description":"Assistant/LLM message in conversation"},"SayAction":{"properties":{"type":{"type":"string","const":"tts_say","title":"Type"},"text":{"type":"string","title":"Text","description":"message to say "}},"type":"object","required":["type","text"],"title":"SayAction"},"Schema":{"properties":{},"type":"object","title":"Schema"},"Scope":{"type":"string","enum":["organization:admin","organization:read","actions:read","actions:write","calls:read","call_flows:read","call_flows:write","campaigns:read","campaigns:write","chat_users:read","chat_users:write","evals:read","evals:write","inbound_configs:read","inbound_configs:write","knowledge_bases:read","knowledge_bases:write","organization_api_keys:read","organization_api_keys:write","outbound_calls:read","outbound_calls:write","phone_numbers:read","phone_numbers:write","reporting_analytics:read","reporting_analytics:write","reporting_improvements:read","reporting_improvements:write","reporting_insights:read","reporting_insights:write","structured_outputs:read","structured_outputs:write","webhooks:read","webhooks:write"],"title":"Scope","enumNames":{"actions:read":"Read actions / tools","actions:write":"Modify actions / tools","call_flows:read":"Read conversation flows","call_flows:write":"Modify conversation flows","calls:read":"Read calls","campaigns:read":"Read campaigns","campaigns:write":"Modify campaigns","chat_users:read":"Read chat users","chat_users:write":"Modify chat users","evals:read":"Read evals","evals:write":"Create and modify evals","inbound_configs:read":"Read inbound configs / agents","inbound_configs:write":"Modify inbound configs / agents","knowledge_bases:read":"Read knowledge bases","knowledge_bases:write":"Create and modify knowledge bases","organization:admin":"Modify your organization","organization:read":"Read your organization","organization_api_keys:read":"Read organization api keys","organization_api_keys:write":"Create and modify organization api keys","outbound_calls:read":"Read outbound calls","outbound_calls:write":"Create and modify outbound calls","phone_numbers:read":"Read phone numbers","phone_numbers:write":"Create and modify phone numbers","reporting_analytics:read":"Read analytics","reporting_analytics:write":"Modify analytics","reporting_improvements:read":"Read improvements","reporting_improvements:write":"Modify improvements","reporting_insights:read":"Read insights and boards","reporting_insights:write":"Modify insights and boards","structured_outputs:read":"Read structured outputs","structured_outputs:write":"Create and modify structured outputs","webhooks:read":"Read webhooks","webhooks:write":"Create and modify webhooks"}},"SipDestination-Input":{"properties":{"description":{"type":"string","title":"Description"},"messageBeforeTransfer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Messagebeforetransfer"},"transferPlan":{"$ref":"#/components/schemas/TransferPlan"},"overrideFromHost":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Overridefromhost"},"availabilitySchedule":{"anyOf":[{"items":{"$ref":"#/components/schemas/AvailabilityScheduleDay"},"type":"array"},{"type":"null"}],"title":"Availabilityschedule"},"type":{"type":"string","const":"sip","title":"Type"},"sipUri":{"type":"string","title":"Sipuri"}},"type":"object","required":["description","transferPlan","type","sipUri"],"title":"SipDestination"},"SipDestination-Output":{"properties":{"description":{"type":"string","title":"Description"},"messageBeforeTransfer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Messagebeforetransfer"},"transferPlan":{"$ref":"#/components/schemas/TransferPlan"},"overrideFromHost":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Overridefromhost"},"availabilitySchedule":{"anyOf":[{"items":{"$ref":"#/components/schemas/AvailabilityScheduleDay"},"type":"array"},{"type":"null"}],"title":"Availabilityschedule"},"type":{"type":"string","const":"sip","title":"Type"},"sipUri":{"type":"string","title":"Sipuri"}},"type":"object","required":["description","transferPlan","type","sipUri"],"title":"SipDestination"},"SipRegisterPhoneNumber":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"name":{"type":"string","title":"Name","description":"Phone number name"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Is phone number active and accepting calls","default":false},"inbound_config_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Inbound Config Id","description":"Inbound config/agent ID"},"type":{"type":"string","const":"sip_register","title":"Type"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id"},"config":{"$ref":"#/components/schemas/SipRegisterPhoneNumberConfig"}},"type":"object","required":["created_at","updated_at","id","name","type","organization_id","config"],"title":"SipRegisterPhoneNumber"},"SipRegisterPhoneNumberConfig":{"properties":{"number":{"type":"string","title":"Number","description":"Phone number"},"username":{"type":"string","title":"Username","description":"SIP username"},"password":{"type":"string","title":"Password","description":"SIP password"},"includeAuth":{"type":"boolean","title":"Includeauth","default":false},"overrideToEnabled":{"type":"boolean","title":"Overridetoenabled","default":false},"toNumberPrefix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tonumberprefix"},"overrideFromHost":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Overridefromhost"},"ipTrunkName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iptrunkname"},"fromEnableLeadingPlus":{"type":"boolean","title":"Fromenableleadingplus","default":true},"accountSid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accountsid"},"clientSid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clientsid"},"applicationSid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Applicationsid"},"apiKeySid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Apikeysid"},"sipRealm":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Siprealm"},"gatewayToken":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Gatewaytoken"},"inviteHeaders":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Inviteheaders"},"sip_request_defaults":{"anyOf":[{"$ref":"#/components/schemas/SipRequestDefaults"},{"type":"null"}],"description":"Optional default SIP request headers emitted at call start."}},"type":"object","required":["number","username","password"],"title":"SipRegisterPhoneNumberConfig","description":"Config for SIP register phone numbers"},"SipRequestDefaults":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"When true, emit a SIP request before starting media streaming.","default":false},"method":{"type":"string","enum":["INFO","MESSAGE","NOTIFY"],"title":"Method","description":"SIP method for the sip:request verb.","default":"INFO"},"headers":{"additionalProperties":{"type":"string"},"type":"object","title":"Headers","description":"Headers (key/value pairs) to include with the SIP request."},"body":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body","description":"Optional SIP MESSAGE body. When method=MESSAGE and body is empty, a single space is used to satisfy Jambonz validation."}},"type":"object","title":"SipRequestDefaults","description":"Default SIP request (Jambonz sip:request) emitted at call start."},"StringSchema":{"properties":{"description":{"type":"string","title":"Description"},"type":{"type":"string","const":"string","title":"Type"},"enum":{"items":{"type":"string"},"type":"array","title":"Enum"}},"type":"object","required":["description","type"],"title":"StringSchema"},"StructuredOutput":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The organization id this structured output belongs to"},"name":{"type":"string","title":"Name","description":"Structured Output name."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Structured Output name."},"agent_ids":{"anyOf":[{"items":{"type":"string","format":"uuid4"},"type":"array"},{"type":"null"}],"title":"Agent Ids","description":"the agents that have this structured outputs linked to them"},"schema_data":{"additionalProperties":true,"type":"object","title":"Schema Data","description":"JSONSchema for the structured output"},"source":{"$ref":"#/components/schemas/StructuredOutputSource","description":"Source of structured output"}},"type":"object","required":["created_at","updated_at","id","organization_id","name","schema_data","source"],"title":"StructuredOutput"},"StructuredOutputCreate":{"properties":{"name":{"type":"string","title":"Name","description":"Structured Output name."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Structured Output name."},"agent_ids":{"anyOf":[{"items":{"type":"string","format":"uuid4"},"type":"array"},{"type":"null"}],"title":"Agent Ids","description":"the agents that have this structured outputs linked to them"},"schema_data":{"anyOf":[{"$ref":"#/components/schemas/StringSchema"},{"$ref":"#/components/schemas/BooleanSchema"},{"$ref":"#/components/schemas/NumberSchema"},{"$ref":"#/components/schemas/ObjectSchema-Input"}],"title":"Schema Data","description":"JSONSchema for the structured output"},"source":{"$ref":"#/components/schemas/StructuredOutputSource","description":"Source of structured output","default":"ai"}},"type":"object","required":["name","schema_data"],"title":"StructuredOutputCreate"},"StructuredOutputDefinition":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The organization id this structured output belongs to"},"name":{"type":"string","title":"Name","description":"Structured Output name."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Structured Output description."},"schema_data":{"anyOf":[{"$ref":"#/components/schemas/StringSchema"},{"$ref":"#/components/schemas/BooleanSchema"},{"$ref":"#/components/schemas/NumberSchema"},{"$ref":"#/components/schemas/ObjectSchema-Output"}],"title":"Schema Data","description":"JSONSchema for the structured output"},"source":{"$ref":"#/components/schemas/StructuredOutputSource","description":"Source of structured output"}},"type":"object","required":["created_at","updated_at","id","organization_id","name","schema_data","source"],"title":"StructuredOutputDefinition"},"StructuredOutputResultSchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The organization id this structured output belongs to"},"call_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Call Id","description":"The conversation this structured output belongs to. Deprecated: Use `conversation_id` instead.","deprecated":true},"conversation_id":{"type":"string","format":"uuid4","title":"Conversation Id","description":"The conversation_id id this structured output belongs to"},"agent_id":{"type":"string","format":"uuid4","title":"Agent Id","description":"The agent id this structured output belongs to"},"structured_output_id":{"type":"string","format":"uuid4","title":"Structured Output Id","description":"The structured output definition id"},"value":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"},{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"null"}],"title":"Value","description":"The structured output result value. The format depends on the structured output json schema. e.g, if schema type is 'number', the output value here will be integer"},"found":{"type":"boolean","title":"Found","description":"If the AI analyser found explicit/implicit mentions of the requiredsturcutred output in the transcript.","default":false}},"type":"object","required":["created_at","updated_at","id","organization_id","conversation_id","agent_id","structured_output_id","value"],"title":"StructuredOutputResultSchema"},"StructuredOutputSource":{"type":"string","enum":["ai","manual"],"title":"StructuredOutputSource"},"StructuredOutputUpdate":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Structured Output name."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Structured Output description."},"agent_ids":{"anyOf":[{"items":{"type":"string","format":"uuid4"},"type":"array"},{"type":"null"}],"title":"Agent Ids","description":"the agents that have this structured outputs linked to them"},"schema_data":{"anyOf":[{"$ref":"#/components/schemas/StringSchema"},{"$ref":"#/components/schemas/BooleanSchema"},{"$ref":"#/components/schemas/NumberSchema"},{"$ref":"#/components/schemas/ObjectSchema-Input"},{"type":"null"}],"title":"Schema Data","description":"JsonSchema for the structured output"}},"type":"object","title":"StructuredOutputUpdate"},"TextInsightConfigSchema-Input":{"properties":{"queries":{"items":{"$ref":"#/components/schemas/QuerySchema-Input"},"type":"array","maxItems":1,"minItems":1,"title":"Queries","description":"Text chart supports exactly one query"},"time_range":{"$ref":"#/components/schemas/TimeRangeFilterSchema"}},"type":"object","required":["queries"],"title":"TextInsightConfigSchema"},"TextInsightConfigSchema-Output":{"properties":{"queries":{"items":{"$ref":"#/components/schemas/QuerySchema-Output"},"type":"array","maxItems":1,"minItems":1,"title":"Queries","description":"Text chart supports exactly one query"},"time_range":{"$ref":"#/components/schemas/TimeRangeFilterSchema"}},"type":"object","required":["queries"],"title":"TextInsightConfigSchema"},"TextInsightDefinition":{"properties":{"name":{"type":"string","title":"Name","description":"Insight name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Insight description"},"type":{"type":"string","const":"text","title":"Type"},"config":{"$ref":"#/components/schemas/TextInsightConfigSchema-Input"}},"type":"object","required":["name","type","config"],"title":"TextInsightDefinition"},"TextInsightResponse":{"properties":{"name":{"type":"string","title":"Name","description":"Insight name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Insight description"},"type":{"type":"string","const":"text","title":"Type"},"config":{"$ref":"#/components/schemas/TextInsightConfigSchema-Output"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid","title":"Organization Id","description":"Organization ID this insight belongs to"}},"type":"object","required":["name","type","config","created_at","updated_at","id","organization_id"],"title":"TextInsightResponse"},"TimeInterval":{"type":"string","enum":["year","month","week","day","hour"],"title":"TimeInterval"},"TimeRangeFilterSchema":{"properties":{"start":{"type":"string","title":"Start","description":"Start time (ISO 8601, 'now', or relative like '-7d'). Valid relative units are {h,d,w,m,y}","default":"-7d","examples":["-7d","-1m","2025-01-01T00:00:00","now"]},"end":{"type":"string","title":"End","description":"End time (ISO 8601, 'now', or relative like '-1d'). Valid relative units are {h,d,w,m,y}","default":"now","examples":["now","-1d","2025-12-31T23:59:59"]},"timezone":{"type":"string","title":"Timezone","description":"IANA timezone value (e.g., 'Asia/Riyadh')","default":"UTC","examples":["UTC","Asia/Riyadh","America/New_York","Europe/London"]}},"type":"object","title":"TimeRangeFilterSchema"},"TimeRangeFilterWithIntervalSchema":{"properties":{"start":{"type":"string","title":"Start","description":"Start time (ISO 8601, 'now', or relative like '-7d'). Valid relative units are {h,d,w,m,y}","default":"-7d","examples":["-7d","-1m","2025-01-01T00:00:00","now"]},"end":{"type":"string","title":"End","description":"End time (ISO 8601, 'now', or relative like '-1d'). Valid relative units are {h,d,w,m,y}","default":"now","examples":["now","-1d","2025-12-31T23:59:59"]},"timezone":{"type":"string","title":"Timezone","description":"IANA timezone value (e.g., 'Asia/Riyadh')","default":"UTC","examples":["UTC","Asia/Riyadh","America/New_York","Europe/London"]},"interval":{"$ref":"#/components/schemas/TimeInterval","description":"Time interval for grouping data into buckets. Determines how results are aggregated over time. Maximum allowed time ranges: hour=7 days, day=366 days, week=365 days, month=4 years, year=10 years","default":"day"}},"type":"object","title":"TimeRangeFilterWithIntervalSchema"},"ToolAction":{"properties":{"type":{"type":"string","const":"tool","title":"Type"},"tool":{"$ref":"#/components/schemas/NodeTool"}},"type":"object","required":["type","tool"],"title":"ToolAction"},"ToolCall":{"properties":{"name":{"type":"string","minLength":1,"title":"Name","description":"Function/tool name"},"arguments":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"string"},{"type":"null"}],"title":"Arguments","description":"Expected arguments (null means validate name only)"}},"type":"object","required":["name"],"title":"ToolCall","description":"Tool/function call specification","examples":[{"arguments":{"date":"2025-01-20","time":"14:00"},"name":"bookAppointment"},{"name":"checkAvailability"}]},"ToolConfiguration-Input":{"properties":{"allow_bot_speech_interruption":{"type":"boolean","title":"Allow Bot Speech Interruption","default":false},"encode_to_toon":{"type":"boolean","title":"Encode To Toon","default":false},"messages":{"anyOf":[{"$ref":"#/components/schemas/ToolMessages"},{"type":"null"}]}},"type":"object","title":"ToolConfiguration","description":"Per-tool configuration overrides for an MCP action."},"ToolConfiguration-Output":{"properties":{"allow_bot_speech_interruption":{"type":"boolean","title":"Allow Bot Speech Interruption","default":false},"encode_to_toon":{"type":"boolean","title":"Encode To Toon","default":false},"messages":{"anyOf":[{"$ref":"#/components/schemas/ToolMessages"},{"type":"null"}]}},"type":"object","title":"ToolConfiguration","description":"Per-tool configuration overrides for an MCP action."},"ToolErrorSchema":{"properties":{"organization_id":{"type":"string","format":"uuid4","title":"Organization Id"},"session_id":{"type":"string","format":"uuid4","title":"Session Id"},"session_type":{"type":"string","enum":["call","chat"],"title":"Session Type"},"action_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Action Id"},"action_type":{"$ref":"#/components/schemas/ActionType"},"tool_name":{"type":"string","title":"Tool Name"},"tool_call_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tool Call Id"},"tool_arguments":{"additionalProperties":true,"type":"object","title":"Tool Arguments"},"error_category":{"$ref":"#/components/schemas/ErrorCategory"},"error_message":{"type":"string","title":"Error Message"}},"type":"object","required":["organization_id","session_id","session_type","action_id","action_type","tool_name","tool_call_id","tool_arguments","error_category","error_message"],"title":"ToolErrorSchema"},"ToolMessage":{"properties":{"role":{"type":"string","const":"tool","title":"Role","default":"tool"},"tool_name":{"type":"string","minLength":1,"title":"Tool Name","description":"Name of the tool/function"},"content":{"type":"string","title":"Content","description":"Tool result/response (usually JSON string)"}},"type":"object","required":["tool_name","content"],"title":"ToolMessage","description":"Tool/function execution result message","examples":[{"content":"{\"status\": \"success\", \"confirmation_id\": \"APT-12345\"}","role":"tool","tool_name":"bookAppointment"}]},"ToolMessages":{"properties":{"request_start":{"anyOf":[{"$ref":"#/components/schemas/ToolStartMessage"},{"type":"null"}]},"response_delayed":{"anyOf":[{"$ref":"#/components/schemas/ToolWaitingMessage"},{"type":"null"}]}},"type":"object","title":"ToolMessages","description":"Per-tool message configuration."},"ToolStartMessage":{"properties":{"message":{"type":"string","title":"Message","description":"Message spoken to the user when the tool starts"}},"type":"object","required":["message"],"title":"ToolStartMessage","description":"Message spoken when a tool call begins."},"ToolWaitingMessage":{"properties":{"message":{"type":"string","title":"Message","description":"Message spoken to the user while waiting for the tool"},"threshold_seconds":{"type":"number","exclusiveMinimum":0.0,"title":"Threshold Seconds","description":"Seconds before first message","default":4.0},"interval_seconds":{"type":"number","exclusiveMinimum":0.0,"title":"Interval Seconds","description":"Seconds between repeats","default":4.0}},"type":"object","required":["message"],"title":"ToolWaitingMessage","description":"Message spoken when a tool call takes too long."},"TransferCallActionSchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"timeout":{"type":"integer","title":"Timeout"},"inbound_config_ids":{"items":{"type":"string","format":"uuid4"},"type":"array","title":"Inbound Config Ids","description":"IDs of agents this action is assigned to"},"type":{"type":"string","const":"transfer_call","title":"Type"},"config":{"$ref":"#/components/schemas/TransferCallConfig-Output"},"function":{"type":"null","title":"Function"}},"type":"object","required":["created_at","updated_at","id","organization_id","name","timeout","type","config"],"title":"TransferCallActionSchema"},"TransferCallConfig-Input":{"properties":{"destinations":{"items":{"oneOf":[{"$ref":"#/components/schemas/PhoneNumberDestination-Input"},{"$ref":"#/components/schemas/SipDestination-Input"}],"discriminator":{"propertyName":"type","mapping":{"phone_number":"#/components/schemas/PhoneNumberDestination-Input","sip":"#/components/schemas/SipDestination-Input"}}},"type":"array","minItems":1,"title":"Destinations","description":"At least one destination is required"},"append_headers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Append Headers"}},"type":"object","required":["destinations"],"title":"TransferCallConfig","description":"Configuration for a transfer-call action."},"TransferCallConfig-Output":{"properties":{"destinations":{"items":{"oneOf":[{"$ref":"#/components/schemas/PhoneNumberDestination-Output"},{"$ref":"#/components/schemas/SipDestination-Output"}],"discriminator":{"propertyName":"type","mapping":{"phone_number":"#/components/schemas/PhoneNumberDestination-Output","sip":"#/components/schemas/SipDestination-Output"}}},"type":"array","minItems":1,"title":"Destinations","description":"At least one destination is required"},"append_headers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Append Headers"}},"type":"object","required":["destinations"],"title":"TransferCallConfig","description":"Configuration for a transfer-call action."},"TransferChatRespondioActionSchema":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"timeout":{"type":"integer","title":"Timeout"},"inbound_config_ids":{"items":{"type":"string","format":"uuid4"},"type":"array","title":"Inbound Config Ids","description":"IDs of agents this action is assigned to"},"type":{"type":"string","const":"transfer_chat_respondio","title":"Type"},"config":{"$ref":"#/components/schemas/TransferChatRespondioConfig"},"function":{"type":"null","title":"Function"}},"type":"object","required":["created_at","updated_at","id","organization_id","name","timeout","type","config"],"title":"TransferChatRespondioActionSchema"},"TransferChatRespondioConfig":{"properties":{"agent_ids":{"items":{"type":"integer"},"type":"array","title":"Agent Ids","description":"List of human agent IDs in respond.io"}},"type":"object","required":["agent_ids"],"title":"TransferChatRespondioConfig","description":"Configuration for a Respond.io chat-transfer action."},"TransferPlan":{"properties":{"type":{"$ref":"#/components/schemas/CallTransferType"},"custom_headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Custom Headers"},"method":{"anyOf":[{"type":"string","enum":["INFO","MESSAGE","NOTIFY"]},{"type":"null"}],"title":"Method","description":"Only used when type is sip_request (Jambonz sip:request verb / live call control)."},"bye_delay_seconds":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}],"title":"Bye Delay Seconds","description":"Only used when type is sip_request. If set, schedule a hangup (BYE) after this many seconds."}},"type":"object","required":["type"],"title":"TransferPlan"},"UpdateAgentRule":{"properties":{"title":{"anyOf":[{"type":"string","maxLength":500,"minLength":1},{"type":"null"}],"title":"Title","description":"Rule title"},"content":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Content","description":"Rule content / instructions"}},"type":"object","title":"UpdateAgentRule","description":"Request body to update an agent rule. All fields optional."},"UpdateCallFlowV1":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of the call flow"},"flow":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Flow","description":"please don't use this field, it will be removed in future releases","deprecated":true},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"description of call flow for users to have more context or summary of the call flow."},"version":{"type":"integer","const":1,"title":"Version"},"graph_data":{"additionalProperties":true,"type":"object","title":"Graph Data","description":"the graph data"}},"type":"object","required":["version","graph_data"],"title":"UpdateCallFlowV1"},"UpdateCallFlowV2":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of the call flow"},"flow":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Flow","description":"please don't use this field, it will be removed in future releases","deprecated":true},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"description of call flow for users to have more context or summary of the call flow."},"version":{"type":"integer","const":2,"title":"Version"},"graph_data":{"$ref":"#/components/schemas/CallFlowGraphV2-Input","description":"the graph data"}},"type":"object","required":["version","graph_data"],"title":"UpdateCallFlowV2"},"UpdateCampaignConfigurationStep":{"properties":{"step":{"type":"string","const":"configuration","title":"Step"},"retry_policy":{"$ref":"#/components/schemas/CreateRetryPolicy"},"phone_number_id":{"type":"string","format":"uuid","title":"Phone Number Id"},"is_finalized":{"type":"boolean","title":"Is Finalized"}},"type":"object","required":["step","retry_policy","phone_number_id","is_finalized"],"title":"UpdateCampaignConfigurationStep"},"UpdateCampaignDestinationsResponse":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"UpdateCampaignDestinationsResponse"},"UpdateCampaignDestinationsSchema":{"properties":{"destinations":{"items":{"$ref":"#/components/schemas/CampaignDestinationSchema"},"type":"array","maxItems":5000,"title":"Destinations","description":"Campaign destinations (phone numbers). Up to 5000 numbers can be uploaded at a time."}},"type":"object","required":["destinations"],"title":"UpdateCampaignDestinationsSchema"},"UpdateCampaignDestinationsStep":{"properties":{"destinations":{"items":{"$ref":"#/components/schemas/CampaignDestinationSchema"},"type":"array","maxItems":5000,"title":"Destinations","description":"Campaign destinations (phone numbers). Up to 5000 numbers can be uploaded at a time."},"step":{"type":"string","const":"destinations","title":"Step"}},"type":"object","required":["destinations","step"],"title":"UpdateCampaignDestinationsStep"},"UpdateCampaignDetailsStep":{"properties":{"step":{"type":"string","const":"details","title":"Step"},"name":{"type":"string","title":"Name"},"initial_message":{"type":"string","title":"Initial Message"},"call_flow":{"type":"string","title":"Call Flow"},"desired_outcome":{"type":"string","title":"Desired Outcome"},"kb_files":{"items":{"type":"string"},"type":"array","title":"Kb Files"},"custom_actions":{"items":{"type":"string"},"type":"array","title":"Custom Actions"}},"type":"object","required":["step","name","initial_message","call_flow","desired_outcome","kb_files","custom_actions"],"title":"UpdateCampaignDetailsStep"},"UpdateCampaignStatusRequest":{"properties":{"status":{"type":"string","enum":["scheduled","paused"],"title":"Status"}},"type":"object","required":["status"],"title":"UpdateCampaignStatusRequest"},"UpdateChatUser":{"properties":{"external_id":{"anyOf":[{"type":"string","maxLength":256,"minLength":1},{"type":"null"}],"title":"External Id","description":"User identifier on your system. example: phone number or DB id. This id will be used to uniquely identify each chat user and it's conversations."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"User name. If provided, it will be embeded into agent prompt config"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone","description":"User phone number. If provided, it will embed into agent prompt config. It must be in E.164 phone number format"}},"type":"object","title":"UpdateChatUser"},"UpdateKnowledgeBase":{"properties":{"name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"content":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Content"},"use_as_tool":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Use As Tool"}},"type":"object","title":"UpdateKnowledgeBase"},"UpdateSipRegisterPhoneNumber":{"properties":{"name":{"type":"string","title":"Name","description":"Phone number name"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Is phone number active and accepting calls","default":false},"inbound_config_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Inbound Config Id","description":"Inbound config/agent ID"},"type":{"type":"string","const":"sip_register","title":"Type"},"config":{"$ref":"#/components/schemas/UpdateSipRegisterPhoneNumberConfig"}},"type":"object","required":["name","type","config"],"title":"UpdateSipRegisterPhoneNumber"},"UpdateSipRegisterPhoneNumberConfig":{"properties":{"number":{"type":"string","title":"Number","description":"Phone number"},"includeAuth":{"type":"boolean","title":"Includeauth","default":false},"overrideToEnabled":{"type":"boolean","title":"Overridetoenabled","default":false},"toNumberPrefix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tonumberprefix"},"fromEnableLeadingPlus":{"type":"boolean","title":"Fromenableleadingplus","default":true},"sip_request_defaults":{"anyOf":[{"$ref":"#/components/schemas/SipRequestDefaults"},{"type":"null"}],"description":"Optional default SIP request headers emitted at call start."}},"type":"object","required":["number"],"title":"UpdateSipRegisterPhoneNumberConfig","description":"Limited config for updating SIP register (excludes credentials)"},"UserMessage":{"properties":{"role":{"type":"string","const":"user","title":"Role","default":"user"},"content":{"type":"string","minLength":1,"title":"Content","description":"User message text"}},"type":"object","required":["content"],"title":"UserMessage","description":"User message in conversation","examples":[{"content":"Hello, I'd like to book an appointment","role":"user"}]},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WebhookCallFinalizePayload":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"data":{"$ref":"#/components/schemas/IDSchema"},"type":{"type":"string","const":"call.finalized","title":"Type","examples":["call.finalized"]}},"type":"object","required":["timestamp","data","type"],"title":"WebhookCallFinalizePayload","description":"Sent when a call is finalized."},"WebhookDelivery":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"succeeded":{"type":"boolean","title":"Succeeded","description":"Whether the delivery was successful."},"http_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Http Code","description":"The HTTP code returned by the URL. `null` if the endpoint was unreachable."},"response":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response","description":"The response body returned by the URL, or the error message if the endpoint was unreachable."},"webhook_event":{"$ref":"#/components/schemas/WebhookEvent","description":"The webhook event sent by this delivery."}},"type":"object","required":["created_at","updated_at","id","succeeded","http_code","response","webhook_event"],"title":"WebhookDelivery","description":"A webhook delivery for a webhook event."},"WebhookEndpoint":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Url","description":"The URL where the webhook events will be sent.","examples":["https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0"]},"secret":{"type":"string","title":"Secret","description":"The secret used to sign the webhook events.","examples":["mawj_whs_ovyN6cPrTv56AApvzCaJno08SSmGJmgbWilb33N2JuK"]},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The organization ID associated with the webhook endpoint."},"events":{"items":{"$ref":"#/components/schemas/WebhookEventType"},"type":"array","title":"Events","description":"The events that will trigger the webhook."}},"type":"object","required":["created_at","updated_at","id","url","secret","organization_id","events"],"title":"WebhookEndpoint","description":"A webhook endpoint."},"WebhookEndpointCreate":{"properties":{"url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Url","description":"The URL where the webhook events will be sent.","examples":["https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0"]},"secret":{"anyOf":[{"type":"string","minLength":32,"description":"The secret used to sign the webhook events.","examples":["mawj_whs_ovyN6cPrTv56AApvzCaJno08SSmGJmgbWilb33N2JuK"]},{"type":"null"}],"title":"Secret","deprecated":true},"events":{"items":{"$ref":"#/components/schemas/WebhookEventType"},"type":"array","title":"Events","description":"The events that will trigger the webhook."}},"type":"object","required":["url","events"],"title":"WebhookEndpointCreate","description":"Schema to create a webhook endpoint."},"WebhookEndpointUpdate":{"properties":{"url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri","description":"The URL where the webhook events will be sent.","examples":["https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0"]},{"type":"null"}],"title":"Url"},"secret":{"anyOf":[{"type":"string","minLength":32,"description":"The secret used to sign the webhook events.","examples":["mawj_whs_ovyN6cPrTv56AApvzCaJno08SSmGJmgbWilb33N2JuK"]},{"type":"null"}],"title":"Secret","deprecated":true},"events":{"anyOf":[{"items":{"$ref":"#/components/schemas/WebhookEventType"},"type":"array","description":"The events that will trigger the webhook."},{"type":"null"}],"title":"Events"}},"type":"object","title":"WebhookEndpointUpdate","description":"Schema to update a webhook endpoint."},"WebhookEvent":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last modification timestamp of the object."},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object."},"last_http_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Last Http Code","description":"Last HTTP code returned by the URL. `null` if no delviery has been attempted or if the endpoint was unreachable."},"succeeded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Succeeded","description":"Whether this event was successfully delivered. `null` if no delivery has been attempted."},"payload":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payload","description":"The payload of the webhook event."},"type":{"$ref":"#/components/schemas/WebhookEventType","description":"The type of the webhook event."}},"type":"object","required":["created_at","updated_at","id","payload","type"],"title":"WebhookEvent","description":"A webhook event.\n\nAn event represent something that happened in the system\nthat should be sent to the webhook endpoint.\n\nIt can be delivered multiple times until it's marked as succeeded,\neach one creating a new delivery."},"WebhookEventType":{"type":"string","enum":["call.finalized","tool.error","placeholder.example"],"title":"WebhookEventType"},"WebhookToolErrorPayload":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"data":{"$ref":"#/components/schemas/ToolErrorSchema"},"type":{"type":"string","const":"tool.error","title":"Type","examples":["tool.error"]}},"type":"object","required":["timestamp","data","type"],"title":"WebhookToolErrorPayload","description":"Sent when llm tool return error response."},"src__core__exceptions__base__BadRequestError":{"properties":{"error_code":{"type":"string","const":"BadRequestError","title":"Error Code","examples":["BadRequestError"]},"message":{"type":"string","title":"Message"},"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Data"}},"type":"object","required":["error_code","message"],"title":"BadRequestError"},"src__core__exceptions__base__NotFoundError":{"properties":{"error_code":{"type":"string","const":"NotFoundError","title":"Error Code","examples":["NotFoundError"]},"message":{"type":"string","title":"Message"},"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Data"}},"type":"object","required":["error_code","message"],"title":"NotFoundError"},"src__core__exceptions__base__ResourceNotFound":{"properties":{"error_code":{"type":"string","const":"ResourceNotFound","title":"Error Code","examples":["ResourceNotFound"]},"message":{"type":"string","title":"Message"},"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Data"}},"type":"object","required":["error_code","message"],"title":"ResourceNotFound"},"src__core__pagenation__ListResource[]":{"properties":{"items":{"items":{"oneOf":[{"$ref":"#/components/schemas/MCPActionSchema"},{"$ref":"#/components/schemas/GoogleSheetsActionSchema"},{"$ref":"#/components/schemas/TransferCallActionSchema"},{"$ref":"#/components/schemas/TransferChatRespondioActionSchema"},{"$ref":"#/components/schemas/ApiCallActionSchema"},{"$ref":"#/components/schemas/KnowledgeBaseActionSchema"}],"discriminator":{"propertyName":"type","mapping":{"api_call":"#/components/schemas/ApiCallActionSchema","google.sheets.row.append":"#/components/schemas/GoogleSheetsActionSchema","knowledge_base":"#/components/schemas/KnowledgeBaseActionSchema","mcp":"#/components/schemas/MCPActionSchema","transfer_call":"#/components/schemas/TransferCallActionSchema","transfer_chat_respondio":"#/components/schemas/TransferChatRespondioActionSchema"}}},"type":"array","title":"Items"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object","required":["items","pagination"],"title":"ListResource[]"}},"securitySchemes":{"api_key":{"type":"apiKey","description":"Organization API key. You can generate one from your organization's settings.","in":"header","name":"x-mawj-api-key"},"session_key":{"type":"apiKey","description":"User session key.","in":"header","name":"x-mawj-session-key"}}}}