API Overview & Authentication

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, query system status, 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.

Authentication

All requests to the Omnifact Public API require authentication using an API key passed in the X-API-Key HTTP header.

X-API-Key: your_omnifact_api_key_here

Keep your API key secure. Do not expose your API key in client-side code, public repositories, or frontend web applications.

Managing API Keys

Team administrators can generate and manage organization API keys directly from the Omnifact application:

Navigate to Team Settings in the main navigation bar.
Click Developer Tools (requires administrator privileges).
Enable API Access if it is not already active.
Click Generate API Key to create a key for your team.

For step-by-step instructions on enabling developer access, see Developer Tools.

Base URL

All Public API requests should be sent to the base URL:

https://connect.omnifact.ai

Available API Resources

The Public API is organized into two primary functional areas:

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 and real-time SSE streaming.

Error Handling

The API uses standard HTTP status codes to indicate request outcomes:

Status Code	Meaning	Description
`200 OK`	Success	Request succeeded.
`201 Created`	Created	Resource successfully created (e.g., document upload).
`400 Bad Request`	Bad Request	Missing or invalid parameters.
`401 Unauthorized`	Unauthorized	Missing or invalid `X-API-Key` header.
`404 Not Found`	Not Found	Requested document or endpoint ID does not exist.
`429 Too Many Requests`	Rate Limited	Quota or rate limit exceeded.
`500 Internal Error`	Server Error	An internal error occurred while processing the request.

All error responses return a JSON object with error details:

{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The provided X-API-Key header is invalid or expired."
  }
}

Next Steps

Explore the Documents API for document management
Learn how to stream chat responses with the Published Spaces Chat API
Configure API settings in Developer Tools

Interactive OpenAPI Documentation

​Authentication

​Managing API Keys

​Base URL

​Available API Resources

Documents API

Published Spaces Chat API

​Error Handling

​Next Steps

Authentication

Managing API Keys

Base URL

Available API Resources

Error Handling

Next Steps