Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.sigmamind.ai/llms.txt

Use this file to discover all available pages before exploring further.

SigmaMind AI lets you trigger outbound phone calls either through the Dashboard UI or programmatically via the POST /v1/calls API endpoint. Your AI agent handles the conversation end-to-end — no human needed on your side. Before you start, make sure you have:
  • A configured agent
  • A phone number provisioned or imported on your account
  • Your SigmaMind API key (X-API-Key) (for API usage)

Step 1: Get a Phone Number

You need a caller number before placing any outbound call. SigmaMind supports two options:
OptionUI PathAPI EndpointWhen to Use
Provision a new numberDeploy → Phone Numbers → Add Phone NumberPOST /v1/phone-numbersBuy a SigmaMind-managed number directly
Import your own (BYO)Deploy → Phone Numbers → Add Phone Number → ImportPOST /v1/phone-numbers/importBring a number via SIP trunking from your telecom provider

Via the Dashboard

  1. In the left sidebar, go to Deploy → Phone Numbers.
  2. Click Add Phone Number.
  3. Choose to provision a new number or import an existing one via SIP trunking.
  4. Once added, the number appears in your list with its active status, provider (e.g. Twilio), and assigned agent.
To configure a number after adding it, click it in the list. You’ll see:
  • Phone Number Name — a friendly label (e.g. “Debt Collection Inbound”)
  • Inbound Call Setting — assign an Inbound AI Agent and optionally an Inbound Webhook URL
  • Outbound Call Setting — assign an Outbound AI Agent and set the outbound phone number

Via the API

To see all numbers already on your account:
GET https://api.sigmamind.ai/v1/phone-numbers
X-API-Key: <your-api-key>
Each number returned includes its assigned agent, active status, provider, and SIP configuration.

Step 2: Create an Outbound Call

Via the Dashboard

  1. Go to Deploy → Phone Numbers and select the phone number you want to call from.
  2. Scroll to the Outbound Call Setting section.
  3. Set the Outbound Phone Number (the number that will appear as the caller ID).
  4. Select an Outbound AI Agent from the dropdown — this agent will handle the call conversation.
  5. Click the Call button at the bottom of the panel to initiate an outbound call immediately.
Make sure an Outbound AI Agent is selected before clicking Call. If no agent is assigned, the call will not be initiated.

Via the API

Use POST /v1/calls to initiate a call. The agent you pass (or the one pre-assigned to the number) will handle the conversation.

Required Parameters

ParameterTypeDescription
fromPhoneNumberstring (E.164)Your SigmaMind number, e.g. +14157774444
toPhoneNumberstring (E.164)The number you want to call, e.g. +12137774445

Optional Parameters

ParameterTypeDescription
agentIdstringOverride which agent handles this call. If omitted, uses the agent assigned to the fromPhoneNumber
dynamicVariablesobjectKey-value pairs injected into your agent’s prompt at runtime, e.g. customer name, account ID

Example Request

curl -X POST https://api.sigmamind.ai/v1/calls \
  -H "X-API-Key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "fromPhoneNumber": "+14157774444",
    "toPhoneNumber": "+12137774445",
    "agentId": "agent_abc123",
    "dynamicVariables": {
      "customer_name": "John Doe",
      "plan_type": "Premium"
    }
  }'
The response includes a callId — keep this to retrieve call details later.
Use dynamicVariables to personalise each call without creating separate agents. Any variable you pass is available inside your agent’s prompt at call time.

Step 3: Run a Campaign (High-Volume Outbound)

For bulk outbound — sales blasts, reminders, surveys — use Campaigns instead of triggering individual calls.

How Campaigns Work

You upload a CSV of contacts, attach an agent and a caller number, and SigmaMind dials through the list automatically with configurable concurrency.

Via the Dashboard

  1. In the left sidebar, go to Deploy → Campaign Calls.
  2. Click Create Campaign.
  3. Fill in the campaign details:
    • Campaign Name — a human-readable label for this campaign
    • Agent — select the AI agent that will handle all calls
    • Phone Number — select the caller number (must already be added under Phone Numbers)
    • Contacts CSV — upload a CSV file containing your contact list
    • Concurrent Calls — set how many calls to run in parallel
    • Dynamic Variables (optional) — add key-value pairs applied to every call in the campaign
  4. To schedule the campaign for a later time, toggle Schedule Campaign and fill in:
    • Date — e.g. 2025-09-01
    • Time — e.g. 09:00
    • Timezone — e.g. America/New_York
  5. Click Launch Campaign to start immediately, or Save to confirm a scheduled campaign.
Once created, your campaign appears in the Campaign Calls list with its status (Active, Scheduled, Completed, or Paused). Click a campaign to view progress, pause/resume it, or delete it.
Your CSV must include at minimum a column for the destination phone number in E.164 format (e.g. +12137774445). Additional columns can be used as dynamic variables in your agent’s prompt.

Via the API

Create a Campaign

POST https://api.sigmamind.ai/v1/campaigns
ParameterTypeRequiredDescription
campaignNamestringA human-readable name for this campaign
agentIdstringThe agent that will handle all calls in this campaign
sipPhoneNumberstringThe caller number (E.164)
filestringCSV file with contact list
concurrentCallsintegerHow many calls to run in parallel
dynamicVariablesobjectVariables applied to every call in the campaign
isScheduledbooleanSet true to schedule for a future time
scheduledDatestringDate to launch, e.g. 2025-09-01
scheduledTimestringTime to launch, e.g. 09:00
scheduledTimezonestringTimezone, e.g. America/New_York

Example — Immediate Campaign

curl -X POST https://api.sigmamind.ai/v1/campaigns \
  -H "X-API-Key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "campaignName": "September Follow-ups",
    "agentId": "agent_abc123",
    "sipPhoneNumber": "+14157774444",
    "file": "<base64-encoded-csv>",
    "concurrentCalls": 5
  }'

Example — Scheduled Campaign

curl -X POST https://api.sigmamind.ai/v1/campaigns \
  -H "X-API-Key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "campaignName": "Morning Reminders",
    "agentId": "agent_abc123",
    "sipPhoneNumber": "+14157774444",
    "file": "<base64-encoded-csv>",
    "concurrentCalls": 3,
    "isScheduled": true,
    "scheduledDate": "2025-09-01",
    "scheduledTime": "09:00",
    "scheduledTimezone": "America/New_York"
  }'
The response includes a campaignId you can use to check status, update, or delete the campaign.

Step 4: Monitor Calls

Via the Dashboard

  • Conversations — Go to Observe → Conversations in the sidebar to see a live and historical list of all calls. Click any call to view its transcript, duration, assigned agent, and status.
  • Analytics — Go to Observe → Analytics to see aggregate metrics across all calls — total call volume, average duration, completion rates, and more.
  • Logs — Go to System → Logs for a detailed technical log of call events, errors, and webhook deliveries.
  • Campaign Calls — Go to Deploy → Campaign Calls, click a campaign, and view per-contact call status in real time as the campaign dials through your list.

Via the API

Retrieve a Single Call

GET https://api.sigmamind.ai/v1/calls/{callId}
X-API-Key: <your-api-key>
Returns: call status, direction, assigned agent, phone numbers, duration, and transcript metadata.

List All Calls

GET https://api.sigmamind.ai/v1/calls?status=completed&page=1&size=20
X-API-Key: <your-api-key>
Filter by status to narrow results. Paginate with page and size. Rather than polling, register a webhook to receive real-time push notifications when call events happen. Via the Dashboard: Go to System → Webhooks (or configure the Inbound Webhook URL directly on a phone number under Deploy → Phone Numbers) to add and manage webhooks without writing any code. Via the API:
POST https://api.sigmamind.ai/v1/webhooks
You can scope webhooks to a specific agent using agentId, and list or toggle them via GET /v1/webhooks.
Webhooks are the recommended approach for production systems — they eliminate polling overhead and give you instant event delivery.

Delete a Call Record

If you need to remove a call record from your account:
DELETE https://api.sigmamind.ai/v1/calls/{callId}
X-API-Key: <your-api-key>
Returns 204 No Content on success. This action cannot be undone.

Quick Reference

Dashboard Navigation

TaskWhere to go
Add or manage phone numbersDeploy → Phone Numbers
Make a single outbound callDeploy → Phone Numbers → select number → Outbound Call Setting → Call
Create or manage campaignsDeploy → Campaign Calls
View call transcripts & historyObserve → Conversations
View call analyticsObserve → Analytics
View system logsSystem → Logs
Manage API keysDeploy → API Keys

API Endpoints

TaskMethodEndpoint
Initiate a single outbound callPOST/v1/calls
Get call detailsGET/v1/calls/{callId}
List all callsGET/v1/calls
Delete a call recordDELETE/v1/calls/{callId}
Create a bulk campaignPOST/v1/campaigns
Get campaign statusGET/v1/campaigns/{campaignId}
Register a webhookPOST/v1/webhooks
List phone numbersGET/v1/phone-numbers
Provision a numberPOST/v1/phone-numbers
Import a number (BYO)POST/v1/phone-numbers/import