Get Agent

Get Agent By ID

curl --request GET \
  --url https://server.sellagent.ai/api/agent/get/{id} \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <x-api-key>'

{
  "_id": "686679f702bfb2054ec3d1f0",
  "name": "Appointement Setter Agent",
  "type": "Single Prompt",
  "firstMessage": "Hello, how can I help you today?",
  "modelType": "deepseek/deepseek-chat-v3-0324",
  "backgroundSound": {
    "volume": 30
  },
  "dynamicVariables": {
    "first_name": "John"
  },
  "webhookURL": "Url endpoint",
  "language": {
    "code": "en",
    "label": "English",
    "icon": "US"
  },
  "customFunctions": [
    "<unknown>"
  ],
  "voiceMailDetection": false,
  "silenceThreshold": 30,
  "maxCallDuration": 300,
  "pauseBeforeSpeaking": 0,
  "enableRecording": false,
  "enableTranscript": false,
  "providerId": "105922657181422688240",
  "currentWorkspace": "685846b162e555e53cd3aeaa",
  "creditsBalance": 0,
  "currentSubscription": {
    "status": "free",
    "stripeCustomerId": "cus_SarEyKO1v9KQfP"
  },
  "usageMetrics": {
    "callingMinutesUsed": 0,
    "contactsUploaded": 0,
    "emailsSent": 0,
    "lastResetDate": "2025-06-29T16:37:16.234Z",
    "currentPeriodUsage": {
      "callingMinutes": 0,
      "contacts": 0,
      "emails": 0
    }
  },
  "workspaceId": "685846b162e555e53cd3aeaa",
  "modelId": {
    "_id": "68243c0eba21403731844a8c",
    "provider": "OpenRouter",
    "label": "DeepSeek V3",
    "type": "text",
    "currency": "USD",
    "icon": "https://assets-seleagent.s3.us-east-2.amazonaws.com/deepseek.png",
    "modelName": "deepseek/deepseek-chat-v3-0324",
    "cost": 0.01,
    "latency": 400
  },
  "voiceId": {
    "_id": "6800a813e6052d216985b6eb",
    "voiceName": "Luna",
    "accent": "English (US)",
    "gender": "Female",
    "voiceId": "aura-2-luna-en",
    "demoUrl": "https://d2z4jjzwkquvhw.cloudfront.net/Luna.wav",
    "voiceImg": "https://img.freepik.com/...jpg",
    "voiceProvider": "Deepgram",
    "providerId": "68243c0eba21403731844a8a",
    "voiceKey": "aura-2-luna-en"
  },
  "knowledgeBase": [
    "<unknown>"
  ],
  "createdAt": "2025-07-03T12:39:19.318Z",
  "updatedAt": "2025-07-04T20:39:32.968Z",
  "script": "Agent Script"
}

GET

get

{id}

Get Agent By ID

curl --request GET \
  --url https://server.sellagent.ai/api/agent/get/{id} \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <x-api-key>'

{
  "_id": "686679f702bfb2054ec3d1f0",
  "name": "Appointement Setter Agent",
  "type": "Single Prompt",
  "firstMessage": "Hello, how can I help you today?",
  "modelType": "deepseek/deepseek-chat-v3-0324",
  "backgroundSound": {
    "volume": 30
  },
  "dynamicVariables": {
    "first_name": "John"
  },
  "webhookURL": "Url endpoint",
  "language": {
    "code": "en",
    "label": "English",
    "icon": "US"
  },
  "customFunctions": [
    "<unknown>"
  ],
  "voiceMailDetection": false,
  "silenceThreshold": 30,
  "maxCallDuration": 300,
  "pauseBeforeSpeaking": 0,
  "enableRecording": false,
  "enableTranscript": false,
  "providerId": "105922657181422688240",
  "currentWorkspace": "685846b162e555e53cd3aeaa",
  "creditsBalance": 0,
  "currentSubscription": {
    "status": "free",
    "stripeCustomerId": "cus_SarEyKO1v9KQfP"
  },
  "usageMetrics": {
    "callingMinutesUsed": 0,
    "contactsUploaded": 0,
    "emailsSent": 0,
    "lastResetDate": "2025-06-29T16:37:16.234Z",
    "currentPeriodUsage": {
      "callingMinutes": 0,
      "contacts": 0,
      "emails": 0
    }
  },
  "workspaceId": "685846b162e555e53cd3aeaa",
  "modelId": {
    "_id": "68243c0eba21403731844a8c",
    "provider": "OpenRouter",
    "label": "DeepSeek V3",
    "type": "text",
    "currency": "USD",
    "icon": "https://assets-seleagent.s3.us-east-2.amazonaws.com/deepseek.png",
    "modelName": "deepseek/deepseek-chat-v3-0324",
    "cost": 0.01,
    "latency": 400
  },
  "voiceId": {
    "_id": "6800a813e6052d216985b6eb",
    "voiceName": "Luna",
    "accent": "English (US)",
    "gender": "Female",
    "voiceId": "aura-2-luna-en",
    "demoUrl": "https://d2z4jjzwkquvhw.cloudfront.net/Luna.wav",
    "voiceImg": "https://img.freepik.com/...jpg",
    "voiceProvider": "Deepgram",
    "providerId": "68243c0eba21403731844a8a",
    "voiceKey": "aura-2-luna-en"
  },
  "knowledgeBase": [
    "<unknown>"
  ],
  "createdAt": "2025-07-03T12:39:19.318Z",
  "updatedAt": "2025-07-04T20:39:32.968Z",
  "script": "Agent Script"
}

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

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

Show child attributes

backgroundSound.volume

integer

Example:

30

dynamicVariables

object

Show child attributes

dynamicVariables.first_name

integer

Example:

"John"

webhookURL

string

Model used by the agent

Example:

"Url endpoint"

language

object

Show child attributes

language.code

string

Example:

"en"

language.label

string

Example:

"English"

language.icon

string

Example:

"US"

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

Show child attributes

currentSubscription.status

string

Example:

"free"

currentSubscription.stripeCustomerId

string

Example:

"cus_SarEyKO1v9KQfP"

usageMetrics

object

Show child attributes

usageMetrics.callingMinutesUsed

number

Example:

0

usageMetrics.contactsUploaded

number

Example:

0

usageMetrics.emailsSent

number

Example:

0

usageMetrics.lastResetDate

string<date-time>

Example:

"2025-06-29T16:37:16.234Z"

usageMetrics.currentPeriodUsage

object

Show child attributes

usageMetrics.currentPeriodUsage.callingMinutes

number

Example:

0

usageMetrics.currentPeriodUsage.contacts

number

Example:

0

usageMetrics.currentPeriodUsage.emails

number

Example:

0

workspaceId

string

Example:

"685846b162e555e53cd3aeaa"

modelId

object

Show child attributes

modelId._id

string

Example:

"68243c0eba21403731844a8c"

modelId.provider

string

Example:

"OpenRouter"

modelId.label

string

Example:

"DeepSeek V3"

modelId.type

string

Example:

"text"

modelId.currency

string

Example:

"USD"

modelId.icon

string

Example:

"https://assets-seleagent.s3.us-east-2.amazonaws.com/deepseek.png"

modelId.modelName

string

Example:

"deepseek/deepseek-chat-v3-0324"

modelId.cost

number

Example:

0.01

modelId.latency

integer

Example:

400

voiceId

object

Show child attributes

voiceId._id

string

Example:

"6800a813e6052d216985b6eb"

voiceId.voiceName

string

Example:

"Luna"

voiceId.accent

string

Example:

"English (US)"

voiceId.gender

string

Example:

"Female"

voiceId.voiceId

string

Example:

"aura-2-luna-en"

voiceId.demoUrl

string

Example:

"https://d2z4jjzwkquvhw.cloudfront.net/Luna.wav"

voiceId.voiceImg

string

Example:

"https://img.freepik.com/...jpg"

voiceId.voiceProvider

string

Example:

"Deepgram"

voiceId.providerId

string

Example:

"68243c0eba21403731844a8a"

voiceId.voiceKey

string

Example:

"aura-2-luna-en"

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"

Create Agent Delete Agent

⌘I

API Documentation

Call

Agent

Phone

Headers

Path Parameters

Response