curl --request GET \
--url "${UNSTRUCTURED_API_URL}/api/v1/jobs/b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e/details" \
--header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}"
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import GetJobDetailsRequest
client = UnstructuredClient(
api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
server_url=os.getenv("UNSTRUCTURED_API_URL"),
)
response = client.jobs.get_job_details(
request=GetJobDetailsRequest(
job_id="b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
)
)
print(response)
import asyncio
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import GetJobDetailsRequest
async def get_job_details():
client = UnstructuredClient(
api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
server_url=os.getenv("UNSTRUCTURED_API_URL"),
)
response = await client.jobs.get_job_details_async(
request=GetJobDetailsRequest(
job_id="b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
)
)
print(response)
asyncio.run(get_job_details())
{
"id": "b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
"processing_status": "SUCCESS",
"node_stats": [
{
"node_name": "partition",
"node_type": "partition",
"node_subtype": "auto",
"ready": 0,
"in_progress": 0,
"success": 42,
"failure": 0
}
],
"summary": {
"total_docs": 42,
"total_docs_succeeded": 42,
"total_docs_failed": 0
},
"message": null,
"progress": null,
"queued_behind_job_ids_snapshot": [],
"completion_issue": null
}
{
"id": "b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
"processing_status": "REJECTED",
"node_stats": [
{
"node_name": "S3 Source",
"node_type": "source",
"node_subtype": "s3",
"ready": 0,
"in_progress": 0,
"success": 0,
"failure": 0,
"failure_category": "AUTH_INVALID_CREDENTIAL",
"failure_reason": "[AUTH_INVALID_CREDENTIAL] Connection test failed.\nS3 authentication failed: InvalidAccessKeyId"
},
{
"node_name": "Partitioner",
"node_type": "partition",
"node_subtype": "unstructured_api",
"ready": 0,
"in_progress": 0,
"success": 0,
"failure": 0,
"failure_category": null,
"failure_reason": null
},
{
"node_name": "S3 Destination",
"node_type": "destination",
"node_subtype": "s3",
"ready": 0,
"in_progress": 0,
"success": 0,
"failure": 0,
"failure_category": "AUTH_INVALID_CREDENTIAL",
"failure_reason": "[AUTH_INVALID_CREDENTIAL] Connection test failed.\nS3 authentication failed: InvalidAccessKeyId"
}
],
"summary": {
"total_docs": 0,
"total_docs_succeeded": 0,
"total_docs_failed": 0
},
"message": null,
"completion_issue": null
}
Job
Get job details
Retrieve current processing details for a specific job.
GET
/
api
/
v1
/
jobs
/
{job_id}
/
details
curl --request GET \
--url "${UNSTRUCTURED_API_URL}/api/v1/jobs/b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e/details" \
--header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}"
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import GetJobDetailsRequest
client = UnstructuredClient(
api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
server_url=os.getenv("UNSTRUCTURED_API_URL"),
)
response = client.jobs.get_job_details(
request=GetJobDetailsRequest(
job_id="b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
)
)
print(response)
import asyncio
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import GetJobDetailsRequest
async def get_job_details():
client = UnstructuredClient(
api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
server_url=os.getenv("UNSTRUCTURED_API_URL"),
)
response = await client.jobs.get_job_details_async(
request=GetJobDetailsRequest(
job_id="b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
)
)
print(response)
asyncio.run(get_job_details())
{
"id": "b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
"processing_status": "SUCCESS",
"node_stats": [
{
"node_name": "partition",
"node_type": "partition",
"node_subtype": "auto",
"ready": 0,
"in_progress": 0,
"success": 42,
"failure": 0
}
],
"summary": {
"total_docs": 42,
"total_docs_succeeded": 42,
"total_docs_failed": 0
},
"message": null,
"progress": null,
"queued_behind_job_ids_snapshot": [],
"completion_issue": null
}
{
"id": "b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
"processing_status": "REJECTED",
"node_stats": [
{
"node_name": "S3 Source",
"node_type": "source",
"node_subtype": "s3",
"ready": 0,
"in_progress": 0,
"success": 0,
"failure": 0,
"failure_category": "AUTH_INVALID_CREDENTIAL",
"failure_reason": "[AUTH_INVALID_CREDENTIAL] Connection test failed.\nS3 authentication failed: InvalidAccessKeyId"
},
{
"node_name": "Partitioner",
"node_type": "partition",
"node_subtype": "unstructured_api",
"ready": 0,
"in_progress": 0,
"success": 0,
"failure": 0,
"failure_category": null,
"failure_reason": null
},
{
"node_name": "S3 Destination",
"node_type": "destination",
"node_subtype": "s3",
"ready": 0,
"in_progress": 0,
"success": 0,
"failure": 0,
"failure_category": "AUTH_INVALID_CREDENTIAL",
"failure_reason": "[AUTH_INVALID_CREDENTIAL] Connection test failed.\nS3 authentication failed: InvalidAccessKeyId"
}
],
"summary": {
"total_docs": 0,
"total_docs_succeeded": 0,
"total_docs_failed": 0
},
"message": null,
"completion_issue": null
}
Path parameters
Response
Document processing outcome. One of:
SCHEDULED, IN_PROGRESS, SUCCESS, COMPLETED_WITH_ERRORS, STOPPED, FAILED, REJECTED. A REJECTED job failed the Job Preflight Check and processed no documents. A completed job can remain IN_PROGRESS briefly while counts settle.Per-node processing statistics. Each object includes
node_name, node_type, node_subtype, ready, in_progress, success, and failure counts.For a REJECTED job, each object also reports the result of the Job Preflight Check for that node:failure_category: The stable category of the check failure. Use this value to decide what to do next. Treat a value that is not listed in the following table asUNKNOWN.failure_reason: Human-readable detail about the failure, forwarded from the provider. Show this text to a person. Its format can change, so do not parse it.
null for a node that passed the check.failure_category | Meaning | Rejects the job |
|---|---|---|
AUTH_INVALID_CREDENTIAL | The provider did not accept the credentials. | Yes |
AUTH_PERMISSION_DENIED | The provider accepted the credentials, but they lack permission for the requested resource. | Yes |
CONFIG_INVALID | A connector or node setting is not valid. | Yes |
AUTH_NETWORK_UNREACHABLE | Unstructured could not reach the provider over the network. | No |
AUTH_PROVIDER_UNAVAILABLE | The provider was temporarily unavailable. | No |
PROVIDER_RATE_LIMITED | The provider rate-limited the check. | No |
UNKNOWN | The check failed for a reason that Unstructured could not classify. | No |
Aggregate document counts:
total_docs, total_docs_succeeded, and total_docs_failed, when available.Advisory snapshot of current progress and other active jobs. Use
processing_status for the final outcome.IDs of jobs using workspace concurrency slots when this job was queued. This snapshot is not a current list of blockers.
Reason a completed job delivered no documents, if detected:
NO_DOCUMENTS_DISCOVERED or NO_DOCUMENTS_SUCCEEDED.curl --request GET \
--url "${UNSTRUCTURED_API_URL}/api/v1/jobs/b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e/details" \
--header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}"
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import GetJobDetailsRequest
client = UnstructuredClient(
api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
server_url=os.getenv("UNSTRUCTURED_API_URL"),
)
response = client.jobs.get_job_details(
request=GetJobDetailsRequest(
job_id="b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
)
)
print(response)
import asyncio
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import GetJobDetailsRequest
async def get_job_details():
client = UnstructuredClient(
api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
server_url=os.getenv("UNSTRUCTURED_API_URL"),
)
response = await client.jobs.get_job_details_async(
request=GetJobDetailsRequest(
job_id="b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
)
)
print(response)
asyncio.run(get_job_details())
{
"id": "b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
"processing_status": "SUCCESS",
"node_stats": [
{
"node_name": "partition",
"node_type": "partition",
"node_subtype": "auto",
"ready": 0,
"in_progress": 0,
"success": 42,
"failure": 0
}
],
"summary": {
"total_docs": 42,
"total_docs_succeeded": 42,
"total_docs_failed": 0
},
"message": null,
"progress": null,
"queued_behind_job_ids_snapshot": [],
"completion_issue": null
}
{
"id": "b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
"processing_status": "REJECTED",
"node_stats": [
{
"node_name": "S3 Source",
"node_type": "source",
"node_subtype": "s3",
"ready": 0,
"in_progress": 0,
"success": 0,
"failure": 0,
"failure_category": "AUTH_INVALID_CREDENTIAL",
"failure_reason": "[AUTH_INVALID_CREDENTIAL] Connection test failed.\nS3 authentication failed: InvalidAccessKeyId"
},
{
"node_name": "Partitioner",
"node_type": "partition",
"node_subtype": "unstructured_api",
"ready": 0,
"in_progress": 0,
"success": 0,
"failure": 0,
"failure_category": null,
"failure_reason": null
},
{
"node_name": "S3 Destination",
"node_type": "destination",
"node_subtype": "s3",
"ready": 0,
"in_progress": 0,
"success": 0,
"failure": 0,
"failure_category": "AUTH_INVALID_CREDENTIAL",
"failure_reason": "[AUTH_INVALID_CREDENTIAL] Connection test failed.\nS3 authentication failed: InvalidAccessKeyId"
}
],
"summary": {
"total_docs": 0,
"total_docs_succeeded": 0,
"total_docs_failed": 0
},
"message": null,
"completion_issue": null
}
Was this page helpful?

