Workflow Endpoint
Jobs
To use the Unstructured Platform Workflow Endpoint to manage jobs, do the following:
- To get a list of available jobs, use the
UnstructuredClient
object’sjobs.list_jobs
function (for the Python SDK) or theGET
method to call the/jobs
endpoint (forcurl
or Postman). Learn more. - To get information about a job, use the
UnstructuredClient
object’sjobs.get_job
function (for the Python SDK) or theGET
method to call the/jobs/<job-id>
endpoint (forcurl
or Postman). Learn more. - A job is created automatically whenever a workflow runs on a schedule; see Create a workflow. A job is also created whenever you run a workflow manually; see Run a workflow.
- To cancel a running job, use the
UnstructuredClient
object’sjobs.cancel_job
function (for the Python SDK) or thePOST
method to call the/jobs/<job-id>/cancel
endpoint (forcurl
or Postman). Learn more.
Was this page helpful?