Jobs

Manage Unstructured workflow jobs with the Python SDK or REST API. List jobs, monitor processing status, inspect failed files, and cancel running jobs.

A workflow job is created automatically whenever:

• A workflow runs on a schedule. For more details see Create workflow.
• You run a workflow manually. For more details see Run workflow.

To use the Unstructured Pipeline API to manage jobs, do the following:

Task	Python function	curl
Get a list of available jobs	jobs.list_jobs	GET /jobs
Get basic information about a job	jobs.get_job	GET /jobs/<job-id>
Get information about a job’s current processing status	jobs.get_job_details	GET /jobs/<job-id>/details
Get the list of any failed files for a job and why those files failed	jobs.get_failed_files	GET /jobs/<job-id>/failed-files
Run a workflow that takes one or more local files only as input, and the workflow exists only for the duration of that job’s run		POST /jobs/
Cancel a running job	jobs.cancel_job	POST /jobs/<job-id>/cancel

A workflow job is created automatically whenever:

• A workflow runs on a schedule. For more details see Create workflow.
• You run a workflow manually. For more details see Run workflow.

Visit the Unstructured documentation samples repo on GitHub for Postman Collections that demonstrate the API requests discussed in this topic. To import any of these Postman collections:

1. Browse to the postman folder in the repo, and select the collection file you want to import.
2. Click the Raw icon, and then copy the URL for the raw JSON file.
3. In your Postman workspace, click Import, and then paste in the file URL.

To learn about Postman Collections, see Manage and organize Postman Collections in the Postman Docs.