v1

latestOpenAPI 3.0.3MIT2026-07-22153276289.7 KB
Deprecated End Points

Create a collection

Create a collection

post/v3/collections

Request body

namestring required
workspacestring required

Uniquely identify a workspace.

extractorstring

Uniquely identify an extractor. Required if you are not a super user.

baseExtractorstring

Not applicable, please leave empty. This feature is reserved for super user.

autoValidationThresholdnumber
enableAutoValidationThresholdboolean
dateFormatPreference'DMY' | 'MDY' | 'YMD' nullable
dateFormatFromDocumentboolean nullable

Predict the date format from any dates in the document that is not ambiguous.

allowOpenaiboolean

Whether to allow OpenAI API to be used to assist in creating a model for this collection.

trainsExtractorboolean

Whether this collection feeds documents into the extractor's training queue. This setting can only be toggled for custom extractors.

disableConfirmationIfValidationRulesFailboolean

If True, users cannot validate documents with missing mandatory fields, or failing validation rules.

Response

Successfully created a collection.

identifierstring required

Uniquely identify a collection.

namestring
autoValidationThresholdnumber
enableAutoValidationThresholdboolean
autoValidateIfValidationRulesPassboolean
fieldsConfiguredboolean
dateFormatPreference'DMY' | 'MDY' | 'YMD' nullable
dateFormatFromDocumentboolean nullable

Predict the date format from any dates in the document that is not ambiguous.

unvalidatedDocsCountinteger nullable

Number of unvalidated documents in the collection.

confirmedDocsCountinteger nullable

Number of validated documents in the collection.

ingestEmailstring

When you send email to this address, any document attached in the body will be uploaded to this collection.

tailoredExtractorRequestedboolean

Whether a tailored extractor has been requested for this collection.

allowOpenaiboolean

Whether to allow OpenAI API to be used to assist in creating a model for this collection.

trainsExtractorboolean

Whether this collection feeds documents into the extractor's training queue. This setting can only be toggled for custom extractors.

disableConfirmationIfValidationRulesFailboolean

If True, users cannot validate documents with missing mandatory fields, or failing validation rules.

autoRefreshValidationResultsboolean

If True, validation results are refreshed whenever annotations are changed.