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
Workspace's identifier
"mEFayXdO"
Response
Successfully retrieved workspace.
Uniquely identify a workspace.
"mEFayXdO"
Visibility "organization" means everyone in the organization can access the workspace. Visibility "private" means only people explicitly added can access the workspace.
organization
, private
"organization"
Document types associated with this workspace
Uniquely identify a collection.
If true, the uploaded document will be rejected if it's of the wrong document type, or if its document type cannot be determined. No credits will be consumed.
If "true", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If "false", will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.
true
Number of unvalidated documents in the workspace.
x >= 0
Number of validated documents in the workspace.
x >= 0
When you send email to this address, any document attached in the body will be uploaded to this workspace.
If specified, only emails from these addresses will be ingested for parsing. Wild cards are allowed, e.g. "*@eyefind.info".