Authorizations
Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}
.
You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.
Path Parameters
Document's identifier
Query Parameters
If "true", the response is compacted to annotations' parsed data. Annotations' meta data are excluded. Default is "false".
Whether to return the response in snake_case instead of camelCase. Default is false.
Body
Document data to update
Uniquely identify a collection.
"mEFayXdO"
Uniquely identify a workspace.
"mEFayXdO"
The document type's identifier. Provide if you already know the document type.
Optional filename of the file
"Document.pdf"
The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.
Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.
"en"
Deprecated in favor of customIdentifier
.
Specify a custom identifier for the document if you need one, not required to be unique.