Job
Create job
Create a new on-demand workflow job using either a template or custom DAG.
POST
An on-demand workflow job is a job that takes one or more local files only as input, and whose temporary workflow exists only for the duration of the job’s runDocumentation Index
Fetch the complete documentation index at: https://docs.unstructured.io/llms.txt
Use this file to discover all available pages before exploring further.
To run a workflow that was already created at some point in the past and still exists (also known as a long-lived workflow), see the run workflow endpoint instead.
To run a workflow that takes files and data from remote locations as input (instead of local files), do the following instead:
- Create a source connector to the remote source locations.
- Create a destination connector to the remote destination location.
- Create a long-lived workflow that uses this specific source connector and destination connector.
- Run this long-lived workflow manually, if you have not already created the workflow to run on a schedule.
Body
Job configuration data.
- To use a workflow template for a job, include a
template_idfield that specifies the unique ID of the workflow template. For more information, see list templates. - To use a custom workflow definition for a job, include a
job_nodesfield that specifies the settings for the job’s workflow nodes. For instructions, see Workflow Nodes.
Input files to process. Upload as multipart/form-data, in the following format:For more information, see Unstructured API Quickstart - On-Demand Jobs.
Response
Unique identifier for the job.
Unique identifier of the workflow that created this job.
Name of the workflow that created this job.
Job status. One of:
SCHEDULED, IN_PROGRESS, COMPLETED, STOPPED, FAILED.ISO 8601 timestamp when the job was created.
ISO 8601 duration of the job run.
IDs of input files for this job.
Output file metadata objects. Each object includes
node_id, file_id, node_type, and node_subtype.Job type. Default:
ephemeral.
