Create Agent
Creates a new Play.ai Agent.
Use this endpoint to create new agents. Required parameters include the agent’s name and the agent’s prompt.
After you create your agent, you can proceed to start a conversation using our Websocket API, or you can try it
out through our web interface at https://play.ai/agent/<your-agent-id>.
To update the agents see the Update Agent endpoint.
Authorizations
API key required for this endpoint. Use Bearer YOUR_SECRET_API_KEY. Get your key from https://play.ai/developers.
User ID required for this endpoint. Get it from https://play.ai/developers.
Headers
application/json application/json Body
Response
The unique ID for each agent.
The unique ID for a PlayAI Voice.
The agent's name
250The agent's description
500The visibility of the agent
public, private If true, the agent will only respond with information from the critical knowledge field.
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.
The greeting message for the agent
250The greeting message for the agent
10000The agent's critical knowledge
20000Leave 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.
The URL of the agent's avatar photo