Skip to main content
GET
/
api
/
v1
/
jobs
/
List Jobs
curl --request GET \
  --url https://platform.unstructuredapp.io/api/v1/jobs/ \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_name": "<string>",
    "status": "SCHEDULED",
    "created_at": "2023-11-07T05:31:56Z",
    "runtime": "<string>",
    "input_file_ids": [
      "<string>"
    ],
    "output_node_files": [
      {
        "node_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "file_id": "<string>"
      }
    ],
    "job_type": "ephemeral"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
unstructured-api-key
string | null

Query Parameters

​
workflow_id
string<uuid> | null
​
status
string | null

Response

Successful Response

​
id
string<uuid>
required
​
workflow_id
string<uuid>
required
​
workflow_name
string
required
​
status
enum<string>
required
Available options:
SCHEDULED,
IN_PROGRESS,
COMPLETED,
STOPPED,
FAILED
​
created_at
string<date-time>
required
​
runtime
string<duration> | null
​
input_file_ids
string[] | null
​
output_node_files
NodeFileMetadata · object[] | null
​
job_type
enum<string>
Available options:
ephemeral,
persistent,
scheduled,
template