List voice agents

GET

/api/v2/aura/agents

curl --request GET \
  --url https://api.sipstack.com/api/v2/aura/agents \
  --header 'x-api-key: <x-api-key>'

const url = 'https://api.sipstack.com/api/v2/aura/agents';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.sipstack.com/api/v2/aura/agents',
  headers: {'x-api-key': '<x-api-key>'}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

Returns your organization’s Aura voice agents, each with its status and the DIDs assigned to it (the numbers whose inbound route points at the agent). The internal agent config — system prompt, flow, credentials — is never exposed. Requires aura:read. Returns an empty list when no voice service is provisioned (not an error).

Authorizations

apiKeyAuth

Responses

200

The voice-agent roster.

application/json

object

success

boolean

data

Array<object>

An Aura voice agent (list view). The internal config (system prompt, flow, credentials) is never exposed.

object

string format: uuid

name

string

nullable

status

Defaults to active for agents created before status tracking.

string

type

string

nullable

mode

string

nullable

assigned_numbers

The DIDs whose inbound route points at this agent (zero, one, or many).

Array<string>

Example

{
  "data": [
    {
      "status": "active",
      "assigned_numbers": [
        "+16473001234"
      ]
    }
  ]
}

401

Missing or invalid API key.

application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}

403

The key is missing the aura:read scope.

application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}