API referenceCode

Batch Create Code Records

Authentication

AuthorizationBearer

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

Path Parameters

domainstringRequired

Request

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

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

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

Response

Successful Response
code_idstring
The unique identifier of the created code entry

Errors