Update Agent

PATCH

api

agents

{agentId}

curl --request PATCH \
  --url https://api.play.ai/api/v1/agents/{agentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-USER-ID: <api-key>' \
  --header 'content-type: <content-type>' \
  --data '{
  "voice": "s3://voice-cloning-zero-shot/d9ff78ba-d016-47f6-b0ef-dd630f59414e/female-cs/manifest.json",
  "voiceSpeed": 1.2,
  "ttsModel": "PlayHT2.0-turbo",
  "displayName": "My Agent",
  "description": "My agent is the best agent",
  "greeting": "Hello! How can I help you today?",
  "prompt": "You are an agent for a company that sells widgets. A customer calls in and asks about the different types of widgets you sell. You should respond by telling the customer about the different types of widgets you sell and how they differ from each other.\n",
  "criticalKnowledge": "We have been in business for 20 years and have sold over 1 million widgets. Currently, we have 3 types of widgets: the standard widget, the deluxe widget, and the super widget. The standard widget is our most popular widget and is the most affordable. The deluxe widget is our mid-range widget and is popular with customers who want a little more than the standard widget. The super widget is our top of the line widget and is popular with customers who want the best of the best.",
  "visibility": "public",
  "answerOnlyFromCriticalKnowledge": false,
  "llm": null,
  "actions": [
    "f0gZrOKBKL7veJ6o1M"
  ]
}'

{
  "id": "f0gZrOKBKL7veJ6o1M",
  "voice": "s3://voice-cloning-zero-shot/d9ff78ba-d016-47f6-b0ef-dd630f59414e/female-cs/manifest.json",
  "voiceSpeed": 1.2,
  "ttsModel": "PlayHT2.0-turbo",
  "displayName": "My Agent",
  "description": "My agent is the best agent",
  "greeting": "Hello! How can I help you today?",
  "prompt": "You are an agent for a company that sells widgets. A customer calls in and asks about the different types of widgets you sell. You should respond by telling the customer about the different types of widgets you sell and how they differ from each other.\n",
  "criticalKnowledge": "We have been in business for 20 years and have sold over 1 million widgets. Currently, we have 3 types of widgets: the standard widget, the deluxe widget, and the super widget. The standard widget is our most popular widget and is the most affordable. The deluxe widget is our mid-range widget and is popular with customers who want a little more than the standard widget. The super widget is our top of the line widget and is popular with customers who want the best of the best.",
  "visibility": "public",
  "llm": null,
  "answerOnlyFromCriticalKnowledge": false,
  "avatarPhotoUrl": "https://api.play.ai/api/v1/agents/as43fed1477465823255f9/avatar-photo",
  "criticalKnowledgeFiles": [
    {
      "id": "e0e92064e26257fed14774658218f59a",
      "name": "whatever you want.pdf",
      "url": "https://api.play.ai/api/v1/agents/as43fed1477465823255f9/critical-knowledge-files/e0e92064e26257fed14774658218f59a",
      "size": 108439,
      "type": "pdf"
    }
  ],
  "phoneNumbers": [
    {
      "phoneNumber": 13659874563,
      "country": "US",
      "locality": "Malibu"
    }
  ],
  "actions": [
    "f0gZrOKBKL7veJ6o1M"
  ]
}

Updates the properties of the agent with the specified ID.

Authorizations

Authorization

string

header

required

Your secret API key from PlayAI, formatted as Bearer YOUR_SECRET_API_KEY.

X-USER-ID

string

header

required

Your unique user ID from PlayAI.

Headers

content-type

enum<string>

required

Available options:

application/json

enum<string>

Available options:

application/json

Path Parameters

agentId

string

required

The agent's ID.

Example:

"f0gZrOKBKL7veJ6o1M"

Body

application/json

voice

any

voiceSpeed

any

ttsModel

any

displayName

any

description

any

greeting

any

prompt

any

criticalKnowledge

any

visibility

any

answerOnlyFromCriticalKnowledge

any

llm

any

actions

any

Response

200 - application/json

Agent resource response.

string

required

The unique ID for each agent.

Example:

"f0gZrOKBKL7veJ6o1M"

voice

string

required

The unique ID for a PlayAI Voice.

Example:

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

displayName

string

required

The agent's name

Maximum length: 250

Example:

"My Agent"

description

string

required

The agent's description

Maximum length: 500

Example:

"My agent is the best agent"

visibility

enum<string>

default:public

required

The visibility of the agent

Available options:

public,

private

answerOnlyFromCriticalKnowledge

boolean

default:false

required

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.

Example:

1.2

ttsModel

string | null

The voice model to use for the agent's speech. Possible values are: PlayHT2.0-turbo, Play3.0-mini, and PlayDialog.

Example:

"PlayHT2.0-turbo"

greeting

string | null

The greeting message for the agent

Maximum length: 250

Example:

"Hello! How can I help you today?"

prompt

string | null

The greeting message for the agent

Maximum length: 10000

Example:

"You are an agent for a company that sells widgets. A customer calls in and asks about the different types of widgets you sell. You should respond by telling the customer about the different types of widgets you sell and how they differ from each other.\n"

criticalKnowledge

string | null

The agent's critical knowledge

Maximum length: 20000

Example:

"We have been in business for 20 years and have sold over 1 million widgets. Currently, we have 3 types of widgets: the standard widget, the deluxe widget, and the super widget. The standard widget is our most popular widget and is the most affordable. The deluxe widget is our mid-range widget and is popular with customers who want a little more than the standard widget. The super widget is our top of the line widget and is popular with customers who want the best of the best."

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.

llm.baseURL

string

required

The base URL of the LLM API. Must be an OpenAI-Compatible API. See Bring Your Own LLM for more info.

Example:

"https://my.own.llm.api.example.com"

llm.apiKey

string

required

The API Key to be used when our servers call your LLM API.

Example:

"abcdefghijklmnopqrstuvwxyz"

llm.baseParams

object | null

llm.baseParams.defaultHeaders

object | null

Default headers to send with every request to your LLM API.

Example:

{
  "x-my-extra-key": "some-value-for-extra-key"
}

llm.baseParams.model

string

default:gpt-3.5-turbo

Model name to use.

Example:

"gpt-3.5-turbo"

llm.baseParams.temperature

integer | null

What sampling temperature to use. Should be a double number between 0 (inclusive) and 1 (inclusive).

Required range: 0 < x < 1

llm.baseParams.maxTokens

integer | null

The maximum number of tokens the response should contain.

Example:

3000

avatarPhotoUrl

string | null

The URL of the agent's avatar photo

Example:

"https://api.play.ai/api/v1/agents/as43fed1477465823255f9/avatar-photo"

actions

string[]

The unique ID for each action.

Was this page helpful?

curl --request PATCH \
  --url https://api.play.ai/api/v1/agents/{agentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-USER-ID: <api-key>' \
  --header 'content-type: <content-type>' \
  --data '{
  "voice": "s3://voice-cloning-zero-shot/d9ff78ba-d016-47f6-b0ef-dd630f59414e/female-cs/manifest.json",
  "voiceSpeed": 1.2,
  "ttsModel": "PlayHT2.0-turbo",
  "displayName": "My Agent",
  "description": "My agent is the best agent",
  "greeting": "Hello! How can I help you today?",
  "prompt": "You are an agent for a company that sells widgets. A customer calls in and asks about the different types of widgets you sell. You should respond by telling the customer about the different types of widgets you sell and how they differ from each other.\n",
  "criticalKnowledge": "We have been in business for 20 years and have sold over 1 million widgets. Currently, we have 3 types of widgets: the standard widget, the deluxe widget, and the super widget. The standard widget is our most popular widget and is the most affordable. The deluxe widget is our mid-range widget and is popular with customers who want a little more than the standard widget. The super widget is our top of the line widget and is popular with customers who want the best of the best.",
  "visibility": "public",
  "answerOnlyFromCriticalKnowledge": false,
  "llm": null,
  "actions": [
    "f0gZrOKBKL7veJ6o1M"
  ]
}'

{
  "id": "f0gZrOKBKL7veJ6o1M",
  "voice": "s3://voice-cloning-zero-shot/d9ff78ba-d016-47f6-b0ef-dd630f59414e/female-cs/manifest.json",
  "voiceSpeed": 1.2,
  "ttsModel": "PlayHT2.0-turbo",
  "displayName": "My Agent",
  "description": "My agent is the best agent",
  "greeting": "Hello! How can I help you today?",
  "prompt": "You are an agent for a company that sells widgets. A customer calls in and asks about the different types of widgets you sell. You should respond by telling the customer about the different types of widgets you sell and how they differ from each other.\n",
  "criticalKnowledge": "We have been in business for 20 years and have sold over 1 million widgets. Currently, we have 3 types of widgets: the standard widget, the deluxe widget, and the super widget. The standard widget is our most popular widget and is the most affordable. The deluxe widget is our mid-range widget and is popular with customers who want a little more than the standard widget. The super widget is our top of the line widget and is popular with customers who want the best of the best.",
  "visibility": "public",
  "llm": null,
  "answerOnlyFromCriticalKnowledge": false,
  "avatarPhotoUrl": "https://api.play.ai/api/v1/agents/as43fed1477465823255f9/avatar-photo",
  "criticalKnowledgeFiles": [
    {
      "id": "e0e92064e26257fed14774658218f59a",
      "name": "whatever you want.pdf",
      "url": "https://api.play.ai/api/v1/agents/as43fed1477465823255f9/critical-knowledge-files/e0e92064e26257fed14774658218f59a",
      "size": 108439,
      "type": "pdf"
    }
  ],
  "phoneNumbers": [
    {
      "phoneNumber": 13659874563,
      "country": "US",
      "locality": "Malibu"
    }
  ],
  "actions": [
    "f0gZrOKBKL7veJ6o1M"
  ]
}

Text-to-Speech

Agents

Agent Conversations

Agent Actions

Agent Statistics

PlayNote

Authorizations

Headers

Path Parameters

Body

Response