# Omniagent API

- [Overview](/docs): Start building with the Omniagent API
- [What's New](/docs/whats-new): Latest updates to the Omniagent API
- Introduction
  - [Quickstart](/docs/introduction/quickstart): Get started with the Omniagent API in minutes
  - [Authentication](/docs/introduction/authentication): Learn how to authenticate requests to the Omniagent API
- Build Your Omniagent
  - [Get Started](/docs/building-your-omniagent/overview): Build and assemble your first Omniagent step by step
  - [Agent Configuration](/docs/building-your-omniagent/configuration): All the settings available when creating or updating your Omniagent
  - [Manage Your Agent](/docs/building-your-omniagent/managing): List, update, and delete your Omniagents
  - [Companion](/docs/building-your-omniagent/companion): Define the visual identity and personality of your agent
  - Tools
    - [Using Tools](/docs/building-your-omniagent/tools/using-tools): How tools work in the Omniagent API and how to attach them to an agent
    - [Creating Tools](/docs/building-your-omniagent/tools/custom-tools): Create and manage tools for your agents
  - Knowledge
    - [Files](/docs/building-your-omniagent/knowledge/files): Upload documents into knowledge collections so your agent can ground its responses in your content
    - [FAQs](/docs/building-your-omniagent/knowledge/faqs): Add curated Q&A pairs so your agent gives consistent answers to important questions
- Deploy Your Omniagent
  - [Get Started](/docs/deploying-your-omniagent/overview): Deploy your Omniagent to any channel — web, WebSocket, or phone
  - [Session Configuration](/docs/deploying-your-omniagent/session-configuration): Per-session settings for memory, user context, tags, and channel overrides
  - Channels
    - [WebRTC](/docs/deploying-your-omniagent/channels/webrtc): Connect to an agent in the browser using the Web SDK
    - [WebSockets](/docs/deploying-your-omniagent/channels/websockets): Connect to an agent over WebSockets for audio-only sessions
    - [SIP](/docs/deploying-your-omniagent/channels/sip): Let your agent answer incoming phone calls over SIP
  - Messaging
    - [Overview](/docs/deploying-your-omniagent/messaging/overview): Communicate with your agent during a session through events and commands
    - [Server Events](/docs/deploying-your-omniagent/messaging/server-events): Server-to-client events published during WebRTC and WebSocket sessions
    - [Client Commands](/docs/deploying-your-omniagent/messaging/client-commands): Send messages and update session settings from your client during a session
- Monitor Your Omniagent
  - [Sessions](/docs/monitoring-your-omniagent/sessions): List sessions, filter by companion or client, and retrieve conversation transcripts
- [FAQs](/docs/faq): Frequently asked questions about the Omniagent API
- Guides
  - [Create a Resource in Azure Portal](/docs/guides/azure-resource): Set up the Napster Companion API resource in your Azure subscription
- Migrations
  - [From Per-Session Connections to Omniagent](/docs/migrations/connections-to-agents): Migrate from per-session POST /public/connections to the Omniagent model
  - [From SIP Agents to Omniagent](/docs/migrations/sip-agents-to-agents): Migrate from the SIP-specific agent model to the Omniagent architecture
- API Reference
  - [API Reference](/docs/api-reference): Complete endpoint reference for the Omniagent API
  - Agents
    - [/public/agents/{agentId}/channels/{channelType}](/docs/api-reference/agents/agentid-channels-channeltype-delete)
    - [/public/agents/{agentId}/channels/{channelType}](/docs/api-reference/agents/agentid-channels-channeltype-get)
    - [/public/agents/{agentId}/channels/{channelType}](/docs/api-reference/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}/connections](/docs/api-reference/agents/agentid-connections-post)
    - [/public/agents/{agentId}](/docs/api-reference/agents/agentid-delete)
    - [/public/agents/{agentId}](/docs/api-reference/agents/agentid-get)
    - [/public/agents/{agentId}](/docs/api-reference/agents/agentid-patch)
    - [/public/agents](/docs/api-reference/agents/get)
    - [/public/agents](/docs/api-reference/agents/post)
  - Companions
    - [/public/companions/{companionId}](/docs/api-reference/companions/companionid-delete)
    - [/public/companions/{companionId}](/docs/api-reference/companions/companionid-get)
    - [/public/companions/{companionId}](/docs/api-reference/companions/companionid-patch)
    - [/public/companions/ethnicities](/docs/api-reference/companions/ethnicities-get)
    - [/public/companions](/docs/api-reference/companions/get): Returns a list of companions that you have created in the current project. These are your custom companions, not Napster's pre-built stock companions.
    - [/public/napster-companions](/docs/api-reference/companions/napster-companions-get)
    - [/public/companions/napster-stock](/docs/api-reference/companions/napster-stock-get): Returns a list of Napster's pre-built stock companions. These are ready-made companions provided by Napster that you can use as starting points or deploy directly.
    - [/public/companions](/docs/api-reference/companions/post)
    - [/public/companions/semantic](/docs/api-reference/companions/semantic-get)
  - Connections
    - [/public/connections](/docs/api-reference/connections/post)
    - [/public/ws-connections](/docs/api-reference/connections/ws-connections-post)
  - FAQS
    - [/public/faqs/{faqCollectionId}](/docs/api-reference/faqs/faqcollectionid-delete)
    - [/public/faqs/{faqCollectionId}](/docs/api-reference/faqs/faqcollectionid-get)
    - [/public/faqs/{faqCollectionId}/items/{faqId}](/docs/api-reference/faqs/faqcollectionid-items-faqid-delete)
    - [/public/faqs/{faqCollectionId}/items/{faqId}](/docs/api-reference/faqs/faqcollectionid-items-faqid-get)
    - [/public/faqs/{faqCollectionId}/items/{faqId}](/docs/api-reference/faqs/faqcollectionid-items-faqid-patch)
    - [/public/faqs/{faqCollectionId}/items](/docs/api-reference/faqs/faqcollectionid-items-get)
    - [/public/faqs/{faqCollectionId}/items](/docs/api-reference/faqs/faqcollectionid-items-post)
    - [/public/faqs/{faqCollectionId}](/docs/api-reference/faqs/faqcollectionid-patch)
    - [/public/faqs](/docs/api-reference/faqs/get)
    - [/public/faqs](/docs/api-reference/faqs/post)
  - Functions
    - [/public/functions/{functionId}](/docs/api-reference/functions/functionid-delete)
    - [/public/functions/{functionId}](/docs/api-reference/functions/functionid-get)
    - [/public/functions/{functionId}](/docs/api-reference/functions/functionid-put)
    - [/public/functions](/docs/api-reference/functions/get)
    - [/public/functions](/docs/api-reference/functions/post)
  - Knowledge Bases
    - [/public/knowledge-bases](/docs/api-reference/knowledge-bases/get)
    - [/public/knowledge-bases/{knowledgeBaseId}](/docs/api-reference/knowledge-bases/knowledgebaseid-delete)
    - [/public/knowledge-bases/{knowledgeBaseId}/files/{fileId}](/docs/api-reference/knowledge-bases/knowledgebaseid-files-fileid-delete)
    - [/public/knowledge-bases/{knowledgeBaseId}/files/{fileId}/download-url](/docs/api-reference/knowledge-bases/knowledgebaseid-files-fileid-download-url-get)
    - [/public/knowledge-bases/{knowledgeBaseId}/files/{fileId}](/docs/api-reference/knowledge-bases/knowledgebaseid-files-fileid-get)
    - [/public/knowledge-bases/{knowledgeBaseId}/files/{fileId}/summary](/docs/api-reference/knowledge-bases/knowledgebaseid-files-fileid-summary-patch)
    - [/public/knowledge-bases/{knowledgeBaseId}/files](/docs/api-reference/knowledge-bases/knowledgebaseid-files-get)
    - [/public/knowledge-bases/{knowledgeBaseId}/files](/docs/api-reference/knowledge-bases/knowledgebaseid-files-post)
    - [/public/knowledge-bases/{knowledgeBaseId}](/docs/api-reference/knowledge-bases/knowledgebaseid-get)
    - [/public/knowledge-bases/{knowledgeBaseId}](/docs/api-reference/knowledge-bases/knowledgebaseid-patch)
    - [/public/knowledge-bases](/docs/api-reference/knowledge-bases/post)
  - Sessions
    - [/public/sessions](/docs/api-reference/sessions/get)
    - [/public/sessions/{sessionId}](/docs/api-reference/sessions/sessionid-get)
  - SIP
    - [/public/sip-connections](/docs/api-reference/sip/sip-connections-get)
    - [/public/sip-connections](/docs/api-reference/sip/sip-connections-post)
    - [/public/sip-connections/{sipConnectionConfigurationId}](/docs/api-reference/sip/sip-connections-sipconnectionconfigurationid-delete)
    - [/public/sip-connections/{sipConnectionConfigurationId}/errors](/docs/api-reference/sip/sip-connections-sipconnectionconfigurationid-errors-get)
    - [/public/sip-connections/{sipConnectionConfigurationId}](/docs/api-reference/sip/sip-connections-sipconnectionconfigurationid-patch)
    - [/public/sip-connections/{sipConnectionConfigurationId}/status](/docs/api-reference/sip/sip-connections-sipconnectionconfigurationid-status-post)