Skip to main content
POST
/
agents
Create agent
curl --request POST \
  --url https://api.goyappr.com/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Sales Agent",
  "system_prompt": "You are a friendly sales representative...",
  "description": "<string>",
  "voice": "Kore",
  "language": "he",
  "temperature": 0.5,
  "greeting_message": "שלום! איך אוכל לעזור?",
  "agent_speaks_first": true,
  "idempotency_key": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "system_prompt": "<string>",
  "description": "<string>",
  "voice": "Zephyr",
  "language": "he",
  "temperature": 1,
  "greeting_message": "<string>",
  "agent_speaks_first": true,
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Body

application/json
name
string
required
Example:

"Sales Agent"

system_prompt
string
required
Example:

"You are a friendly sales representative..."

description
string
voice
enum<string>
default:Kore
Available options:
Zephyr,
Puck,
Charon,
Kore,
Fenrir,
Aoede,
Leda,
Orus,
Perseus,
Schedar
language
enum<string>
default:he
Available options:
he,
en
temperature
number
default:0.5
Required range: 0 <= x <= 2
greeting_message
string
Example:

"שלום! איך אוכל לעזור?"

agent_speaks_first
boolean
default:true
idempotency_key
string

Response

201 - application/json

Agent created

id
string<uuid>
name
string
system_prompt
string
description
string | null
voice
enum<string>
Available options:
Zephyr,
Puck,
Charon,
Kore,
Fenrir,
Aoede,
Leda,
Orus,
Perseus,
Schedar
language
enum<string>
Available options:
he,
en
temperature
number
Required range: 0 <= x <= 2
greeting_message
string | null
agent_speaks_first
boolean
is_active
boolean
created_at
string<date-time>