Endpoint Reference
Batch JSON
Submit up to 500 pre-parsed resumes as JSON objects in a single request. Each candidate entry may include an optional external_candidate_id — your own opaque reference (ATS ID, user_id, etc.) that we store and echo back in all batch results.
POST/v1/batch-json
Request Parameters
| Name | Type | Description |
|---|---|---|
job_idRequired | string | A valid job_id from POST /v1/create-job or POST /v1/parse-job. |
language | string | Language code for AI analysis (e.g. 'en', 'fr', 'es'). Defaults to 'en'. |
candidatesRequired | array | Array of candidate objects (1–500). Each item contains a 'resume' (ParsedResume JSON) and an optional 'external_candidate_id' (string, max 255 chars). |
Pro Tip
Always handle rate limiting headers in your logic. For best performance, use asynchronous processing for large files.