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
}
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
}
Path parameters
string
required
The unique identifier of the job.
Response
string
required
Unique identifier for the job.
string
required
Document processing outcome. One of:
SCHEDULED, IN_PROGRESS, SUCCESS, COMPLETED_WITH_ERRORS, STOPPED, FAILED, REJECTED. A completed job can remain IN_PROGRESS briefly while counts settle.array
required
Per-node processing statistics. Each object includes
node_name, node_type, node_subtype, ready, in_progress, success, and failure counts.string
Additional status message, if available.
object
Aggregate document counts:
total_docs, total_docs_succeeded, and total_docs_failed, when available.object
Advisory snapshot of current progress and other active jobs. Use
processing_status for the final outcome.array
IDs of jobs using workspace concurrency slots when this job was queued. This snapshot is not a current list of blockers.
string
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
}
Was this page helpful?