Get Agent

Get Agent

curl --request GET \
  --url https://api.revring.ai/v1/agents/{id} \
  --header 'x-api-key: <api-key>'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sipTrunkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "status": "active",
    "promptTemplate": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "sipTrunk": {
      "friendlyName": "<string>"
    },
    "defaultVariables": {},
    "firstMessage": "<string>",
    "turnTimeoutSeconds": 123,
    "silenceEndCallTimeoutSeconds": 123,
    "maxConversationDurationSeconds": 123,
    "llmTemperature": 1,
    "timezone": "<string>",
    "language": "<string>",
    "preCallWebhookUrl": "<string>",
    "postCallWebhookUrl": "<string>",
    "endCallEnabled": true,
    "endCallRulesOverride": "<string>",
    "transferEnabled": true,
    "transferRoutes": [
      {
        "to_number": "<string>",
        "condition": "<string>"
      }
    ],
    "transferDescriptionOverride": "<string>",
    "voicemailEnabled": true,
    "voicemailAction": "hangup",
    "voicemailMessage": "<string>",
    "voiceId": "<string>",
    "voiceTemperature": 1,
    "voiceSpeed": 1,
    "runtimeConfig": {},
    "phoneNumbers": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "e164": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "customTools": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "webhookUrl": "<string>",
        "enabled": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "schema": {}
      }
    ]
  }
}

GET

agents

{id}

Get Agent

curl --request GET \
  --url https://api.revring.ai/v1/agents/{id} \
  --header 'x-api-key: <api-key>'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sipTrunkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "status": "active",
    "promptTemplate": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "sipTrunk": {
      "friendlyName": "<string>"
    },
    "defaultVariables": {},
    "firstMessage": "<string>",
    "turnTimeoutSeconds": 123,
    "silenceEndCallTimeoutSeconds": 123,
    "maxConversationDurationSeconds": 123,
    "llmTemperature": 1,
    "timezone": "<string>",
    "language": "<string>",
    "preCallWebhookUrl": "<string>",
    "postCallWebhookUrl": "<string>",
    "endCallEnabled": true,
    "endCallRulesOverride": "<string>",
    "transferEnabled": true,
    "transferRoutes": [
      {
        "to_number": "<string>",
        "condition": "<string>"
      }
    ],
    "transferDescriptionOverride": "<string>",
    "voicemailEnabled": true,
    "voicemailAction": "hangup",
    "voicemailMessage": "<string>",
    "voiceId": "<string>",
    "voiceTemperature": 1,
    "voiceSpeed": 1,
    "runtimeConfig": {},
    "phoneNumbers": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "e164": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "customTools": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "webhookUrl": "<string>",
        "enabled": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "schema": {}
      }
    ]
  }
}

Authorizations

x-api-key

string

header

required

API key for authentication. Generate API keys from the RevRing dashboard.

Path Parameters

string<uuid>

required

Agent ID

Response

Agent details

data

object

AI Voice Agent configuration

Show child attributes

data.id

string<uuid>

required

data.sipTrunkId

string<uuid>

required

data.name

string

required

Agent name

data.status

enum<string>

required

Available options:

active,

disabled

data.promptTemplate

string

required

System prompt template with {{variable}} placeholders

data.createdAt

string<date-time>

required

data.updatedAt

string<date-time>

required

data.sipTrunk

object

Show child attributes

data.sipTrunk.friendlyName

string | null

data.defaultVariables

object

Default template variables

data.firstMessage

string | null

Agent's opening message

data.turnTimeoutSeconds

integer

Seconds to wait for user response

data.silenceEndCallTimeoutSeconds

integer

Silence duration before ending call

data.maxConversationDurationSeconds

integer

Maximum call duration

data.llmTemperature

number

LLM temperature for response randomness (0 = deterministic, 2 = very creative)

Required range: 0 <= x <= 2

data.timezone

string

IANA timezone identifier (e.g., America/New_York, Europe/London)

data.language

string

Language code (e.g., en, es, fr, de)

data.preCallWebhookUrl

string<uri> | null

Webhook URL called before answering inbound calls

data.postCallWebhookUrl

string<uri> | null

Webhook URL called after call ends with transcript and recording

data.endCallEnabled

boolean

Allow agent to end the call

data.endCallRulesOverride

string | null

Custom instructions for when agent should end call

data.transferEnabled

boolean

Allow agent to transfer calls

data.transferRoutes

object[] | null

Available transfer destinations with conditions

Show child attributes

data.transferRoutes.to_number

string

Transfer destination number (E.164)

data.transferRoutes.condition

string

When to offer this transfer option

data.transferDescriptionOverride

string | null

Custom instructions for transfer feature

data.voicemailEnabled

boolean

Enable voicemail detection

data.voicemailAction

enum<string>

What to do when voicemail is detected

Available options:

hangup,

leave_message

data.voicemailMessage

string | null

Message to leave on voicemail (if action is leave_message)

data.voiceId

string

Voice ID (copy from dashboard Voice Library)

data.voiceTemperature

number

Voice randomness/creativity (0 = consistent, 2 = varied)

Required range: 0 <= x <= 2

data.voiceSpeed

number

Speech speed multiplier (0.5 = half speed, 1.5 = 1.5x speed)

Required range: 0.5 <= x <= 1.5

data.runtimeConfig

object

Advanced runtime configuration

data.phoneNumbers

object[]

Phone numbers assigned to this agent for inbound calls

Show child attributes

data.phoneNumbers.id

string<uuid>

required

data.phoneNumbers.e164

string

required

Phone number in E.164 format

data.phoneNumbers.createdAt

string<date-time>

required

data.phoneNumbers.updatedAt

string<date-time>

required

data.customTools

object[]

Custom function calling tools available to this agent

Show child attributes

data.customTools.id

string<uuid>

required

data.customTools.name

string

required

Tool name (used in function calls)

data.customTools.webhookUrl

string<uri>

required

Webhook URL to invoke

data.customTools.enabled

boolean

required

data.customTools.createdAt

string<date-time>

required

data.customTools.updatedAt

string<date-time>

required

data.customTools.schema

object

OpenAI function schema defining parameters

List Agents Create Agent

⌘I

API documentation

SIP Trunks

Agents

Agent Phone Numbers

Agent Custom Tools

Calls

Analytics

Webhooks

Authorizations

Path Parameters

Response