Manage Your Agent

After creating an agent, you can list all your agents, update their configuration, or delete them.

List agents

Retrieve all agents in your project:

curl https://companion-api.napster.com/public/agents \
  -H "X-Api-Key: $NAPSTER_API_KEY"

Get a single agent

curl https://companion-api.napster.com/public/agents/agent_abc123 \
  -H "X-Api-Key: $NAPSTER_API_KEY"

Update an agent

Use PATCH to update any field on the agent. Only the fields you include in the request body are changed — everything else stays the same.

curl -X PATCH https://companion-api.napster.com/public/agents/agent_abc123 \
  -H "X-Api-Key: $NAPSTER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "language": "Spanish",
    "voiceId": "shimmer"
  }'

You can update any of the fields from the creation request: companionId, name, voiceId, language, functions, faqCollections, knowledgeBaseId, and providerSettings. Changes apply to all channels that use this agent.

Delete an agent

curl -X DELETE https://companion-api.napster.com/public/agents/agent_abc123 \
  -H "X-Api-Key: $NAPSTER_API_KEY"

Deleting an agent removes it for all channels — WebRTC, WebSocket, and SIP. To remove only a specific channel configuration while keeping the agent, delete the channel config instead (e.g. DELETE /public/agents/{agentId}/channels/sip).

Managing channel configs

Each channel can have its own configuration that overrides the agent's defaults. You can retrieve or remove a channel config without affecting the agent itself:

# Get a channel config (e.g. SIP)
curl https://companion-api.napster.com/public/agents/agent_abc123/channels/sip \
  -H "X-Api-Key: $NAPSTER_API_KEY"

# Delete a channel config (keeps the agent, removes channel overrides)
curl -X DELETE https://companion-api.napster.com/public/agents/agent_abc123/channels/sip \
  -H "X-Api-Key: $NAPSTER_API_KEY"

For details on setting up channel configs, see the channel-specific guides: WebRTC, WebSockets, SIP.