Skip to main content
PUT
Put Document

Authorizations

Authorization
string
header
required

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

Body

application/json
collectionId
string<uuid>

The ID of the collection where the document will be added.

title
string

A short title for the document in plain text.

Example:

"Password Reset Guide"

body
string

The body of the document. Structured formats like Markdown or JSON are preferred for better AI-powered answers.

The body can be provided as:

  • Plain text (recommended) - Will be automatically compressed for storage
  • Pre-compressed gzip + base64 encoded text (optional) - For large documents or bandwidth optimization

Maximum request size including all fields: 10MB

Example:

"To reset your password, visit ..."

uri
string

A URL of the original source document that uniquely identifies the document. These will be used in answer references to link back to the original source.

Example:

"https://my.company.com/apollo/ticket/123456"

sourceCreatedAt
string<date-time>

When the document was created in its source system. Answers use it to tell newer documents from older ones. Defaults to the time the document is added.

Example:

"2025-06-03T09:12:44-07:00"

Response

OK

id
string<uuid>

The ID of a resource that can be retrieved from the service.