API ReferenceAgents

/public/agents/{agentId}/connections

Start a real-time connection to an agent

POST
/public/agents/{agentId}/connections

Start a real-time connection to an agent

Path Parameters

agentId*string

Header Parameters

X-API-Version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://companion-api.napster.com/public/agents/string/connections" \  -H "Content-Type: application/json" \  -d '{    "channelType": "webrtc"  }'
{
  "token": "string",
  "connection": {
    "id": "string"
  }
}
{
  "code": "string",
  "description": "string",
  "type": "failure",
  "numericType": 0
}

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

Creates or updates a channel configuration for the specified agent. The channel configuration is automatically linked to the API key used to authenticate this request.

/public/agents/{agentId} DELETE

Delete an agent