Authorizations
Basic authentication using an API key, e.g. {Authorization: Bearer 75z0bb4fbdf97b7e4111ff6c0015471094155f91}
.
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.
Body
Resume to upload, either via file upload or URL to a file
File as binary data blob. Supported formats: PDF, DOC, DOCX, TXT, RTF, HTML, PNG, JPG, TIFF, ODT, XLS, XLSX
URL to download the resume.
"https://api.affinda.com/static/sample_resumes/example.docx"
A JSON-encoded string of the ResumeData
object.
Deprecated in favor of customIdentifier
.
Specify a custom identifier for the document if you need one, not required to be unique.
Optional filename of the file
"Document.pdf"
If "true" (default), will return a response only after processing has completed. If "false", will return an empty data object which can be polled at the GET endpoint until processing is complete.
true
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
Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.
"en"
The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.
A JSON representation of the RegionBias object.
"{\"country\": \"vn\"}"
Explicitly mark this document as low priority.
true