# UBIK Public API

## Docs

- [Add document to workspaces](https://docs.ubik-agent.com/api-reference/public-api/add-document-to-workspaces.md): Adds a document to one or more workspaces.
- [Create a workspace](https://docs.ubik-agent.com/api-reference/public-api/create-a-workspace.md): Creates a new personal workspace for the user.
- [Create agent session](https://docs.ubik-agent.com/api-reference/public-api/create-agent-session.md): Creates a new agent session. Provide 'external_user_id' to isolate this session for a specific end-user. If both 'assistant_id' and 'initial_system_prompt' are provided, the 'initial_system_prompt' will override the assistant's default system prompt.
- [Delete a document](https://docs.ubik-agent.com/api-reference/public-api/delete-a-document.md): Delete a document. This will remove the document from the user's default workspace and, if they are the last owner, delete it from the system entirely.
- [Delete a workspace](https://docs.ubik-agent.com/api-reference/public-api/delete-a-workspace.md): Deletes a workspace, provided the user is the owner.
- [Delete agent session](https://docs.ubik-agent.com/api-reference/public-api/delete-agent-session.md): Deletes an agent session and all associated messages.
- [Edit message and regenerate](https://docs.ubik-agent.com/api-reference/public-api/edit-message-and-regenerate.md): Edits a user message (creating a new branch) and regenerates the response.
- [Execute a tool](https://docs.ubik-agent.com/api-reference/public-api/execute-a-tool.md): Asynchronously starts a tool execution and returns an execution ID to track the results. Note: MCP tools cannot be used through this API for now. Only tools from the /tools endpoint can be executed.
- [Get agent session details](https://docs.ubik-agent.com/api-reference/public-api/get-agent-session-details.md): Retrieves details of a specific agent session.
- [Get chunk details](https://docs.ubik-agent.com/api-reference/public-api/get-chunk-details.md): Retrieves the details of a specific chunk, including text content and bounding box information.
- [Get document details](https://docs.ubik-agent.com/api-reference/public-api/get-document-details.md): Retrieves the details of a specific document, provided the user has access.
- [Get document from chunk](https://docs.ubik-agent.com/api-reference/public-api/get-document-from-chunk.md): Retrieves the document associated with a specific chunk ID, provided the user has access to the document.
- [Get execution result](https://docs.ubik-agent.com/api-reference/public-api/get-execution-result.md): Retrieves the status and result of a specific tool execution.
- [Get JWT from API Key](https://docs.ubik-agent.com/api-reference/public-api/get-jwt-from-api-key.md): Exchange a valid API Key for a short-lived JWT access token. Optionally provide 'external_user_id' to scope the token to a specific end-user.
- [Get message details](https://docs.ubik-agent.com/api-reference/public-api/get-message-details.md): Retrieves details of a specific message, including sibling IDs for branching.
- [Get session messages](https://docs.ubik-agent.com/api-reference/public-api/get-session-messages.md): Retrieves the active branch of messages for the session.
- [Get skill](https://docs.ubik-agent.com/api-reference/public-api/get-skill.md): Retrieves a specific skill by ID.
- [Get tool asset](https://docs.ubik-agent.com/api-reference/public-api/get-tool-asset.md): Retrieves a media asset associated with a tool execution. Enforces access control based on the session owner and external_user_id.
- [Get tool details](https://docs.ubik-agent.com/api-reference/public-api/get-tool-details.md): Retrieves the details of a specific tool, provided the user has access.
- [Get tool embedding information](https://docs.ubik-agent.com/api-reference/public-api/get-tool-embedding-information.md): Retrieves the necessary details for embedding a tool's UI, including its schema and allowed domains. Optionally accepts 'external_user_id' to scope the returned access token.
- [Get workspace details](https://docs.ubik-agent.com/api-reference/public-api/get-workspace-details.md): Retrieves the details of a specific workspace, provided the user has access.
- [Health Check](https://docs.ubik-agent.com/api-reference/public-api/health-check.md): Health check endpoint for the public API.
- [Ingest documents from files or URLs](https://docs.ubik-agent.com/api-reference/public-api/ingest-documents-from-files-or-urls.md): Unified endpoint to ingest documents from various sources.
- [Link documents](https://docs.ubik-agent.com/api-reference/public-api/link-documents.md): Links existing documents to the agent session context.
- [Link skills](https://docs.ubik-agent.com/api-reference/public-api/link-skills.md): Links existing skills to the agent session context.
- [Link workspaces](https://docs.ubik-agent.com/api-reference/public-api/link-workspaces.md): Links existing workspaces to the agent session context.
- [List agent sessions](https://docs.ubik-agent.com/api-reference/public-api/list-agent-sessions.md): Retrieves a paginated list of agent sessions. Use 'X-End-User-ID' header to filter by your end-users.
- [List available assistants](https://docs.ubik-agent.com/api-reference/public-api/list-available-assistants.md): Retrieves a list of assistants accessible to the user. This endpoint is not available for end-user scoped requests.
- [List available MCP servers](https://docs.ubik-agent.com/api-reference/public-api/list-available-mcp-servers.md): Retrieves a paginated list of MCP servers accessible to the user.
- [List available models](https://docs.ubik-agent.com/api-reference/public-api/list-available-models.md): Retrieves a list of all LLM models accessible to the user.
- [List available tools](https://docs.ubik-agent.com/api-reference/public-api/list-available-tools.md): Retrieves a paginated list of all tools accessible to the user.
- [List documents](https://docs.ubik-agent.com/api-reference/public-api/list-documents.md): Retrieves a paginated list of all documents accessible to the user.
- [List documents in a workspace](https://docs.ubik-agent.com/api-reference/public-api/list-documents-in-a-workspace.md): Retrieves a paginated list of documents within a specific workspace.
- [List session checkpoints](https://docs.ubik-agent.com/api-reference/public-api/list-session-checkpoints.md): Retrieves a list of checkpoints for the agent session.
- [List session documents](https://docs.ubik-agent.com/api-reference/public-api/list-session-documents.md): Retrieves a paginated list of documents linked to the agent session, including their starred status.
- [List session MCP servers](https://docs.ubik-agent.com/api-reference/public-api/list-session-mcp-servers.md): Retrieves a list of MCP servers currently active in the agent session.
- [List session skills](https://docs.ubik-agent.com/api-reference/public-api/list-session-skills.md): Retrieves a list of skills accessible to the agent session with full details.
- [List session tools](https://docs.ubik-agent.com/api-reference/public-api/list-session-tools.md): Retrieves a list of static platform/user tools accessible to the agent session. Note: This endpoint does not return active MCP servers. To see active MCP servers, use the /mcp-servers endpoint.
- [List skills](https://docs.ubik-agent.com/api-reference/public-api/list-skills.md): Retrieves a list of skills accessible to the user. Supports filtering by IDs to fetch specific skills.
- [List workspaces](https://docs.ubik-agent.com/api-reference/public-api/list-workspaces.md): Retrieves a paginated list of all workspaces accessible to the user. This includes personal workspaces and shared company workspaces.
- [Navigate session](https://docs.ubik-agent.com/api-reference/public-api/navigate-session.md): Switches the active branch of the conversation to a specific message.
- [Navigate to checkpoint](https://docs.ubik-agent.com/api-reference/public-api/navigate-to-checkpoint.md): Resumes the agent session from a specific checkpoint.
- [Provide input to a waiting tool](https://docs.ubik-agent.com/api-reference/public-api/provide-input-to-a-waiting-tool.md): Provides the required input to a tool execution that is in the 'waiting_for_input' state.
- [Read Current User](https://docs.ubik-agent.com/api-reference/public-api/read-current-user.md): Get the details of the current user.
- [Regenerate response](https://docs.ubik-agent.com/api-reference/public-api/regenerate-response.md): Regenerates the response for a specific message. If the message is from the assistant, it re-runs the parent user message (creating a new assistant sibling). If it's from the user, it re-runs that user message (creating a new assistant sibling).
- [Remove a document from a workspace](https://docs.ubik-agent.com/api-reference/public-api/remove-a-document-from-a-workspace.md): Removes a document's association from a specific workspace without deleting the document itself.
- [Remove document from workspaces](https://docs.ubik-agent.com/api-reference/public-api/remove-document-from-workspaces.md): Removes a document from one or more workspaces.
- [Reprocess a document](https://docs.ubik-agent.com/api-reference/public-api/reprocess-a-document.md): Reprocess a document using a different pipeline, optionally updating the file content.
- [Send message](https://docs.ubik-agent.com/api-reference/public-api/send-message.md): Adds a user message to the session and optionally triggers the agent to generate a response.
- [Star/Unstar document](https://docs.ubik-agent.com/api-reference/public-api/starunstar-document.md): Stars or unstars a document within the agent session.
- [Stop agent generation](https://docs.ubik-agent.com/api-reference/public-api/stop-agent-generation.md): Stops the ongoing agent generation for the specified session. If a tool call is in progress, the system will wait for its completion before stopping to ensure state consistency. An 'agent_stop_requested' event will be emitted in the session stream.
- [Stream execution events](https://docs.ubik-agent.com/api-reference/public-api/stream-execution-events.md): Streams Server-Sent Events (SSE) for a tool execution.
- [Stream session events](https://docs.ubik-agent.com/api-reference/public-api/stream-session-events.md): Streams Server-Sent Events (SSE) for the agent session. By default, it streams the current or most recent task, replaying past events first.
- [Unlink document](https://docs.ubik-agent.com/api-reference/public-api/unlink-document.md): Unlinks a document from the agent session context.
- [Unlink skill](https://docs.ubik-agent.com/api-reference/public-api/unlink-skill.md): Unlinks a skill from the agent session context.
- [Unlink workspace](https://docs.ubik-agent.com/api-reference/public-api/unlink-workspace.md): Unlinks a workspace from the agent session context.
- [Update agent session](https://docs.ubik-agent.com/api-reference/public-api/update-agent-session.md): Updates an existing agent session. Can be used to change the title, model, or active tools.
- [Update Document Access Metadata](https://docs.ubik-agent.com/api-reference/public-api/update-document-access-metadata.md): Update custom metadata (like external_URI) for a specific external user or globally.
- [Upload and link document](https://docs.ubik-agent.com/api-reference/public-api/upload-and-link-document.md): Uploads a file and immediately links it to the agent session.
- [How our RAG Pipeline is Different](https://docs.ubik-agent.com/en/advanced/rag-pipeline.md): Deep dive into the UBIK RAG pipeline architecture, focusing on performance bottlenecks.
- [Introduction](https://docs.ubik-agent.com/en/api-reference/introduction.md): Get started with the UBIK API.
- [Agent Skills Tools](https://docs.ubik-agent.com/en/core-features/agent-skills-tools.md): Detailed documentation for the tools used by agents to interact with Skills.
- [Code Execution](https://docs.ubik-agent.com/en/core-features/code-execution.md): Detailed documentation for the code_execution tool.
- [Image Generation](https://docs.ubik-agent.com/en/core-features/image-generation.md): Detailed documentation for the image_generation tool.
- [Information Analysis](https://docs.ubik-agent.com/en/core-features/information-analysis.md): Detailed documentation for the information_analysis tool.
- [Native Tools](https://docs.ubik-agent.com/en/core-features/native-tools.md): Overview of the powerful native tools available to agents in the UBIK platform.
- [RAG Search](https://docs.ubik-agent.com/en/core-features/rag-search.md): Detailed documentation for the rag_search tool.
- [Structured Writing](https://docs.ubik-agent.com/en/core-features/structured-writing-task.md): Detailed documentation for the structured_writing tool.
- [Subagent Task](https://docs.ubik-agent.com/en/core-features/subagent-task.md): Detailed documentation for the subagent tool.
- [Web Search](https://docs.ubik-agent.com/en/core-features/web-search.md): Detailed documentation for the web_search tool.
- [Core Concepts](https://docs.ubik-agent.com/en/development.md): Understand the fundamental building blocks of the UBIK API.
- [Agent Message Structure](https://docs.ubik-agent.com/en/guides/agent-message-structure.md): Reference for the internal structure and tags of Agent Session messages.
- [Agent Session Events](https://docs.ubik-agent.com/en/guides/agent-session-events.md): Reference for real-time events in Agent Sessions.
- [Guide: Agent Sessions](https://docs.ubik-agent.com/en/guides/agent-sessions.md): Learn how to build interactive, stateful chat experiences with Agent Sessions.
- [Agent Skills](https://docs.ubik-agent.com/en/guides/agent-skills.md): Equip your AI agents with reusable custom capabilities, instructions, and tools.
- [Authentication & Security](https://docs.ubik-agent.com/en/guides/authentication.md): Learn how to authenticate requests and implement multi-tenancy with UBIK.
- [Guide: Integrating UBIK with an iframe](https://docs.ubik-agent.com/en/guides/embedding-tools.md): Learn how to securely embed a UBIK tool's UI directly into your web application for a seamless user experience.
- [Guide: Executing Your First Tool](https://docs.ubik-agent.com/en/guides/executing-tools.md): Learn how to discover, execute, and retrieve results from UBIK's powerful asynchronous tools.
- [Guide: Managing Content with Workspaces](https://docs.ubik-agent.com/en/guides/managing-workspaces.md): Learn how to organize your documents by creating and managing workspaces using the UBIK API.
- [Self-hosted GPU Parser](https://docs.ubik-agent.com/en/guides/self-hosted-gpu-parser.md): Learn how to deploy and manage your own optimized GPU parser instance.
- [Self-hosted Secure Browser](https://docs.ubik-agent.com/en/guides/self-hosted-secure-browser.md): Learn how to deploy and manage your own secure browser instance.
- [Guide: Getting Real-Time Results with SSE](https://docs.ubik-agent.com/en/guides/streaming-results.md): Learn how to stream events in real-time from tool executions and agent sessions using Server-Sent Events (SSE).
- [Introduction](https://docs.ubik-agent.com/en/index.md): Welcome to the UBIK API documentation.
- [Quickstart](https://docs.ubik-agent.com/en/quickstart.md): Make your first API call and see UBIK in action in less than 5 minutes.

## OpenAPI Specs

- [openapi](https://docs.ubik-agent.com/api-reference/openapi.json)
- [openapi.fr](https://docs.ubik-agent.com/api-reference/openapi.fr.json)
- [openapi.en](https://docs.ubik-agent.com/api-reference/openapi.en.json)