# SigmaMind AI > Developer docs for SigmaMind AI. Build, test, and deploy AI agents that handle voice, chat, and email conversations for your contact center. - [Introduction](https://docs.sigmamind.ai/documentation/getting-started/introduction.md): Get started with SigmaMind AI - a production-grade Voice AI platform for developers and enterprises. - [Quick Start with AI Agents](https://docs.sigmamind.ai/documentation/getting-started/quick-start.md): Get started with SigmaMind AI Agents by creating your first agent, connecting a phone number, and testing calls. - [Templates](https://docs.sigmamind.ai/documentation/getting-started/templates.md): Explore pre-built templates to quickly create AI agents for various use cases. - [Prompt Engineering Guide](https://docs.sigmamind.ai/documentation/getting-started/prompt-engineering-guide.md) - [AI Agents Overview](https://docs.sigmamind.ai/documentation/agents/overview.md): Learn how SigmaMind Agents work as conversational workflow builders for AI-driven interactions. - [Step 1: Write the main prompt](https://docs.sigmamind.ai/documentation/agents/single-prompt-agent/configure-main-prompt.md) - [Step 2: Set First Message (optional)](https://docs.sigmamind.ai/documentation/agents/single-prompt-agent/configure-welcome-message.md) - [How to Add tool](https://docs.sigmamind.ai/documentation/agents/single-prompt-agent/add-tool-calls.md) - [How to use Transfer Call](https://docs.sigmamind.ai/transfer-call.md) - [End Call](https://docs.sigmamind.ai/end-call.md) - [Extract Dynamic Variables](https://docs.sigmamind.ai/extract-dynamic-variable.md) - [Navigate IVR](https://docs.sigmamind.ai/navigate-ivr.md) - [Add Integation Tool](https://docs.sigmamind.ai/add-integation-tool.md) - [Conversational Flow Agent](https://docs.sigmamind.ai/documentation/agents/agent-builder-overview.md): Learn how to build custom conversational AI agents using SigmaMind's AI agent builder. - [Overview](https://docs.sigmamind.ai/documentation/agents/add-advance-nodes/overview.md) - [Start Trigger ](https://docs.sigmamind.ai/documentation/agents/add-basic-nodes/trigger-node.md) - [Send Response Node](https://docs.sigmamind.ai/documentation/agents/add-basic-nodes/response-node.md) - [Wait Node](https://docs.sigmamind.ai/documentation/agents/add-basic-nodes/wait-node.md) - [Analyze Customer Message](https://docs.sigmamind.ai/documentation/agents/add-basic-nodes/customer-intent-node.md) - [Branch Node](https://docs.sigmamind.ai/documentation/agents/add-basic-nodes/branch-node.md) - [Jump Node](https://docs.sigmamind.ai/documentation/agents/add-advance-nodes/jump-node.md) - [Tool Action](https://docs.sigmamind.ai/documentation/agents/add-advance-nodes/app-action-node.md) - [Helpdesk Action](https://docs.sigmamind.ai/documentation/agents/add-advance-nodes/helpdesk-action-node.md) - [Voice Action](https://docs.sigmamind.ai/documentation/agents/add-advance-nodes/voice-action.md) - [Extract Variables](https://docs.sigmamind.ai/documentation/agents/add-advance-nodes/extract-variables.md) - [Basic Settings](https://docs.sigmamind.ai/documentation/agents/settings/basic.md): The Basic Settings section allows you to configure the core behavior of your AI Agent, including voice selection, model choice, language preferences, and how conversations begin. - [Agent Settings Overview](https://docs.sigmamind.ai/documentation/agents/settings/overview.md): Configure Agent settings in SigmaMind to control behavior, voice, models, and integrations. - [How to configure basic settings](https://docs.sigmamind.ai/documentation/agents/single-prompt-agent/agent-settings.md) - [How to select voice of your agent](https://docs.sigmamind.ai/documentation/agents/single-prompt-agent/how-to-select-voice-of-your-agent.md) - [How to select LLM Model](https://docs.sigmamind.ai/documentation/agents/single-prompt-agent/how-to-select-llm-model.md) - [How to Select Language](https://docs.sigmamind.ai/documentation/agents/single-prompt-agent/how-to-select-language.md) - [How to Configure Who starts the conversation](https://docs.sigmamind.ai/documentation/agents/single-prompt-agent/untitled-page.md) - [Speech Settings](https://docs.sigmamind.ai/documentation/agents/settings/speech.md): Customize your AI agent’s voice, model, and background ambience. - [Model Settings](https://docs.sigmamind.ai/documentation/agents/settings/model.md): The Model Settings page allows you to configure a Global Prompt that will be automatically applied to all conversations. - [Transcription Settings](https://docs.sigmamind.ai/documentation/agents/settings/transcription-settings.md) - [Call Settings](https://docs.sigmamind.ai/documentation/agents/settings/call.md): Configure voicemail detection, reminders, silence handling, and max call duration. - [Dynamic variables](https://docs.sigmamind.ai/documentation/agents/agent-variables.md): Learn how to use dynamic variables in SigmaMind to personalize responses, campaigns, and conversations. - [Post Conversation Analysis](https://docs.sigmamind.ai/documentation/agents/settings/post-call-analysis.md): Learn how to use Post-Conversation Analysis in SigmaMind AI to automatically extract insights from conversations. - [How to use SIP Custom Header](https://docs.sigmamind.ai/documentation/agents/add-advance-nodes/howto-use-sip-custom-header.md) - [Agent level Webhooks](https://docs.sigmamind.ai/documentation/agents/agent-webhooks.md): Learn how to use Webhooks in SigmaMind to receive real-time events from AI agents. - [Webhook Logs](https://docs.sigmamind.ai/documentation/agents/webhook-logs.md) - [How to Access Tool Library ](https://docs.sigmamind.ai/documentation/tools/overview.md) - [How to Configure Authentication](https://docs.sigmamind.ai/documentation/tools/authentication.md) - [How to Add New Integration](https://docs.sigmamind.ai/documentation/tools/add-a-custom-tool.md) - [How to Add New Tool](https://docs.sigmamind.ai/documentation/tools/how-to-add-new-tool.md) - [Poku Labs](https://docs.sigmamind.ai/documentation/tools/poku-labs.md) - [Cal.com](https://docs.sigmamind.ai/documentation/tools/cal-com.md) - [Recharge](https://docs.sigmamind.ai/documentation/tools/recharge.md) - [Shopify](https://docs.sigmamind.ai/documentation/tools/shopify.md) - [Pipedrive](https://docs.sigmamind.ai/documentation/tools/pipedrive.md) - [Stripe](https://docs.sigmamind.ai/documentation/tools/stripe.md) - [Hubspot](https://docs.sigmamind.ai/documentation/tools/hubspot.md) - [Playground Overview](https://docs.sigmamind.ai/documentation/playground/overview.md): Learn how to use the Playground in SigmaMind to test, debug, and verify AI agents across multiple channels. - [Test Voice](https://docs.sigmamind.ai/documentation/playground/test-voice.md) - [Test Chat](https://docs.sigmamind.ai/documentation/playground/llm-playground.md) - [Create Test Cases](https://docs.sigmamind.ai/documentation/playground/test-simulations.md) - [Run Batch Simulations](https://docs.sigmamind.ai/documentation/playground/run-batch-simulations.md) - [Review Test Runs](https://docs.sigmamind.ai/documentation/playground/review-test-runs.md) - [Phone Number Overview](https://docs.sigmamind.ai/documentation/phone-number/overview.md): Learn how to purchase or bring your own phone number into SigmaMind and connect it to AI Agents for inbound and outbound calls. - [Purchase Phone Number](https://docs.sigmamind.ai/documentation/phone-number/purchase-phone-number.md): Step by step guide to buy a number from SigmaMind - [Bring Your Own Number (BYO)](https://docs.sigmamind.ai/documentation/phone-number/bring-your-own-number.md): How to integrate your own number with SigmaMind - [SIP Integration Overview](https://docs.sigmamind.ai/documentation/phone-number/sip-integration/overview.md): Learn how to integrate your phone numbers using SIP in SigmaMind. - [SIP Trunking](https://docs.sigmamind.ai/documentation/phone-number/sip-integration/sip-trunking.md): Step by step guide to understand SIP trunking - [Connect via SIP Trunking with Twilio](https://docs.sigmamind.ai/documentation/phone-number/sip-integration/providers/twilio.md): Guide to integrate Twilio phone numbers with SigmaMind using SIP trunking. - [Connect via SIP Trunking with Telnyx](https://docs.sigmamind.ai/documentation/phone-number/sip-integration/providers/telnyx.md): Guide to integrate Telnyx phone numbers with SigmaMind using SIP trunking. - [Make Calls](https://docs.sigmamind.ai/documentation/calls/make-calls.md) - [Receive Calls](https://docs.sigmamind.ai/documentation/calls/receive-calls.md): Different agents often need to share the same phone number, and Inbound calls frequently require context based on who's calling. For outbound calls and chats, you can easily provide this call-specific information through the API when initiating contact. However, inbound calls are initiated by others… - [Create API Keys](https://docs.sigmamind.ai/documentation/api-keys/overview.md) - [API Logs](https://docs.sigmamind.ai/documentation/api-keys/api-logs.md) - [Campaigns Overview](https://docs.sigmamind.ai/documentation/campaigns/overview.md): Learn how SigmaMind Campaign Calls work and when to use them. - [Create a Campaign](https://docs.sigmamind.ai/documentation/campaigns/create-campaign-calls.md): Step-by-step guide to create and configure outbound call campaigns in SigmaMind. - [Monitor Campaign Calls](https://docs.sigmamind.ai/documentation/campaigns/monitor-campaign-calls.md): Learn how to track, manage, and review the progress of outbound call campaigns in SigmaMind. - [Vicidial Integration Guide](https://docs.sigmamind.ai/vicidial-integration.md) - [Amazon Connect](https://docs.sigmamind.ai/amazon-connect.md) - [Vicidial Integration Guide](https://docs.sigmamind.ai/vicidial-integration-guide.md): This guide walks you through every configuration step needed to connect Vicidial to the SigmaMind Voice AI platform. Once complete, Vicidial will dial your customers through your existing carrier and automatically bridge each answered call to a SigmaMind AI agent in real time — with no manual agent… - [Five9 Integration Guide](https://docs.sigmamind.ai/five9-integration-guide.md): Connect Five9 to the SigmaMind Voice AI platform. Five9 dials your customers, bridges each answered call to a SigmaMind AI agent in real time, and hands qualified calls back to a live Five9 agent with full context. - [Genesys](https://docs.sigmamind.ai/genesys.md) - [NICE](https://docs.sigmamind.ai/nice.md) - [Observe Overview](https://docs.sigmamind.ai/documentation/observe/overview.md): Learn how to monitors chat & calls. - [Calls Logs](https://docs.sigmamind.ai/documentation/observe/monitor-calls.md) - [Chat logs](https://docs.sigmamind.ai/documentation/observe/monitor-chats.md) - [Call Analytics](https://docs.sigmamind.ai/documentation/observe/call-analytics.md) - [Chat Analytics](https://docs.sigmamind.ai/documentation/observe/chat-analytics.md): Monitor chat and ticket performance, tool usage, and intent detection across your SigmaMind AI agents. - [Termination Reasons](https://docs.sigmamind.ai/documentation/observe/termination-reasons.md) - [Set QA Rules](https://docs.sigmamind.ai/set-qa-rules.md) - [Review QA Issues](https://docs.sigmamind.ai/review-qa-issues.md) - [Set Escalation Rules](https://docs.sigmamind.ai/set-escalation-rules.md) - [Review Alerts](https://docs.sigmamind.ai/review-alerts.md) - [Set Notifiers](https://docs.sigmamind.ai/set-notifiers.md) - [Notifications](https://docs.sigmamind.ai/notifications.md) - [Workspace](https://docs.sigmamind.ai/workspace.md) - [Manage Members](https://docs.sigmamind.ai/add-members.md) - [International Calling & Fees](https://docs.sigmamind.ai/documentation/phone-number/international-calling-fees.md): Per-minute telephony rates for every country SigmaMind supports, powered by Twilio. - [Billing Logs](https://docs.sigmamind.ai/billing-logs.md) - [Create Phone Call](https://docs.sigmamind.ai/api-reference/calls/create-phone-call.md): Initiates an outbound call with the specified agent, caller, and destination numbers. Supports dynamic variables for personalization. Returns the created call record, including the callId for future retrieval or cancellation. - [Get Phone Call](https://docs.sigmamind.ai/api-reference/calls/get-phone-call.md): Retrieves the full details of a single call record by callId. Returns call status, direction, assigned agent, phone numbers, duration, and transcript metadata. - [List Phone Calls](https://docs.sigmamind.ai/api-reference/calls/list-phone-calls.md): Returns a paginated list of call records for the account, sorted by most recently created first. Use the status parameter to filter by call state. Use page and size to navigate through results. - [Delete Phone Call](https://docs.sigmamind.ai/api-reference/calls/delete-phone-call.md): Permanently deletes a call record by callId. Cannot be undone. Returns 204 No Content on success. - [Create Chat](https://docs.sigmamind.ai/api-reference/chats/create-a-chat.md): Creates a new chat session with the specified agent and sends the initial message. Returns the agent’s reply along with the chatId for subsequent completion, update, and end-session calls. - [Chat Completion](https://docs.sigmamind.ai/api-reference/chats/chat-completion.md): Submits a new customer message to an in_progress chat session and returns the agent's reply. The session must be active — calls against an ended session will be rejected. Returns the agent's response and updated session state. - [Get Chat](https://docs.sigmamind.ai/api-reference/chats/get-chat.md): Retrieves the full details of a single chat session by chatId. Returns the session status, assigned agent, message history, and dynamic variables. - [List Chats](https://docs.sigmamind.ai/api-reference/chats/list-chats.md): Returns a paginated list of chat sessions for the account, sorted by most recently created first. Use the status parameter to filter by session state. Use page and size to navigate through results. - [Update Chat](https://docs.sigmamind.ai/api-reference/chats/update-chat.md): Partially updates an in_progress chat session by chatId. Only fields provided in the request body are updated — omitted fields remain unchanged. Returns the updated session record. - [End Chat](https://docs.sigmamind.ai/api-reference/chats/end-chat.md): Ends an in_progress chat session by chatId, marking it as completed. No further messages can be submitted after a session is ended. Returns the final session record. - [Create Phone Number](https://docs.sigmamind.ai/api-reference/phone-numbers/create-phone-number.md): Purchases and provisions a new phone number for your account. Provide a specific phoneNumber in +E.164 format, or a countryCode (optionally areaCode) to auto-select one. Returns the provisioned number, including its sipPhoneNumber for subsequent get, update, and delete calls. - [Import Phone Number](https://docs.sigmamind.ai/api-reference/phone-numbers/import-phone-number.md): Imports an existing phone number via SIP trunking (BYO). Provide the number in +E.164 format along with SIP credentials (trunkUsername, trunkPassword, terminationSipURI). Returns the imported number, including its sipPhoneNumber. - [Get Phone Number](https://docs.sigmamind.ai/api-reference/phone-numbers/get-phone-number.md): Retrieves the full configuration of a single phone number by its +E.164 value. Returns assigned agents, active status, provider, and SIP configuration for BYO numbers. - [List Phone Numbers](https://docs.sigmamind.ai/api-reference/phone-numbers/list-phone-numbers.md): Returns a paginated list of all phone numbers registered on the account, sorted by most recently added first. Includes both SigmaMind-provisioned numbers and BYO numbers imported via SIP trunking. Use page and size to navigate through results. - [Update Phone Number](https://docs.sigmamind.ai/api-reference/phone-numbers/update-phone-number.md): Partially updates the configuration of an existing phone number. Only fields provided in the request body are updated — omitted fields remain unchanged. Returns the updated phone number record. - [Delete Phone Number](https://docs.sigmamind.ai/api-reference/phone-numbers/delete-phone-number.md): Permanently removes a phone number from your account — provisioned numbers are released to the carrier, BYO numbers remain with your telecom provider. Cannot be undone. Returns 204 No Content on success. - [Create Agent](https://docs.sigmamind.ai/api-reference/single-prompt-agents/create-agent.md): Creates a new single prompt agent with the specified configuration, including system prompt and agent settings. Returns the created agent including its agentId, which is required for all subsequent update, call, and simulation operations. - [Get Agent](https://docs.sigmamind.ai/api-reference/single-prompt-agents/get-agent.md): Retrieves the full details of a single prompt agent, along with agent settings. - [List Agents](https://docs.sigmamind.ai/api-reference/single-prompt-agents/list-single-prompt-agents.md): Retrieve a paginated list of all single prompt agents available in the account along with their details and configurations. - [Update Agent](https://docs.sigmamind.ai/api-reference/single-prompt-agents/update-agent.md): Partially updates an existing agent by agentId. Only fields provided in the request body are updated — omitted fields remain unchanged. Returns the updated agent record. - [Delete Agent](https://docs.sigmamind.ai/api-reference/single-prompt-agents/delete-agent.md): Permanently deletes an agent from your account. Cannot be undone. - [Create conversational Agent](https://docs.sigmamind.ai/api-reference/conversational-agents/create-conversational-agent.md): Creates a new conversational agent from the given nodes and agent settings. Every node is connected through the nodeName referenced by its edges, and the conversation starts at startNodeName, defaulting to the first node of the request. Returns the created agent including its agentId, which is requi… - [Get conversational Agent](https://docs.sigmamind.ai/api-reference/conversational-agents/get-conversational-agent.md): Get a conversational agent, along with agent settings - [Update conversational Agent](https://docs.sigmamind.ai/api-reference/conversational-agents/update-conversational-agent.md): Partially updates an existing conversational agent by agentId. Only the fields provided in the request body are updated — omitted fields remain unchanged. Nodes carrying a nodeId are updated, while nodes without one are created and connected through the nextNodeId or nextNodeName referenced by their… - [Create Campaign](https://docs.sigmamind.ai/api-reference/campaigns/create-campaign.md): Creates an outbound call campaign with the specified agent, caller number, and CSV contact list. Set isScheduled=true with scheduledDate, scheduledTime, and scheduledTimezone to defer launch. Returns the created campaign, including its campaignId. - [Get Campaign](https://docs.sigmamind.ai/api-reference/campaigns/get-campaign.md): Retrieves the full details of a single campaign by campaignId. Returns current status, schedule configuration, assigned agent, caller number, and any CSV upload errors. - [List Campaigns](https://docs.sigmamind.ai/api-reference/campaigns/list-campaigns.md): Returns a paginated list of campaigns for the account, sorted by most recently created first. Use the status parameter to filter by lifecycle state. Use page and size to navigate through results. - [Update Campaign](https://docs.sigmamind.ai/api-reference/campaigns/update-campaign.md): Partially updates an existing campaign by campaignId. Only fields provided in the request body are updated — omitted fields remain unchanged. Returns the updated campaign record. - [Delete Campaign](https://docs.sigmamind.ai/api-reference/campaigns/delete-campaign.md): Permanently deletes a campaign by campaignId. Cannot be undone — the campaign must have no associated calls before deletion. Returns 204 No Content on success. - [Create Integration](https://docs.sigmamind.ai/api-reference/integrations/create-integration.md): Registers a new third-party integration for your account. Supply the provider type (e.g. shopify, cal_com) along with an optional friendly name and description. Returns the created integration including its integrationId, which is required for all subsequent auth and tool operations. - [Get Integration](https://docs.sigmamind.ai/api-reference/integrations/get-integration.md): Retrieves the full details of a single integration by integrationId. Returns the provider type, friendly name, description, and current status of the integration. - [List Integrations](https://docs.sigmamind.ai/api-reference/integrations/list-integrations.md): Returns a paginated list of integrations registered on the account, sorted by most recently created first. Use the provider parameter to filter by integration type. Use page and size to navigate through results. - [Update Integration](https://docs.sigmamind.ai/api-reference/integrations/update-integration.md): Partially updates an existing integration by integrationId. Only fields provided in the request body are updated — omitted fields remain unchanged. Returns the updated integration record. - [Delete Integration](https://docs.sigmamind.ai/api-reference/integrations/delete-integration.md): Permanently deletes an integration by integrationId, including all associated auth credentials and tools. Cannot be undone. Returns 204 No Content on success. - [Create Integration Auth](https://docs.sigmamind.ai/api-reference/integration-auth/create-integration-auth.md): Creates and stores authentication credentials for an integration. Supports three auth types: API Key, Basic auth, and Bearer token. Returns the created auth record including its authId, which is required for subsequent get, update, and delete calls. - [Get Integration Auth](https://docs.sigmamind.ai/api-reference/integration-auth/get-integration-auth.md): Retrieves the full details of a single auth record by authId. Returns the auth type, credential metadata, and associated integration. Sensitive credential values are not returned after creation. - [List Integration Auth](https://docs.sigmamind.ai/api-reference/integration-auth/list-integration-auth.md): Returns a paginated list of auth records for a given integration, sorted by most recently created first. Use the authType parameter to filter by credential type. Use page and size to navigate through results. - [Update Integration Auth](https://docs.sigmamind.ai/api-reference/integration-auth/update-integration-auth.md): Partially updates an existing auth record by authId. Only fields provided in the request body are updated — omitted fields remain unchanged. Returns the updated auth record. - [Delete Integration Auth](https://docs.sigmamind.ai/api-reference/integration-auth/delete-integration-auth.md): Permanently deletes an auth record by authId. Cannot be undone — any tools referencing this auth record will lose the ability to authenticate. Returns 204 No Content on success. - [Create Tool](https://docs.sigmamind.ai/api-reference/integration-tools/create-tool.md): Creates a new API tool under the specified integration. Define the HTTP endpoint, method, and parameter schema the agent will use when invoking the tool. Returns the created tool including its toolId, which is required for subsequent get, update, delete, and execute calls. - [Execute Tool](https://docs.sigmamind.ai/api-reference/integration-tools/execute-tool.md): Executes a tool against its configured third-party API using the supplied placeholder values. Auth credentials are resolved automatically; specify authId to select specific credentials when multiple exist. Optionally set saveAsMock to persist the live request/response as a named mock, or useMockTool… - [Get Tool](https://docs.sigmamind.ai/api-reference/integration-tools/get-tool.md): Retrieves the full configuration of a single tool by toolId. Returns the tool's endpoint, HTTP method, parameter schema, and access type. - [List Tools](https://docs.sigmamind.ai/api-reference/integration-tools/list-tools.md): Returns a paginated list of tools registered under an integration, sorted by most recently created first. Use the status parameter to filter by tool state. Use page and size to navigate through results. - [Update Tool](https://docs.sigmamind.ai/api-reference/integration-tools/update-tool.md): Partially updates an existing tool by toolId. Only fields provided in the request body are updated — omitted fields remain unchanged. Returns the updated tool record. - [Delete Tool](https://docs.sigmamind.ai/api-reference/integration-tools/delete-tool.md): Permanently deletes a tool by toolId — cannot be undone. Any agent using this tool will lose access immediately. Returns 204 No Content on success. - [Create Mock Tool Data](https://docs.sigmamind.ai/api-reference/mock-tool-data/create-mock-tool-data.md): Creates a named mock tool data in the tenant mock library. Use this for manual mock tool data creation or after capturing a live tool execute. Returns the created mock including its mockToolDataId. - [Get Mock Tool Data](https://docs.sigmamind.ai/api-reference/mock-tool-data/get-mock-tool-data.md): Retrieves a single mock tool data record by mockToolDataId. - [List Mock Tool Data](https://docs.sigmamind.ai/api-reference/mock-tool-data/list-mock-tool-data.md): Returns a paginated list of mock tool data records for the tenant, optionally filtered by toolId. Sorted by most recently created first. - [Update Mock Tool Data](https://docs.sigmamind.ai/api-reference/mock-tool-data/update-mock-tool-data.md): Partially updates a mock tool data record. Only provided fields are changed. - [Delete Mock Tool Data](https://docs.sigmamind.ai/api-reference/mock-tool-data/delete-mock-tool-data.md): Deletes a mock tool data record. Fails if any active test case still references this mock via mockToolData. - [Create Test Case](https://docs.sigmamind.ai/api-reference/test-cases/create-test-case.md): Creates a simulation test case for the specified agent. Define the scenario using user persona, goals, and evaluation criteria. Returns the created test case, including its testCaseId for subsequent get, update, delete, and batch-run calls. - [Get Test Case](https://docs.sigmamind.ai/api-reference/test-cases/get-test-case.md): Retrieves the full details of a single simulation test case by testCaseId. Returns the conversation scenario definition, including the user persona, goals, evaluation criteria, and current status. - [List Test Cases](https://docs.sigmamind.ai/api-reference/test-cases/list-test-cases.md): Returns a paginated list of simulation test cases for the specified agent, sorted by most recently created first. Use page and size to navigate through results. - [Update Test Case](https://docs.sigmamind.ai/api-reference/test-cases/update-test-case.md): Partially updates an existing simulation test case by testCaseId. Only fields provided in the request body are updated — omitted fields remain unchanged. Returns the updated test case record. - [Delete Test Case](https://docs.sigmamind.ai/api-reference/test-cases/delete-test-case.md): Permanently deletes a simulation test case by testCaseId. Cannot be undone — the test case will no longer be available for future batch runs. Returns 204 No Content on success. - [Create Batch Run](https://docs.sigmamind.ai/api-reference/batch/create-batch-run.md): Triggers a new batch run by executing the specified test cases in parallel against the selected agent. Returns the created batch including its batchId, which is required for subsequent get and list test-run calls. - [Get Batch Run](https://docs.sigmamind.ai/api-reference/batch/get-batch-run.md): Retrieves the full details of a batch run by batchId, scoped to the specified agent. Returns overall batch status, test case count, pass/fail summary, and individual run results. - [List Batch Runs](https://docs.sigmamind.ai/api-reference/batch/list-batch-runs.md): Returns a paginated list of batch runs for the specified agent, sorted by most recently created first. Use page and size to navigate through results. - [Get Test Run](https://docs.sigmamind.ai/api-reference/test-runs/get-test-run.md): Retrieves the full details of a single test run by jobId, scoped to the specified batch and agent. Returns the test case name, execution status, expected and actual outcomes, and transcript details. - [List Test Runs](https://docs.sigmamind.ai/api-reference/test-runs/list-test-runs.md): Returns a paginated list of test run results for the specified batch, sorted by most recently created first. Use page and size to navigate through results. - [Create Webhook](https://docs.sigmamind.ai/api-reference/webhooks/create-webhook.md): Registers a new webhook to receive real-time event notifications on your HTTPS endpoint. The webhook is scoped to a single agent and fires only for the event types you specify. Returns the created webhook including its webhookId and HMAC secret — store the secret securely as it is only returned once… - [Get Webhook](https://docs.sigmamind.ai/api-reference/webhooks/get-webhook.md): Retrieves the full configuration of a single webhook by webhookId. Returns the target URL, scoped agent, subscribed event types, and active status. The HMAC secret is not returned after creation — store it securely when the webhook is first created. - [List Webhooks](https://docs.sigmamind.ai/api-reference/webhooks/list-webhooks.md): Returns a paginated list of webhooks for the account, sorted by most recently created first. Use agentId to filter by agent and active to filter by enabled/disabled status. Use page and size to navigate through results. - [Delete Webhook](https://docs.sigmamind.ai/api-reference/webhooks/delete-webhook.md): Permanently removes a webhook by webhookId. Cannot be undone — no further event deliveries will be attempted to the registered URL. Returns 204 No Content on success. - [Create QA Rule](https://docs.sigmamind.ai/api-reference/qa-rules/create-qa-rule.md): Creates a new QA rule with the specified configuration. Define the rule's evaluation criteria and expected result. Returns the created QA rule, including its qaRuleId for subsequent get, update, delete, and issue-listing calls. - [Get QA Rule](https://docs.sigmamind.ai/api-reference/qa-rules/get-qa-rule.md): Retrieves the full details of a single QA rule by qaRuleId. Returns the rule configuration including its evaluation criteria, expected value, and agents it will be applied to. - [List QA Rules](https://docs.sigmamind.ai/api-reference/qa-rules/list-qa-rules.md): Returns a paginated list of all QA rules, sorted by most recently created first. Use page and size to navigate through results. - [Update QA Rule](https://docs.sigmamind.ai/api-reference/qa-rules/update-qa-rule.md): Partially updates an existing QA rule by qaRuleId. Only fields provided in the request body are updated — omitted fields remain unchanged. Returns the updated QA rule record. - [Delete QA Rule](https://docs.sigmamind.ai/api-reference/qa-rules/delete-qa-rule.md): Permanently deletes a QA rule by qaRuleId. Cannot be undone — the rule will no longer be evaluated against future interactions. Returns 204 No Content on success. - [Get QA Issue](https://docs.sigmamind.ai/api-reference/qa-issues/get-qa-issue.md): Retrieves the full details of a single QA issue by qaIssueId. Returns the issue record including its associated QA rule, status, reasons, and any metadata captured at detection time. - [List QA Issues](https://docs.sigmamind.ai/api-reference/qa-issues/list-qa-issues.md): Returns a paginated list of QA issues for the specified QA rule, sorted by most recently created first. Use page and size to navigate through results. - [Create knowledge base](https://docs.sigmamind.ai/api-reference/knowledge-bases/create-knowledge-base.md): Creates a knowledge base by providing a name, optional text snippets, URLs, and file attachments. Sources are processed in order: text, URLs, then files. Supported file types include PDF, TXT, HTML, Markdown, and DOCX. Maximum file size is 25 MB. - [Get knowledge base](https://docs.sigmamind.ai/api-reference/knowledge-bases/get-knowledge-base-by-kbid.md): Retrieves a single knowledge base along with its associated sources and timestamps. - [List knowledge bases](https://docs.sigmamind.ai/api-reference/knowledge-bases/list-knowledge-bases.md): Returns a paginated list of knowledge bases for the account, sorted by most recently updated. Each item includes its sources and timestamps. Use page and size for pagination. - [Update knowledge base](https://docs.sigmamind.ai/api-reference/knowledge-bases/update-knowledge-base.md): Updates a knowledge base by adding new sources and/or modifying its name. Supported file types include PDF, TXT, HTML, Markdown, and DOCX. Maximum file size is 25 MB. - [Delete knowledge base](https://docs.sigmamind.ai/api-reference/knowledge-bases/delete-knowledge-base.md): Deletes a knowledge base along with all its associated sources. This action is irreversible. - [Delete document](https://docs.sigmamind.ai/api-reference/knowledge-bases/delete-one-document-from-a-knowledge-base.md): Deletes a specific source from a knowledge base. Other sources remain unaffected. - [MCP Tools Integration](https://docs.sigmamind.ai/mcp/client.md) - [MCP Server](https://docs.sigmamind.ai/mcp/server.md): Complete installation guide for SigmaMind API MCP Server across all Agent IDEs - [Tutorials](https://docs.sigmamind.ai/tutorials/agents/overview.md) - [Create Agent](https://docs.sigmamind.ai/api-reference/agents/create-agent.md): Creates a new single prompt agent with the specified configuration, including system prompt and agent settings. Returns the created agent including its agentId, which is required for all subsequent update, call, and simulation operations. - [List Agent Tools](https://docs.sigmamind.ai/api-reference/agents/list-agent-tools.md): Retrieve a paginated list of all the tools associated with the agent. - [Update Agent](https://docs.sigmamind.ai/api-reference/agents/update-agent.md): Partially updates an existing agent by agentId. Only fields provided in the request body are updated — omitted fields remain unchanged. Returns the updated agent record. - [Create Batch Run](https://docs.sigmamind.ai/api-reference/batch-runs/create-batch-run.md): Triggers a new batch run by executing the specified test cases in parallel against the selected agent. Returns the created batch including its batchId, which is required for subsequent get and list test-run calls. - [Get Batch Run](https://docs.sigmamind.ai/api-reference/batch-runs/get-batch-run.md): Retrieves the full details of a batch run by batchId, scoped to the specified agent. Returns overall batch status, test case count, pass/fail summary, and individual run results. - [List Batch Runs](https://docs.sigmamind.ai/api-reference/batch-runs/list-batch-runs.md): Returns a paginated list of batch runs for the specified agent, sorted by most recently created first. Use page and size to navigate through results. - [Create Chat](https://docs.sigmamind.ai/api-reference/chats/create-chat.md): Creates a new chat session with the specified agent and sends the initial message. Returns the agent’s reply along with the chatId for subsequent completion, update, and end-session calls. - [List Integration Auth](https://docs.sigmamind.ai/api-reference/integration-auth/list-integration-auth-records.md): Returns a paginated list of auth records for a given integration, sorted by most recently created first. Use the authType parameter to filter by credential type. Use page and size to navigate through results. - [Introduction](https://docs.sigmamind.ai/api-reference/introduction.md): Example section for showcasing API endpoints - [Delete document](https://docs.sigmamind.ai/api-reference/knowledge-bases/delete-document.md): Deletes a specific source from a knowledge base. Other sources remain unaffected. - [Get knowledge base](https://docs.sigmamind.ai/api-reference/knowledge-bases/get-knowledge-base.md): Retrieves a single knowledge base along with its associated sources and timestamps. - [List Agents](https://docs.sigmamind.ai/api-reference/single-prompt-agents/list-agents.md): Retrieve a paginated list of all single prompt agents available in the account along with their details and configurations. - [SigmaMind AI Integration with Gorgias](https://docs.sigmamind.ai/app-integration/gorgias.md) - [Integrating Shopify with SigmaMind AI](https://docs.sigmamind.ai/app-integration/shopify.md) - [Development](https://docs.sigmamind.ai/development.md): Preview changes locally to update your docs - [Apply brand persona](https://docs.sigmamind.ai/documentation/agents/brand-persona/apply-brand-persona.md) - [Overview](https://docs.sigmamind.ai/documentation/agents/brand-persona/overview.md) - [Setup your brand persona](https://docs.sigmamind.ai/documentation/agents/brand-persona/setup-your-brand-persona.md) - [Create new intent](https://docs.sigmamind.ai/documentation/agents/customer-intent/create-new-intent.md) - [Disable existing intents](https://docs.sigmamind.ai/documentation/agents/customer-intent/disable-existing-intents.md) - [Overview](https://docs.sigmamind.ai/documentation/agents/customer-intent/overview.md) - [Transcription Settings](https://docs.sigmamind.ai/documentation/agents/settings/transcription.md): Configure basic settings for your AI agents in SigmaMind. - [Agent Webhook Settings](https://docs.sigmamind.ai/documentation/agents/settings/webhook.md): Configure webhooks to receive real-time notifications from your AI agents in SigmaMind. - [Setup your AI agent](https://docs.sigmamind.ai/documentation/agents/setup-your-ai-agent.md) - [Test](https://docs.sigmamind.ai/documentation/agents/test1.md): Add image, video, and other HTML elements - [Connect Agent for Inbound Calls](https://docs.sigmamind.ai/documentation/agents/voice/inbound.md) - [Connect Agent for Outbound Calls](https://docs.sigmamind.ai/documentation/agents/voice/outbound.md) - [Create Your First AI Agent](https://docs.sigmamind.ai/documentation/getting-started/create-first-ai-agent.md): Get started with SigmaMind AI — a complete platform for building, testing, and deploying conversational AI agents. - [Node logs](https://docs.sigmamind.ai/documentation/playground/analytics/node-logs.md) - [System.logs](https://docs.sigmamind.ai/documentation/playground/analytics/system.logs.md) - [Controls](https://docs.sigmamind.ai/documentation/playground/controls.md) - [System](https://docs.sigmamind.ai/documentation/system/docs.md) - [Test](https://docs.sigmamind.ai/documentation/test/docs.md) - [Code Blocks](https://docs.sigmamind.ai/essentials/code.md): Display inline code and code blocks - [Images and Embeds](https://docs.sigmamind.ai/essentials/images.md): Add image, video, and other HTML elements - [Markdown Syntax](https://docs.sigmamind.ai/essentials/markdown.md): Text, title, and styling in standard markdown - [Navigation](https://docs.sigmamind.ai/essentials/navigation.md): The navigation field in docs.json defines the pages that go in the navigation menu - [Reusable Snippets](https://docs.sigmamind.ai/essentials/reusable-snippets.md): Reusable, custom snippets to keep content in sync - [Global Settings](https://docs.sigmamind.ai/essentials/settings.md): Mintlify gives you complete control over the look and feel of your documentation using the docs.json file - [Examples](https://docs.sigmamind.ai/examples.md) - [Introduction](https://docs.sigmamind.ai/index.md) - [Quickstart](https://docs.sigmamind.ai/quickstart.md): Start building awesome documentation in under 5 minutes - [Playgroud overview](https://docs.sigmamind.ai/test/playgroud-overview.md) - [Test chat](https://docs.sigmamind.ai/test/test-chat.md) - [Test email](https://docs.sigmamind.ai/test/test-email.md) - [Test voice](https://docs.sigmamind.ai/test/test-voice.md) - [Build Conversational AI Agents for Customer Support](https://docs.sigmamind.ai/use-cases/appointment-booking.md) - [Build Conversational AI Agents for Customer Support](https://docs.sigmamind.ai/use-cases/customer-support.md) - [Build Conversational AI Agents for Customer Support](https://docs.sigmamind.ai/use-cases/lead-qualification.md) - [VICIdial Integration](https://docs.sigmamind.ai/VICIdial.md) ## OpenAPI Specs - [api-docs](/api-docs.yaml) - [openapi](/api-reference/openapi.json) ## Optional - [Documentation](https://docs.sigmamind.ai) - [Discord Community](https://www.discord.com/invite/jSWGcw5Wyx) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.