API referenceDocument

Create Document

Path parameters

domainstringRequired

Request

This endpoint expects an object.
documentstringRequired
The content of the document that will be returned to Ask Fern during document retrieval.
chunkstring or nullOptional
The textual content that should be vectorized when indexing the document. If not provided, the full document will be vectorized.
titlestring or nullOptional

The title of the document. This will be used with the url when Ask Fern cites this document.

urlstring or nullOptional
The url of the document. This will be used as the source of the document when Ask Fern cites it.
versionstring or nullOptional
The version of the document. This will be compared against when running Ask Fern with version filters. If null, the document will be retrievable by all versions.
productstring or nullOptional
The product of the document. This will be used to filter documents when running Ask Fern with product filters. If null, the document will be retrievable by all products.
keywordslist of strings or nullOptional
The keywords of the document. Adding keywords can improve document matching.
authedboolean or nullOptional
Whether the document is authed. If true, the document will be retrievable by all users.

Response

Successful Response
document_idstring
The unique identifier of the created document

Errors