Skip to main content
GET
/
agent
/
{agent_id}
Get Agent
curl --request GET \
  --url https://api.getoutbox.ai/agent/{agent_id}/ \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "type": "chatbot",
  "prompt": "<string>",
  "model": {
    "model": "<string>",
    "max_tokens": 123,
    "temperature": 123
  },
  "first_message": "<string>",
  "tools": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "type": "<string>",
      "url": "<string>",
      "mcp_tool": "<string>",
      "method": "<string>",
      "auth_token": "<string>",
      "is_async": true,
      "is_success": true,
      "icon_url": "<string>",
      "messages": [
        {
          "type": "<string>",
          "content": "<string>"
        }
      ],
      "schema": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "type": "<string>",
          "required": true
        }
      ]
    }
  ],
  "files": [
    {
      "id": "<string>",
      "name": "<string>",
      "file": true,
      "type": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "platforms": [
    {
      "id": "<string>",
      "platform": "<string>",
      "min_delay": 123,
      "max_delay": 123,
      "trigger": "<string>",
      "active": true
    }
  ],
  "language": "<string>",
  "voice": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "provider": "<string>",
    "accent": "<string>",
    "gender": "<string>",
    "previewUrl": "<string>",
    "style": 123,
    "speed": 123,
    "stability": 123,
    "similarityBoost": 123,
    "useSpeakerBoost": true,
    "optimizeStreamingLatency": 123,
    "autoMode": true,
    "model": "<string>"
  },
  "background": "lounge",
  "background_url": "<string>",
  "variables": [
    {
      "variable": "<string>",
      "default": "<string>"
    }
  ],
  "number_list": [
    {
      "id": "<string>",
      "number": "<string>",
      "friendly_name": "<string>"
    }
  ],
  "advanced": {
    "timezone": "<string>",
    "interrupt_mode": true,
    "hipaa_enabled": true,
    "forwarding_number": "<string>",
    "voicemail_message": "<string>",
    "end_call_message": "<string>",
    "unqualified_prompt": "<string>",
    "scoring_prompt": "<string>",
    "summary_prompt": "<string>",
    "keyterms": "<string>",
    "webhook_url": "<string>",
    "log_to_crm": true,
    "recording_consent_message": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Company API Key

Path Parameters

agent_id
string
required

The ID of the agent to retrieve

Response

Agent details retrieved successfully

id
string

Unique identifier for the agent

name
string

Name of the agent

type
enum<string>

Type of agent

Available options:
chatbot,
voicebot
prompt
string

System prompt for the agent

model
object

AI model configuration

first_message
string

Initial message sent by the agent

tools
object[]
files
object[]
platforms
object[]

Platform integrations (chatbot only)

language
string

Language for the agent (voicebot only)

voice
object

Voice settings (voicebot only)

background
enum<string>

Background audio (voicebot only)

Available options:
lounge,
off,
url
background_url
string<uri>

Custom background audio URL used when background is set to url (voicebot only)

variables
object[]

Custom variables (voicebot only)

number_list
object[]

Associated phone numbers (voicebot only)

advanced
object