curl -X GET 'https://api.va.landing.ai/v1/ade/extract/jobs/{job_id}' \
-H 'Authorization: Bearer YOUR_API_KEY'{
"job_id": "<string>",
"status": "<string>",
"received_at": 123,
"progress": 0.5,
"created_at": 0,
"org_id": "<string>",
"version": "<string>",
"data": {
"extraction": {},
"extraction_metadata": {},
"metadata": {
"filename": "<string>",
"org_id": "<string>",
"duration_ms": 123,
"credit_usage": 123,
"job_id": "<string>",
"version": "<string>",
"schema_violation_error": "<string>",
"fallback_model_version": "<string>",
"warnings": [
{
"msg": "<string>"
}
]
}
},
"output_url": "<string>",
"metadata": {
"filename": "<string>",
"org_id": "<string>",
"duration_ms": 123,
"credit_usage": 123,
"job_id": "<string>",
"version": "<string>",
"schema_violation_error": "<string>",
"fallback_model_version": "<string>",
"warnings": [
{
"msg": "<string>"
}
]
},
"failure_reason": "<string>"
}ADE Get Extract Jobs
Get the status for an async extract job.
Returns the job status or an error response. For EU users, use this endpoint:
https://api.va.eu-west-1.landing.ai/v1/ade/extract/jobs/{job_id}.
curl -X GET 'https://api.va.landing.ai/v1/ade/extract/jobs/{job_id}' \
-H 'Authorization: Bearer YOUR_API_KEY'{
"job_id": "<string>",
"status": "<string>",
"received_at": 123,
"progress": 0.5,
"created_at": 0,
"org_id": "<string>",
"version": "<string>",
"data": {
"extraction": {},
"extraction_metadata": {},
"metadata": {
"filename": "<string>",
"org_id": "<string>",
"duration_ms": 123,
"credit_usage": 123,
"job_id": "<string>",
"version": "<string>",
"schema_violation_error": "<string>",
"fallback_model_version": "<string>",
"warnings": [
{
"msg": "<string>"
}
]
}
},
"output_url": "<string>",
"metadata": {
"filename": "<string>",
"org_id": "<string>",
"duration_ms": 123,
"credit_usage": 123,
"job_id": "<string>",
"version": "<string>",
"schema_violation_error": "<string>",
"fallback_model_version": "<string>",
"warnings": [
{
"msg": "<string>"
}
]
},
"failure_reason": "<string>"
}Authorizations
Your unique API key for authentication.
Get your API key here: https://va.landing.ai/settings/api-key.
If using the EU endpoint, get your API key here: https://va.eu-west-1.landing.ai/settings/api-key.
Path Parameters
Response
Successful Response
The status of an extract job, plus the results once it completes.
A unique identifier for this extract job.
The current state of the job: pending, processing, completed, failed, or cancelled.
Unix timestamp (in seconds) for when the job was received.
Job completion. Either 0.0 (not yet complete) or 1.0 (complete).
0 <= x <= 1Unix timestamp (in seconds) for when the job was created.
Organization ID.
The exact model snapshot used for the extraction.
The extraction results, returned here when the job is complete and you did not set an output_save_url. Large results are returned through output_url instead.
Show child attributes
Show child attributes
A URL to download the extraction results. Provided when the job is complete and either you set an output_save_url or the result is larger than 1 MB. URLs for large results are temporary and expire one hour after you request the job.
Information about the extraction, such as the model version, duration, credit usage, and any schema warnings.
Show child attributes
Show child attributes
If the job failed, a message describing what went wrong.
Was this page helpful?