Skip to main content
PATCH
/
v1
/
agents
/
{agent_id}
Update agent (partial)
curl --request PATCH \
  --url https://api.agents.slng.ai/v1/agents/{agent_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "system_prompt": "<string>",
  "greeting": "<string>",
  "inbound_greeting": "<string>",
  "outbound_greeting": "<string>",
  "language": "<string>",
  "region": "us-east",
  "idle_nudges": {
    "first_nudge_text": "<string>",
    "second_nudge_text": "<string>",
    "final_hangup_text": "<string>",
    "enabled": true,
    "first_nudge_delay_seconds": 15,
    "second_nudge_delay_seconds": 30,
    "hangup_delay_seconds": 15
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "template": "hangup",
      "prompt": "<string>",
      "execution_policy": {
        "pre_action_message": {
          "enabled": false,
          "text": "<string>"
        }
      }
    }
  ],
  "slng_api_key": "<string>",
  "sip_inbound_trunk_id": "550e8400-e29b-41d4-a716-446655440000",
  "sip_outbound_trunk_id": "550e8400-e29b-41d4-a716-446655440000",
  "template_defaults": {},
  "runtime_variables": [
    {
      "name": "<string>",
      "description": "<string>"
    }
  ]
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "organisation_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "<string>",
  "system_prompt": "<string>",
  "greeting": "<string>",
  "language": "<string>",
  "region": "<string>",
  "models": {
    "stt": "slng/deepgram/nova:3-en",
    "llm": "groq/moonshotai/kimi-k2-instruct-0905",
    "tts": "slng/deepgram/aura:2-en",
    "tts_voice": "aura-2-thalia-en",
    "stt_kwargs": {},
    "llm_kwargs": {},
    "tts_kwargs": {},
    "fallbacks": {
      "stt": [],
      "llm": [],
      "tts": []
    },
    "stt_final_timeout_s": 1,
    "llm_first_token_timeout_s": 1,
    "tts_first_audio_timeout_s": 1,
    "failure_audio_enabled": true
  },
  "idle_nudges": {
    "first_nudge_text": "<string>",
    "second_nudge_text": "<string>",
    "final_hangup_text": "<string>",
    "enabled": true,
    "first_nudge_delay_seconds": 15,
    "second_nudge_delay_seconds": 30,
    "hangup_delay_seconds": 15
  },
  "enable_interruptions": true,
  "tools": [
    {
      "type": "template",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "template": "hangup",
      "prompt": "<string>",
      "execution_policy": {
        "pre_action_message": {
          "enabled": false,
          "text": "<string>"
        }
      }
    }
  ],
  "template_variables": {},
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-15T10:30:00Z",
  "inbound_greeting": "<string>",
  "outbound_greeting": "<string>",
  "sip_inbound_trunk_id": "550e8400-e29b-41d4-a716-446655440000",
  "sip_outbound_trunk_id": "550e8400-e29b-41d4-a716-446655440000",
  "runtime_variables": [
    {
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "deleted_at": "2026-01-15T10:30:00Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
agent_id
string<uuid>
required

Voice agent ID.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json
​
name
string | null
Maximum string length: 255
​
system_prompt
string | null
​
greeting
string | null
​
inbound_greeting
string | null
​
outbound_greeting
string | null
​
language
string | null
Maximum string length: 10
​
region
enum<string> | null

Change the region where the agent runs.

Available options:
us-east,
eu-central,
ap-south
​
models
object

Model configuration for the agent runtime (STT + LLM + TTS).

​
idle_nudges
object

Optional silence recovery behavior. The runtime can send two follow-up nudges, then speak a final message and hang up.

​
enable_interruptions
boolean | null
​
tools
(Template tool · object | Utility tool · object | Webhook · object | Human transfer · object)[] | null

Built-in call control tools (hangup, voicemail detection).

​
slng_api_key
string | null

Update the SLNG API key.

​
sip_inbound_trunk_id
string<uuid> | null
Example:

"550e8400-e29b-41d4-a716-446655440000"

​
sip_outbound_trunk_id
string<uuid> | null
Example:

"550e8400-e29b-41d4-a716-446655440000"

​
template_defaults
object
​
runtime_variables
object[] | null

Response

Updated agent.

​
id
string<uuid>
required
Example:

"550e8400-e29b-41d4-a716-446655440000"

​
organisation_id
string<uuid>
required
Example:

"550e8400-e29b-41d4-a716-446655440000"

​
name
string
required
​
system_prompt
string
required
​
greeting
string
required
​
language
string
required
​
region
string
required
​
models
object
required

Model configuration for the agent runtime (STT + LLM + TTS).

​
idle_nudges
object
required

Optional silence recovery behavior. The runtime can send two follow-up nudges, then speak a final message and hang up.

​
enable_interruptions
boolean
required
​
tools
(Template tool · object | Utility tool · object | Webhook · object | Human transfer · object)[]
required
​
template_variables
object
required
​
created_at
string<date-time>
required
Example:

"2026-01-15T10:30:00Z"

​
updated_at
string<date-time>
required
Example:

"2026-01-15T10:30:00Z"

​
inbound_greeting
string | null
​
outbound_greeting
string | null
​
sip_inbound_trunk_id
string<uuid> | null
Example:

"550e8400-e29b-41d4-a716-446655440000"

​
sip_outbound_trunk_id
string<uuid> | null
Example:

"550e8400-e29b-41d4-a716-446655440000"

​
runtime_variables
object[]
​
deleted_at
string<date-time> | null
Example:

"2026-01-15T10:30:00Z"