Skip to main content
GET
Get Collection

Authorizations

Authorization
string
header
required

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

Path Parameters

collectionId
string<uuid>
required

The ID of the collection.

Response

OK

id
string<uuid>
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"