Skip to main content
The Omnifact Public API enables developers and teams to integrate Omnifact’s AI capabilities into external applications, custom portals, and automated workflows. You can manage documents in Space Uploaded Files, invoke OpenAI-compatible model completions through the AI Gateway, and communicate directly with published .

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:
JSON request bodies across Public API endpoints have a maximum size limit of 1 MB.

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.
Privacy Filter Notice: Programmatic requests to connect.omnifact.ai (including the Documents API, Published Spaces Chat API, and AI Gateway) bypass the Omnifact Privacy Filter. Ensure your integration handles sensitive data in accordance with your organization’s compliance policies.

Generating and Rotating API Keys

Team administrators on the Enterprise Plan can enable API access and manage organization API keys in Omnifact:
  1. Click your Organization Logo (above your User Avatar in the bottom-left navigation bar) and select Team Settings.
  2. Open Developer Tools in the sidebar.
  3. 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.
  4. To rotate an existing key at any time, click Regenerate next to Current API Key.
For full details, see Developer Tools.

Available API Resources

Omnifact exposes three API surfaces on https://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:
Domain errors on /v1/documents/* and /v1/endpoints/* return a top-level JSON object with a lowercase snake_case code, a human-readable message, and optional details:
Authentication, authorization, and route-not-found errors return standard HTTP error fields:

Next Steps