POST
/
collections
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"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Apollo",
  "description": "Documents from the Apollo customer support tool including support responses.",
  "iconUrl": "https://my.company.com/apollo/logo.svg"
}

Authorizations

​
Authorization
string
header
required

The API key to authenticate requests. Obtainable from the web dashboard.

Body

application/json
​
name
string

A brief identifier for the collection.

Example:

"Apollo"

​
description
string

A sentence defining the document type within this collection, aiding the language model in grasping the content's essence.

Example:

"Documents from the Apollo customer support tool including support responses."

​
iconUrl
string

A URL of a square image used to visually represent document references from the collection in the Unblocked UI. Preferred image formats are SVG, PNG, and JPG.

Example:

"https://my.company.com/apollo/logo.svg"

Response

201
application/json
Created
​
id
string
required

The ID of the collection.

​
name
string

A brief identifier for the collection.

Example:

"Apollo"

​
description
string

A sentence defining the document type within this collection, aiding the language model in grasping the content's essence.

Example:

"Documents from the Apollo customer support tool including support responses."

​
iconUrl
string

A URL of a square image used to visually represent document references from the collection in the Unblocked UI. Preferred image formats are SVG, PNG, and JPG.

Example:

"https://my.company.com/apollo/logo.svg"