Quickstart for the Unblocked API

The Unblocked API is a REST API that allows providing documents to Unblocked to use for answering questions. This is a quickstart guide for using the Unblocked API.

​

Create an API Token

First, create a token in the API Tokens section of the Settings section of the Unblocked web app. This token should be provided with each request to the Unblocked API to authenticate the request.

​

Create a Collection

Next, create a collection. A collection in Unblocked is a group of related documents from various data sources, such as customer support tools, knowledge bases, and internal wikis.

Multiple collections can be created to manage documents from different sources.

curl --request POST \
  --url https://getunblocked.com/api/v1/collections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Apollo",
  "description": "Documents from the Apollo customer support tool including support responses.",
  "iconUrl": "https://my.company.com/apollo/logo.svg"
}'

The Unblocked API will respond with the newly created collection along with an ID. This ID uniquely identifies the collection, and will be used for adding documents to Unblocked.

{
  "id": "12345678-abcd-123456789-123456789abc",
  "name": "Apollo",
  "description": "Documents from the Apollo customer support tool including support responses.",
  "iconUrl": "https://my.company.com/apollo/logo.svg"
}

Collections can also be created in the Unblocked web app. Once you’ve signed in, click Data Sources in the sidebar, and then the Explore All section. Scroll to the documentation section and select Create a Custom Source.

​

Add a Document

Finally, add a document to the collection using the collection’s ID. In addition to the collection ID, provide a title, a body (in plain text or Markdown), and a URI for the document.

A document is uniquely identified by it’s URI. The URI will be used to link to the source of a reference in an answer.

curl --request PUT \
  --url https://getunblocked.com/api/v1/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "collectionId": "12345678-abcd-123456789-123456789abc",
  "title": "Password Reset Guide",
  "body": "To reset your password, visit ...",
  "uri": "https://my.company.com/apollo/ticket/123456"
}'