{ "opencollection": "1.0.0", "info": { "name": "Unstructured Partition channels jobs API", "version": "1.5.58" }, "request": { "auth": { "type": "apikey", "key": "unstructured-api-key", "value": "{{unstructured-api-key}}", "placement": "header" } }, "items": [ { "info": { "name": "jobs", "type": "folder" }, "items": [ { "info": { "name": "List Jobs", "type": "http" }, "http": { "method": "GET", "url": "https://api.unstructuredapp.io/api/v1/jobs/", "headers": [ { "name": "unstructured-api-key", "value": "" } ], "params": [ { "name": "workflow_id", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" } ] }, "docs": "Retrieve a list of jobs with optional filtering by workflow ID or job status." }, { "info": { "name": "Create Job", "type": "http" }, "http": { "method": "POST", "url": "https://api.unstructuredapp.io/api/v1/jobs/", "headers": [ { "name": "unstructured-api-key", "value": "" } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Create a new on-demand job using either a template (with persistent job optimization) or custom DAG." }, { "info": { "name": "Get Job", "type": "http" }, "http": { "method": "GET", "url": "https://api.unstructuredapp.io/api/v1/jobs/:job_id", "headers": [ { "name": "unstructured-api-key", "value": "" } ], "params": [ { "name": "job_id", "value": "", "type": "path" } ] }, "docs": "Retrieve detailed information for a specific job by its ID." }, { "info": { "name": "Cancel Job", "type": "http" }, "http": { "method": "POST", "url": "https://api.unstructuredapp.io/api/v1/jobs/:job_id/cancel", "headers": [ { "name": "unstructured-api-key", "value": "" } ], "params": [ { "name": "job_id", "value": "", "type": "path" } ] }, "docs": "Cancel the specified job." }, { "info": { "name": "Download Job output", "type": "http" }, "http": { "method": "GET", "url": "https://api.unstructuredapp.io/api/v1/jobs/:job_id/download", "headers": [ { "name": "unstructured-api-key", "value": "" } ], "params": [ { "name": "job_id", "value": "", "type": "path" }, { "name": "file_id", "value": "", "type": "query", "description": "ID of the file to download" }, { "name": "node_id", "value": "", "type": "query", "description": "Node ID to retrieve the corresponding output file.If not provided, uses the terminal processing node in the workflow." } ] }, "docs": "Download the output of a job from a workflow where the input file was provided at runtime." }, { "info": { "name": "Get Job processing details", "type": "http" }, "http": { "method": "GET", "url": "https://api.unstructuredapp.io/api/v1/jobs/:job_id/details", "headers": [ { "name": "unstructured-api-key", "value": "" } ], "params": [ { "name": "job_id", "value": "", "type": "path" } ] }, "docs": "Retrieve processing details for a specific job by its ID." }, { "info": { "name": "Get Job Failed Files", "type": "http" }, "http": { "method": "GET", "url": "https://api.unstructuredapp.io/api/v1/jobs/:job_id/failed-files", "headers": [ { "name": "unstructured-api-key", "value": "" } ], "params": [ { "name": "job_id", "value": "", "type": "path" } ] }, "docs": "Retrieve failed files for a specific job by its ID." } ] } ], "bundled": true }