Introduction

Welcome to the Unleash API reference! With Unleash REST API you can easily connect with content from 70+ integrations and build custom Gen AI solutions for your company.

Why use the API?

Leverage Unleash’s permission-aware, personalized APIs to query and search across all unstructured data in your organization. These APIs enable the creation of dynamic, knowledge-driven workflows, empowering you to build solutions tailored to your specific business needs.

There are many use cases for the API, including:

• Create tailored search assistants or chatbots to query for departmental knowledge

• Transform your internal knowledge base or support portal by embedding Unleash-powered search into the platform

• White-label Unleash within your product, to deliver a fully branded, integrated knowledge search experience to your customers

Who is the API for?

The API is designed for developers who will be integrating, using, or interacting with the Unleash platform.

What Unleash modules does the API support?

The supported modules include:

• Chat

• Search

Endpoints

https://e-api.unleash.so/

Important

Customers running Unleash in a private tenant or self hosted environment should change the API endpoints to be relative to their own tenant domain (e.g. https://app.acme.unleash.so/e-api/chats)

Raw API swagger documentation is available at: https://api.unleash.wiki

All endpoints accept an optional parameter called assistantId. If the assistantId is not provided, API calls will target the default assistant for the workspace. Only “General Assistant” IDs can be used in the assistantId parameter. To find the assistant ID for a specific assistant, visit the Assistant configuration page in the Unleash Admin Center and copy the last part of the page URL.

Errors

Every endpoint of the platform API returns a "RequestId" field in both the response body and header. If you encounter an unexpected error, you can provide the RequestId value to our support team to help diagnose the root cause of the issue. API errors conform to a standardized REST error format (e.g., RFC 7807).

Postman Examples Collection

• Download JSON file here: unleash.postman_collection.json

• Contains examples for querying the API, performing chats / searches, managing filters, retrieving filter statistics, and generating custom user tokens.

Any Questions?

Feel free to reach out to support@unleash.so