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

/public/agents/{agentId}/channels/{channelType}

GET
/public/agents/{agentId}/channels/{channelType}

Authorization

ApiKeyAuth
X-Api-Key<token>

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

In: header

Path Parameters

agentId*string
channelType*string
Value in"voip" | "sip" | "webrtc" | "websocket"

Header Parameters

X-API-Version?string

Response Body

curl -X GET "https://companion-api.napster.com/public/agents/string/channels/voip"
{
  "id": "string",
  "apiKeyId": "string",
  "channelType": "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"
    }
  },
  "humanHandoff": {
    "enabled": true,
    "transferExtension": "string",
    "transferDescription": "string"
  },
  "voipEndpoint": "string",
  "useGreenVideo": true,
  "created": 0
}
{
  "code": "string",
  "description": "string",
  "type": "failure",
  "numericType": 0
}