Authentication
Learn how to authenticate requests to the Omniagent API
API keys
The Omniagent API uses API keys to authenticate requests. Every API key is scoped to an organization and a project. All resources — companions, tools, knowledge collections, and FAQ collections — live under a specific project.
All API requests must include the key in the X-Api-Key header:
X-Api-Key: <your-api-key>If the key is missing, expired, or invalid, the server responds with 401 Unauthorized.
Your API key is a secret. Keep it private and only use it on the server side — never expose it in client-side code.
Getting an API key
To generate an API key, go to the API Keys page in the dashboard and click Generate API key.
When generating a key, you configure:
- Project — select which project to scope the key to.
- Provider — choose Azure OpenAI as the LLM provider.
- Deployment type — choose Custom or Napster:
- Custom — you provide your own deployment credentials (Azure endpoint and key). AI inference runs in your cloud environment.
- Napster — Napster manages the model infrastructure. No credentials needed.
Using your API key
Include your key in the X-Api-Key header on every request:
curl https://companion-api.napster.com/public/companions/napster-stock \
-H "X-Api-Key: $NAPSTER_API_KEY"The same key works for all Omniagent API endpoints — managing companions, uploading knowledge, configuring tools, and everything else.