/public/agents

List agents

GET
/public/agents

List agents

Query Parameters

channel?string
Value in"voip" | "sip" | "webrtc" | "websocket" | "kiosk"
search?string
tags?

Header Parameters

X-API-Version?string

Response Body

curl -X GET "https://companion-api.napster.com/public/agents"
[
  {
    "id": "string",
    "companionId": "string",
    "name": "string",
    "previewUrl": "string",
    "language": "string",
    "voiceId": "string",
    "functions": [
      "string"
    ],
    "mcp": {
      "servers": [
        "string"
      ],
      "connectors": [
        "string"
      ]
    },
    "faqCollections": [
      "string"
    ],
    "knowledgeBaseId": "string",
    "providerSettings": {
      "instructions": "string",
      "turnDetection": {
        "threshold": 0.1,
        "prefix_padding_ms": 0,
        "silence_duration_ms": 0
      },
      "temperature": 0.1,
      "noiseReduction": {
        "type": "nearField"
      }
    },
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "disableIdleTimeout": true,
    "useWebSearch": true,
    "channels": [
      {
        "type": "voip",
        "id": "string"
      }
    ],
    "created": 0
  }
]