Skip to main content
GET
Get Agent By ID

Headers

x-api-key
string
required

Your API key for authentication

Content-Type
enum<string>
required

Must be application/json

Available options:
application/json
x-workspace-id
string

Optional Workspace ID (defaults to user's current workspace)

Path Parameters

id
string
required

Unique id of the agent to be retrieved.

Example:

"686679f702bfb2054ec3d1f0"

Response

Successfully retrieved an agent.

_id
string
required

Unique ID of the agent

Example:

"686679f702bfb2054ec3d1f0"

name
string
required

Name of the agent

Example:

"Appointement Setter Agent"

type
string
required

Agent type (e.g., Single Prompt, Multi-Step)

Example:

"Single Prompt"

firstMessage
string

Initial message spoken by the agent

Example:

"Hello, how can I help you today?"

modelType
string

Model used by the agent

Example:

"deepseek/deepseek-chat-v3-0324"

backgroundSound
object
dynamicVariables
object
webhookURL
string

Model used by the agent

Example:

"Url endpoint"

language
object
customFunctions
any[]

Custom functions used in the agent

voiceMailDetection
boolean
Example:

false

silenceThreshold
integer
Example:

30

maxCallDuration
integer
Example:

300

pauseBeforeSpeaking
integer
Example:

0

enableRecording
boolean
Example:

false

enableTranscript
boolean
Example:

false

providerId
string
Example:

"105922657181422688240"

currentWorkspace
string
Example:

"685846b162e555e53cd3aeaa"

creditsBalance
number
Example:

0

currentSubscription
object
usageMetrics
object
workspaceId
string
Example:

"685846b162e555e53cd3aeaa"

modelId
object
voiceId
object
knowledgeBase
any[]

Knowledge base entries attached to the agent

createdAt
string<date-time>
Example:

"2025-07-03T12:39:19.318Z"

updatedAt
string<date-time>
Example:

"2025-07-04T20:39:32.968Z"

script
string
Example:

"Agent Script"