GET
/
api
/
v1
/
agents
/
{agentId}

Retrieve all information about an agent.

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

​
accept
enum<string>
Available options:
application/json

Path Parameters

​
agentId
string
required

The agent's ID.

Response

200 - application/json
​
id
string
required

The unique ID for each agent.

​
voice
string
required

The unique ID for a PlayAI Voice.

​
displayName
string
required

The agent's name

Maximum length: 250
​
description
string
required

The agent's description

Maximum length: 500
​
visibility
enum<string>
default: publicrequired

The visibility of the agent

Available options:
public,
private
​
answerOnlyFromCriticalKnowledge
boolean
default: falserequired

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

​
criticalKnowledgeFiles
object[]
required
​
phoneNumbers
object[]
required
​
voiceSpeed
number | null

The voice speed, i.e. how fast is the agent's speech. Possible values are: 0.5, 0.6, 0.7, 0.8, 0.9, 1.0, 1.1, 1.2, 1.3, 1.4, 1.5.

​
greeting
string | null

The greeting message for the agent

Maximum length: 250
​
prompt
string | null

The greeting message for the agent

Maximum length: 10000
​
criticalKnowledge
string | null

The agent's critical knowledge

Maximum length: 20000
​
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.

​
avatarPhotoUrl
string | null

The URL of the agent's avatar photo

​
actions
string[]
Create AgentUpdate Agent