Interactive OpenAPI Documentation
Access the interactive Swagger / OpenAPI specification for live endpoint testing and complete schema definitions at connect.omnifact.ai/docs.
Base URL
All Public API and AI Gateway requests are sent to the base URL:Authentication
Authentication depends on which API surface you are calling:1. Organization API Endpoints (/v1/documents/* and /v1/gateway/*)
Requests to the Documents API and AI Gateway require your organization API key passed in either the X-API-Key header or the standard Authorization: Bearer header:
Keep your API key secure. Never expose your organization API key in client-side browser code, mobile binaries, or public repositories.
2. Published Space Chat Endpoints (/v1/endpoints/{endpointId}/chat)
POST /v1/endpoints/{endpointId}/chat does not use X-API-Key. Instead, the {endpointId} UUID in the endpoint URL acts as a pre-shared capability token. Treat the full endpoint URL as a secret credential and proxy calls through your backend when exposing a chat widget externally.
3. Health Check (GET /)
GET https://connect.omnifact.ai/ is an unauthenticated health check endpoint that returns a plain-text status confirmation.
Generating and Rotating API Keys
Team administrators on the Enterprise Plan can enable API access and manage organization API keys in Omnifact:- Click your Organization Logo (above your User Avatar in the bottom-left navigation bar) and select Team Settings.
- Open Developer Tools in the sidebar.
- Toggle on Enable API Access. Omnifact immediately generates your key and opens the Your New API Key dialog so you can click Copy API Key and store it securely.
- To rotate an existing key at any time, click Regenerate next to Current API Key.
Available API Resources
Omnifact exposes three API surfaces onhttps://connect.omnifact.ai:
Documents API
Programmatically list, upload, inspect, rename, and delete documents in Space Uploaded Files.
Published Spaces Chat API
Send messages to published Space endpoints with support for JSON responses and real-time SSE streaming.
AI Gateway
Call enabled models across providers through a single OpenAI-compatible
/v1/gateway API.Error Handling
The API uses standard HTTP status codes to indicate request outcomes:Error Response Formats
Omnifact uses two error envelopes depending on the endpoint family:- Documents & Published Space Chat
- AI Gateway (/v1/gateway/*)
Domain errors on Authentication, authorization, and route-not-found errors return standard HTTP error fields:
/v1/documents/* and /v1/endpoints/* return a top-level JSON object with a lowercase snake_case code, a human-readable message, and optional details:Next Steps
- Explore the Documents API for automated Space document management
- Stream chat completions from Space knowledge with the Published Spaces Chat API
- Connect OpenAI SDKs and developer tools via the AI Gateway
- Manage your organization API key in Developer Tools