Uploading documents
To make your first API call, you’ll need to:- Generate an API key (Settings → API Keys)
- Retrieve the Workspace identifier (Workspace -> Workflow -> Integrations)
- Retrieve the relevant Document Type identifier (Document Types -> Resume Parser (or other Document Type) -> Settings)
Optional parameters
The above sample will allow users to upload a document using our default settings. However, users may wish to consider the use of other parameters when setting up their integrations.The below are commonly used parameters for the Resume Parsing use case. For the full list of parameters, see Uploading Documents.
wait
to true / false depending if the parsing response needs to be returned synchronously or not.
- True: Response will be returned once parsing has completed and will include extracted data
- False: Response will be returned immediately with _meta _object only (which includes the unique identifier assigned to that document). Extracted data will need to be requested later (either through polling or webhooks). Recommended for customers who are bulk uploading.
- expiryTime: Document will be automatically deleted at this time
- deleteAfterParse: No data is stored, and the document is deleted as soon as it is parsed
compact
to return only the parsed value.
Parsing Time
For customers where speed of response is a key consideration, additional improvements can be achieved when uploading via API by setting the following parameters:
- wait: True
- enableValidationTool: False
- deleteAfterParse: True
- compact: True