Get a voice agent

GET

/api/v2/aura/agents/{id}

curl --request GET \
  --url https://api.sipstack.com/api/v2/aura/agents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'x-api-key: <x-api-key>'

import requests

url = "https://api.sipstack.com/api/v2/aura/agents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"

headers = {"x-api-key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.json())

const url = 'https://api.sipstack.com/api/v2/aura/agents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
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/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0',
  headers: {'x-api-key': '<x-api-key>'}
};

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

Returns one voice agent by UUID, including its assigned numbers and knowledge-base tag-set (kb_tags). Requires aura:read. 404 when the agent isn’t your organization’s — the endpoint never confirms another org’s agent exists.

Authorizations

apiKeyAuth

Parameters

Path Parameters

required

string format: uuid

Responses

200

The voice agent.

application/json

object

success

boolean

data

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>

kb_tags

The agent’s knowledge-base tag-set (see the KB endpoints).

Array<string>

Example

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

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"
}

404

Voice agent not found in your organization.

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"
}