PATCH
/
api
/
v1
/
agents
/
{agentId}

Updates the properties of the agent with the specified ID.

Authorizations

AUTHORIZATION
string
headerrequired

API key required for this endpoint. Use Bearer YOUR_SECRET_API_KEY. Get your key from https://play.ai/developers.

X-USER-ID
string
headerrequired

User ID required for this endpoint. Get it from https://play.ai/developers.

Headers

content-type
enum<string>
required
Available options:
application/json
accept
enum<string>
Available options:
application/json

Path Parameters

agentId
string
required

The agent's ID.

Body

application/json
voice
string
default: s3://voice-cloning-zero-shot/d9ff78ba-d016-47f6-b0ef-dd630f59414e/female-cs/manifest.json

The unique ID for a Cloned Voice.

displayName
string

The agent's name

description
string

The agent's description

greeting
string | null

The greeting message for the agent

prompt
string | null

The greeting message for the agent

criticalKnowledge
string | null

The agent's critical knowledge

visibility
enum<string>
default: public

The visibility of the agent

Available options:
public,
private
answerOnlyFromCriticalKnowledge
boolean
default: false

If true, the agent will only respond with information from the critical knowledge field.

llm
object | null

Leave this field out or null if you don't want the agent to use your custom LLM API. See Bring Your Own LLM for more info.

Response

200 - application/json
id
string
required

The agent's ID.

voice
string
default: s3://voice-cloning-zero-shot/d9ff78ba-d016-47f6-b0ef-dd630f59414e/female-cs/manifest.jsonrequired

The unique ID for a Cloned Voice.

displayName
string
required

The agent's name

description
string
required

The agent's description

greeting
string | null

The greeting message for the agent

prompt
string | null

The greeting message for the agent

criticalKnowledge
string | null

The agent's critical knowledge

visibility
enum<string>
default: publicrequired

The visibility of the agent

Available options:
public,
private
llm
object | null

Leave this field out or null if you don't want the agent to use your custom LLM API. See Bring Your Own LLM for more info.

answerOnlyFromCriticalKnowledge
boolean
default: falserequired

If true, the agent will only respond with information from the critical knowledge field.

avatarPhotoUrl
string | null

The URL of the agent's avatar photo

criticalKnowledgeFiles
object[]
required
phoneNumbers
object[]
required