curl --request GET \
--url "${UNSTRUCTURED_API_URL}/api/v1/jobs/b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e/failed-files" \
--header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}"
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import GetJobFailedFilesRequest
client = UnstructuredClient(
api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
server_url=os.getenv("UNSTRUCTURED_API_URL"),
)
response = client.jobs.get_job_failed_files(
request=GetJobFailedFilesRequest(
job_id="b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
)
)
print(response)
import asyncio
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import GetJobFailedFilesRequest
async def get_job_failed_files():
client = UnstructuredClient(
api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
server_url=os.getenv("UNSTRUCTURED_API_URL"),
)
response = await client.jobs.get_job_failed_files_async(
request=GetJobFailedFilesRequest(
job_id="b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
)
)
print(response)
asyncio.run(get_job_failed_files())
{
"failed_files": [
{
"document": "s3://my-bucket/input/corrupted-file.pdf",
"error": "Failed to partition document: unexpected end of file"
}
]
}
Job
Get job failed files
Retrieve the list of any failed files for a specific job, and why those files failed.
GET
/
api
/
v1
/
jobs
/
{job_id}
/
failed-files
curl --request GET \
--url "${UNSTRUCTURED_API_URL}/api/v1/jobs/b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e/failed-files" \
--header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}"
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import GetJobFailedFilesRequest
client = UnstructuredClient(
api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
server_url=os.getenv("UNSTRUCTURED_API_URL"),
)
response = client.jobs.get_job_failed_files(
request=GetJobFailedFilesRequest(
job_id="b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
)
)
print(response)
import asyncio
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import GetJobFailedFilesRequest
async def get_job_failed_files():
client = UnstructuredClient(
api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
server_url=os.getenv("UNSTRUCTURED_API_URL"),
)
response = await client.jobs.get_job_failed_files_async(
request=GetJobFailedFilesRequest(
job_id="b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
)
)
print(response)
asyncio.run(get_job_failed_files())
{
"failed_files": [
{
"document": "s3://my-bucket/input/corrupted-file.pdf",
"error": "Failed to partition document: unexpected end of file"
}
]
}
Path parameters
string
required
The unique identifier of the job.
Query parameters
integer
Maximum entries per page, from 1 to 1000. Supply
limit or offset to use pagination.integer
Zero-based page start. Supply
limit or offset to use pagination.Response
array
required
List of failed files. Each object includes
document (the file path or identifier) and error (the failure reason).integer
Number of failure entries before pagination. A file can have an entry for more than one node.
integer
Requested page size when pagination is in use.
integer
Starting offset of this page when pagination is in use.
integer | null
Offset for the next page, or
null after the last available entry.curl --request GET \
--url "${UNSTRUCTURED_API_URL}/api/v1/jobs/b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e/failed-files" \
--header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}"
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import GetJobFailedFilesRequest
client = UnstructuredClient(
api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
server_url=os.getenv("UNSTRUCTURED_API_URL"),
)
response = client.jobs.get_job_failed_files(
request=GetJobFailedFilesRequest(
job_id="b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
)
)
print(response)
import asyncio
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import GetJobFailedFilesRequest
async def get_job_failed_files():
client = UnstructuredClient(
api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
server_url=os.getenv("UNSTRUCTURED_API_URL"),
)
response = await client.jobs.get_job_failed_files_async(
request=GetJobFailedFilesRequest(
job_id="b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
)
)
print(response)
asyncio.run(get_job_failed_files())
{
"failed_files": [
{
"document": "s3://my-bucket/input/corrupted-file.pdf",
"error": "Failed to partition document: unexpected end of file"
}
]
}
Was this page helpful?