Skip to main content
PATCH
Update Agent

Authorizations

x-api-key
string
header
required

Your Beyond Presence API Key.

Path Parameters

id
string
required

Agent ID.

Body

application/json

Request body to update an agent. Omitted fields are unchanged.

name
string

Display name to use. Also used when addressed in conversations.

Required string length: 1 - 100
Examples:

"Jarvis"

"HAL 9000"

avatar_id
string

ID of avatar to use.

Required string length: 1 - 100
Example:

"01234567-89ab-cdef-0123-456789abcdef"

system_prompt
string

System prompt to use.

Required string length: 1 - 10000
Example:

"You are a helpful assistant."

language
enum<string> | null

Language to use.

Available options:
ar,
ar-SA,
bn,
bg,
zh,
cs,
da,
nl,
en,
en-AU,
en-GB,
en-US,
fi,
fr,
fr-CA,
fr-FR,
de,
el,
hi,
hu,
id,
it,
ja,
kk,
ko,
ms,
no,
pl,
pt,
pt-BR,
pt-PT,
ro,
ru,
sk,
es,
sv,
tr,
uk,
ur,
vi
Example:

"en"

greeting
string | null

What to say when a call starts.

Required string length: 1 - 1000
Example:

"Hello!"

max_session_length_minutes
integer | null

Maximum session length in minutes.

Required range: 0 < x <= 90
Example:

30

capabilities
(WebcamVisionAgentCapability · object | WakeupModeAgentCapability · object)[]

Extra capabilities to manage calls.

Agent capability to see user camera feed.

Example:
llm
LivekitAgentLlm · object

Configuration for LLM to use.

Example:
tts
LivekitAgentTts · object

Configuration for TTS to use.

Example:
knowledge_file_ids
string[]

IDs of knowledge files to refer to.

Minimum string length: 1

Response

Successful Update