GET
/
api
/
agents
/
{agent_id}
curl --request GET \
  --url https://api.ultravox.ai/api/agents/{agent_id} \
  --header 'X-API-Key: <api-key>'
{
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "callTemplate": {
    "name": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "medium": {
      "webRtc": {},
      "twilio": {},
      "serverWebSocket": {
        "inputSampleRate": 123,
        "outputSampleRate": 123,
        "clientBufferSizeMs": 123
      },
      "telnyx": {},
      "plivo": {},
      "exotel": {},
      "sip": {
        "incoming": {},
        "outgoing": {
          "to": "<string>",
          "from": "<string>",
          "username": "<string>",
          "password": "<string>"
        }
      }
    },
    "initialOutputMedium": "MESSAGE_MEDIUM_UNSPECIFIED",
    "joinTimeout": "<string>",
    "maxDuration": "<string>",
    "vadSettings": {
      "turnEndpointDelay": "<string>",
      "minimumTurnDuration": "<string>",
      "minimumInterruptionDuration": "<string>",
      "frameActivationThreshold": 123
    },
    "recordingEnabled": true,
    "firstSpeakerSettings": {
      "user": {
        "fallback": {
          "delay": "<string>",
          "text": "<string>",
          "prompt": "<string>"
        }
      },
      "agent": {
        "uninterruptible": true,
        "text": "<string>",
        "prompt": "<string>",
        "delay": "<string>"
      }
    },
    "systemPrompt": "<string>",
    "temperature": 123,
    "model": "<string>",
    "voice": "<string>",
    "externalVoice": {
      "elevenLabs": {
        "voiceId": "<string>",
        "model": "<string>",
        "speed": 123,
        "useSpeakerBoost": true,
        "style": 123,
        "similarityBoost": 123,
        "stability": 123,
        "pronunciationDictionaries": [
          {
            "dictionaryId": "<string>",
            "versionId": "<string>"
          }
        ],
        "optimizeStreamingLatency": 123
      },
      "cartesia": {
        "voiceId": "<string>",
        "model": "<string>",
        "speed": 123,
        "emotion": "<string>",
        "emotions": [
          "<string>"
        ]
      },
      "playHt": {
        "userId": "<string>",
        "voiceId": "<string>",
        "model": "<string>",
        "speed": 123,
        "quality": "<string>",
        "temperature": 123,
        "emotion": 123,
        "voiceGuidance": 123,
        "styleGuidance": 123,
        "textGuidance": 123,
        "voiceConditioningSeconds": 123
      },
      "lmnt": {
        "voiceId": "<string>",
        "model": "<string>",
        "speed": 123,
        "conversational": true
      }
    },
    "languageHint": "<string>",
    "timeExceededMessage": "<string>",
    "inactivityMessages": [
      {
        "duration": "<string>",
        "message": "<string>",
        "endBehavior": "END_BEHAVIOR_UNSPECIFIED"
      }
    ],
    "selectedTools": [
      {
        "toolId": "<string>",
        "toolName": "<string>",
        "temporaryTool": {
          "modelToolName": "<string>",
          "description": "<string>",
          "dynamicParameters": [
            {
              "name": "<string>",
              "location": "PARAMETER_LOCATION_UNSPECIFIED",
              "schema": {},
              "required": true
            }
          ],
          "staticParameters": [
            {
              "name": "<string>",
              "location": "PARAMETER_LOCATION_UNSPECIFIED",
              "value": "<any>"
            }
          ],
          "automaticParameters": [
            {
              "name": "<string>",
              "location": "PARAMETER_LOCATION_UNSPECIFIED",
              "knownValue": "KNOWN_PARAM_UNSPECIFIED"
            }
          ],
          "requirements": {
            "httpSecurityOptions": {
              "options": [
                {
                  "requirements": {},
                  "ultravoxCallTokenRequirement": {
                    "scopes": [
                      "<string>"
                    ]
                  }
                }
              ]
            },
            "requiredParameterOverrides": [
              "<string>"
            ]
          },
          "timeout": "<string>",
          "precomputable": true,
          "http": {
            "baseUrlPattern": "<string>",
            "httpMethod": "<string>"
          },
          "client": {},
          "defaultReaction": "AGENT_REACTION_UNSPECIFIED",
          "staticResponse": {
            "responseText": "<string>"
          }
        },
        "nameOverride": "<string>",
        "authTokens": {},
        "parameterOverrides": {},
        "transitionId": "<string>"
      }
    ],
    "contextSchema": {}
  },
  "statistics": {
    "calls": 123
  }
}

Authorizations

X-API-Key
string
header
required

API key

Path Parameters

agent_id
string
required

Response

200 - application/json
agentId
string
required
created
string
required
statistics
object
required

Statistics about the agent's usage

name
string
Maximum length: 64
callTemplate
object

A CallTemplate that can be used to create Ultravox calls with shared properties.