Skip to main content
GET
/
agents
List agents
curl --request GET \
  --url https://api.goyappr.com/agents \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
    }
  ],
  "count": 123
}

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer
default:20
offset
integer
default:0

Response

200 - application/json

List of agents

data
object[]
count
integer