/v1/workspace/processor/file-types/{key}/examplesTeach a file type with an example
Uploads one document ({name, contentBase64}) to processor-v2 as an example of a file type; 202 with the example, status reading until processor-v2 has read it in the background — list the examples again to see it settle. The same file sent twice is one example, read afresh. :key is the app's document word 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. Admin only.
Access class: workspace:admin.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Request body
application/jsonrequiredResponses
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"
}