/v1/workspace/processor/file-types/{key}/examplesRead a file type's examples
The documents a person gave processor-v2 as examples of one file type, each with its id (the document's sha256), file name, status (reading while processor-v2 reads it, learned once read, failed when nothing could be read) and the clues it suggests the type lacks. :key is the app's document word (bank_statement, id, …) or a workspace's own custom_ type; 400 for a word processor-v2 has no type for, 503 when this deployment has no processor-v2. Any seat.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
the action's answer
{}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}