API ReferenceDocument Insights

Submit extraction feedback

Submits feedback on an extraction result.

Provide fieldId for field-level feedback, or omit it for the whole extraction.

Authentication

Authorizationstring

Use the API key format: api-key <token>.

Path parameters

extractionIdstringRequired
Extraction identifier returned when the extraction was created.

Request

This endpoint expects an object.
messagestringRequired1-1024 characters

Human-readable feedback message. Maximum length: 1024 characters.

typeenumOptional

Feedback type. ERROR marks the extraction as needing correction and review. INFO records a note without marking the extraction as incorrect. Defaults to ERROR when omitted.

fieldIdstringOptional1-256 characters

Optional extracted field identifier. Include it when feedback applies to a specific field from output.fields; omit it for general extraction feedback.

Response

Feedback recorded.
idstringOptional
Feedback identifier.
extractionIdstringOptional
The extraction this feedback belongs to.
messagestringOptional
The submitted feedback text.
typeenumOptional
Feedback type accepted by Document Insights.
fieldIdstring or nullOptional
The field identifier supplied in the request. Returned as null for general extraction feedback.
createdAtdatetimeOptional
UTC timestamp when the feedback was accepted.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
405
Method Not Allowed Error
406
Not Acceptable Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error