Get ingest job status
curl --request GET \
--url https://api.get-exo.com/v1/ingest/{job_id}/status \
--header 'X-Exo-API-Key: <api-key>'import requests
url = "https://api.get-exo.com/v1/ingest/{job_id}/status"
headers = {"X-Exo-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Exo-API-Key': '<api-key>'}};
fetch('https://api.get-exo.com/v1/ingest/{job_id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"jobId": "<string>",
"status": "<string>",
"completedSteps": [
"<string>"
],
"errorMessage": "<string>",
"percent": 0,
"phase": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"documentationUrl": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"pointer": "<string>"
}
],
"requestId": "",
"suggestedAction": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"documentationUrl": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"pointer": "<string>"
}
],
"requestId": "",
"suggestedAction": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"documentationUrl": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"pointer": "<string>"
}
],
"requestId": "",
"suggestedAction": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"documentationUrl": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"pointer": "<string>"
}
],
"requestId": "",
"suggestedAction": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"documentationUrl": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"pointer": "<string>"
}
],
"requestId": "",
"suggestedAction": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"documentationUrl": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"pointer": "<string>"
}
],
"requestId": "",
"suggestedAction": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"documentationUrl": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"pointer": "<string>"
}
],
"requestId": "",
"suggestedAction": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"documentationUrl": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"pointer": "<string>"
}
],
"requestId": "",
"suggestedAction": "<string>"
}Ingestion
Get ingest job status
Poll one ingest or import job: its current phase, the phases it has already completed, a percentage estimate, and the error message if it failed.
GET
/
v1
/
ingest
/
{job_id}
/
status
Get ingest job status
curl --request GET \
--url https://api.get-exo.com/v1/ingest/{job_id}/status \
--header 'X-Exo-API-Key: <api-key>'import requests
url = "https://api.get-exo.com/v1/ingest/{job_id}/status"
headers = {"X-Exo-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Exo-API-Key': '<api-key>'}};
fetch('https://api.get-exo.com/v1/ingest/{job_id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"jobId": "<string>",
"status": "<string>",
"completedSteps": [
"<string>"
],
"errorMessage": "<string>",
"percent": 0,
"phase": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"documentationUrl": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"pointer": "<string>"
}
],
"requestId": "",
"suggestedAction": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"documentationUrl": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"pointer": "<string>"
}
],
"requestId": "",
"suggestedAction": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"documentationUrl": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"pointer": "<string>"
}
],
"requestId": "",
"suggestedAction": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"documentationUrl": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"pointer": "<string>"
}
],
"requestId": "",
"suggestedAction": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"documentationUrl": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"pointer": "<string>"
}
],
"requestId": "",
"suggestedAction": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"documentationUrl": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"pointer": "<string>"
}
],
"requestId": "",
"suggestedAction": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"documentationUrl": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"pointer": "<string>"
}
],
"requestId": "",
"suggestedAction": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"documentationUrl": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"pointer": "<string>"
}
],
"requestId": "",
"suggestedAction": "<string>"
}Scoped to the effective subject and the caller’s org; a job belonging to anyone else returns 404 rather than leaking its status.
Every error is an RFC 9457
Authorization
This route requires theread scope.
A missing or invalid credential returns 401 authentication_error. A valid credential without the scope returns 403 permission_denied, and the problem body names the exact scope required.
Headers
These are request conventions the contract does not declare as parameters, so they do not appear in the schema tables below.| Header | Applies | What it does |
|---|---|---|
X-Exo-API-Key | Required | Your Exo API key, exo_<env>_<token>. Authorization: Bearer exo_... is accepted as an alternate. |
X-Exo-Subject | Optional | Acts for a provisioned subject instead of the key owner. An unprovisioned id returns 403 subject_not_provisioned. |
Idempotency-Key | Not applicable | The replay engine covers POST requests only. |
X-Request-Id | Response | Returned on every response, including 204s. Quote it in a support request. |
Success responses
| Status | Meaning |
|---|---|
200 | The job’s status and progress. |
Errors
| Status | Code | When |
|---|---|---|
400 | invalid_request | Malformed request, for example an invalid cursor. |
401 | authentication_error | Missing or invalid credentials. |
403 | permission_denied | Missing scope, or an unprovisioned subject selector. |
404 | not_found | The resource does not exist, or is not visible to this caller. |
409 | conflict | A conflict with the current state of the resource. |
422 | validation_error | The request was understood but failed field validation. |
429 | rate_limit_exceeded | Rate limit exceeded. Retry after the Retry-After interval. |
503 | service_degraded | A dependency is temporarily unavailable. Safe to retry. |
application/problem+json body carrying a stable code, a requestId, and a suggestedAction where Exo has one. See Errors.
Notes
- A job that is not yours is 404, not 403. Status cannot be probed across subjects or organizations.
Authorizations
ApiKeyHeaderBearerAuth
An Exo API key (exo_...) sent as the X-Exo-API-Key header.