AI featuresAsk FernAPI referenceDocument

Update Document

View as Markdown

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

domainstringRequired
document_idstringRequired

Headers

x-fern-basepathstring or nullOptional

The basepath of the docs site that the document belongs to, e.g. /plants for a site served at docs.example.com/plants. Omit this for sites served at the root of the domain. Documents are only retrieved by Ask Fern on the site matching the domain and basepath they were created with.

Request

This endpoint expects an object.
documentstring or nullOptional
The updated content of the document that will be returned to Ask Fern during document retrieval. If not provided, this field will remain unchanged.
chunkstring or nullOptional
The updated textual content that should be vectorized when indexing the document. If not provided, this field will remain unchanged.
titlestring or nullOptional
The updated title of the document. If not provided, this field will remain unchanged.
urlstring or nullOptional
The updated url of the document. If not provided, this field will remain unchanged.
versionstring or nullOptional
The updated version of the document. If not provided, this field will remain unchanged.
productstring or nullOptional
The updated product of the document. If not provided, this field will remain unchanged.
keywordslist of strings or nullOptional
The updated keywords of the document. If not provided, this field will remain unchanged.
authedboolean or nullOptional
The updated authed status of the document. If not provided, this field will remain unchanged.

Response

Successful Response
documentobject
The updated document

Errors

422
Unprocessable Entity Error