Skip to main content
POST
/
lab_report
/
v1
/
parser
/
job
curl --request POST \
     --url '{{BASE_URL}}/lab_report/v1/parser/job' \
     --header 'accept: application/json' \
     --header 'x-vital-api-key: {YOUR_KEY}' \
     --header 'Content-Type: multipart/form-data' \
     --form 'file=@/path/to/lab_report.pdf' \
     --form 'needs_human_review=false'

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "started",
  "data": null,
  "needs_human_review": false,
  "is_reviewed": false
}

This feature is in closed beta.Interested in this feature? Get in touch with your Customer Success Manager.
Upload a lab report file (PDF, JPEG, or PNG) to create a parsing job. The job will extract lab results and match them to LOINC codes. 
curl --request POST \
     --url '{{BASE_URL}}/lab_report/v1/parser/job' \
     --header 'accept: application/json' \
     --header 'x-vital-api-key: {YOUR_KEY}' \
     --header 'Content-Type: multipart/form-data' \
     --form 'file=@/path/to/lab_report.pdf' \
     --form 'needs_human_review=false'

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "started",
  "data": null,
  "needs_human_review": false,
  "is_reviewed": false
}

Authorizations

​
x-vital-api-key
string
header
required

Vital Team API Key

Body

multipart/form-data
​
file
file
required
​
user_id
string<uuid>
required
​
needs_human_review
boolean
default:false

Response

Successful Response

​
id
string<uuid>
required
​
job_id
string<uuid>
required
deprecated
​
status
enum<string>
required

ℹ️ This enum is non-exhaustive.

Available options:
upload_pending,
started,
completed,
failed
​
needs_human_review
boolean
required
​
is_reviewed
boolean
required
​
failure_reason
enum<string> | null

Machine-readable failure reasons for parsing jobs. ℹ️ This enum is non-exhaustive.

Available options:
invalid_input,
low_quality,
not_english
​
data
ParsedLabReportData · object