API Key Developer Guide
Overview
API keys provide a secure way to authenticate with the Oxygen API without requiring user credentials. This guide covers everything you need to know about implementing API key authentication in your applications.
What are Oxygen API Keys?
API keys are secure tokens that identify your application to the Oxygen API. A unique string prefixed with oxy_
API Documentation
For a complete reference of all available API endpoints, visit our live Swagger API documentation at /apidoc. This interactive documentation allows you to:
- Browse all available endpoints
- View request/response schemas
- Test API calls directly from your browser
- Download OpenAPI specifications
The Swagger documentation is automatically updated and always reflects the
current API version running on your Oxygen instance.
Creating API Keys
Through the Web Interface
- Log into your Oxygen
- User menu -> API Keys
- Click Create New API Key
- Provide a descriptive name for your key
- Set an optional expiration date
- Click Create API Key
Important: Copy your API key immediately after creation. For security reasons, you won’t be able to view the full key again.
Using API Keys
Include your API key in the X-API-Key header with every request. The REST
API is served by your Oxygen host under /api, and most resources are
workspace-scoped (/api/{workspace_id}/...):
Examples
Quick Start Examples
Here are some quick examples to get you started with different programming languages:
Python
JavaScript (Node.js)
cURL