Unstructured API
Workflow Endpoint
Partition Endpoint
- Overview
- POST request
- Python SDK
- JavaScript/TypeScript SDK
- Endpoint parameters
- Endpoint validation errors
- Examples
- Document elements and metadata
- Partitioning strategies
- Chunking strategies
- Speed up processing of large files and batches
- Get element contents
- Extract tables as HTML
- Extract images and tables from documents
- Get chunked elements
- Transform a JSON file into a different schema
- Generate a JSON schema for a file
- Endpoint Playground
Troubleshooting
workflows
Run Workflow
Run a workflow by triggering a new job if none is currently active.
POST
/
api
/
v1
/
workflows
/
{workflow_id}
/
run
Copy
Ask AI
curl --request POST \
--url https://platform.unstructuredapp.io/api/v1/workflows/{workflow_id}/run \
--header 'Content-Type: multipart/form-data' \
--form 'input_files=[
null
]'
Copy
Ask AI
{
"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"
}
Headers
Path Parameters
Body
multipart/form-data
Response
202
application/json
Successful Response
The response is of type object
.
Was this page helpful?
Copy
Ask AI
curl --request POST \
--url https://platform.unstructuredapp.io/api/v1/workflows/{workflow_id}/run \
--header 'Content-Type: multipart/form-data' \
--form 'input_files=[
null
]'
Copy
Ask AI
{
"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"
}
Assistant
Responses are generated using AI and may contain mistakes.