jobs

Get Job Failed Files

Changed on

Retrieve failed files for a specific job. Omit paging parameters for the legacy sample response. Supply limit (1-1000) or offset to page through the complete report on upgraded data planes, with pagination metadata; offset alone uses a page size of 500. Pages follow the stored report order. For a stable traversal, wait for the job and its final failure report to finish; reports can change while a job runs. Older data planes may have truncated the stored report, so pagination cannot recover entries missing from that artifact. Call this endpoint at most 60 times per minute for each job and authenticated identity.

get/api/v1/jobs/{job_id}/failed-files

Request

  • Base URL
    https://platform.unstructuredapp.io
  • URL
    https://platform.unstructuredapp.io/api/v1/jobs/{job_id}/failed-files
  • Auth
    none declared

Path parameters

job_idstring uuid required

Query parameters

limitinteger nullable
offsetinteger nullable

Headers

unstructured-api-keystring nullable

Response

Successful Response

totalinteger nullable

Failure entries available in this report, before pagination. Counts file/node pairs, not unique documents. Older data planes may have capped the artifact; this count cannot recover or detect those omitted entries. Reports refresh periodically and at finalization. Present when paging.

limitinteger nullable

Requested page size, when paging.

offsetinteger nullable

Page start, when paging.

next_offsetinteger nullable

Next page start, or null at the end of the available artifact.

Changes

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property // to the response with the status