Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ubik-agent.com/llms.txt

Use this file to discover all available pages before exploring further.

Welcome to the UBIK API Reference. This documentation provides detailed information about all the available endpoints, parameters, and responses. For more goal-oriented tutorials and step-by-step guides, please see our Guides section.

​
Authentication

All requests to the UBIK API must be authenticated. We support two primary methods:
  1. API Key (Server-Side): For backend integrations.
  2. Scoped JWT (Client-Side): For frontend applications and multi-tenant user isolation.
For a complete guide on authentication, generating tokens, and managing multi-tenancy with external_user_id, please see our Authentication & Security Guide.

​
API Endpoint

The base URL for all API endpoints is: 
https://app.ubik-agent.com/api/v1

​
Core Resources

The UBIK API is organized around a few core resources:

Workspaces

High-level containers for organizing your projects, documents, and tools.

Documents

The raw information you provide, like PDFs, text files, or web pages, which are ingested and processed by UBIK.

Tools

Powerful, pre-built functions that perform complex, asynchronous tasks on your documents.

Agent Sessions

Stateful conversations with AI agents that maintain context and history.