๐Ÿ† Omniagent API Hackathon ยท May 18 โ€“ June 15 โ€” Register now and start building

/public/agents

GET
/public/agents

Authorization

ApiKeyAuth
X-Api-Key<token>

API key for authentication. Passed as a header on every request.

In: header

Query Parameters

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",
    "language": "string",
    "voiceId": "string",
    "functions": [
      "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,
    "created": 0
  }
]