curl --request PUT \
--url "${UNSTRUCTURED_API_URL}/api/v1/workflows/f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c" \
--header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}" \
--header "Content-Type: application/json" \
--data '{
"name": "my-updated-workflow",
"schedule": "weekly"
}'
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import UpdateWorkflowRequest
from unstructured_client.models.shared import UpdateWorkflow
client = UnstructuredClient(
api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
server_url=os.getenv("UNSTRUCTURED_API_URL"),
)
response = client.workflows.update_workflow(
request=UpdateWorkflowRequest(
workflow_id="f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
update_workflow=UpdateWorkflow(
name="my-updated-workflow",
schedule="weekly",
),
)
)
print(response)
import asyncio
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import UpdateWorkflowRequest
from unstructured_client.models.shared import UpdateWorkflow
async def update_workflow():
client = UnstructuredClient(
api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
server_url=os.getenv("UNSTRUCTURED_API_URL"),
)
response = await client.workflows.update_workflow_async(
request=UpdateWorkflowRequest(
workflow_id="f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
update_workflow=UpdateWorkflow(
name="my-updated-workflow",
schedule="weekly",
),
)
)
print(response)
asyncio.run(update_workflow())
{
"id": "f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
"name": "my-updated-workflow",
"key": "my-workflow-a1b2c3",
"workflow_type": "custom",
"status": "active",
"sources": ["7f3e2a1b-4c5d-6e7f-8a9b-0c1d2e3f4a5b"],
"destinations": ["1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"],
"workflow_nodes": [
{
"name": "Partition",
"type": "partition",
"subtype": "vlm",
"settings": {}
}
],
"schedule": {"crontab_entries": [{"cron_expression": "0 0 * * 0"}]},
"reprocess_all": false,
"skip_preflight": false,
"edit_lock": null,
"created_at": "2026-04-29T10:00:00Z",
"updated_at": "2026-04-29T11:00:00Z"
}
Workflow
Update workflow
Update a workflow’s name, connectors, processing nodes, schedule, state, or preflight setting, or apply a workflow template.
PUT
/
api
/
v1
/
workflows
/
{workflow_id}
curl --request PUT \
--url "${UNSTRUCTURED_API_URL}/api/v1/workflows/f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c" \
--header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}" \
--header "Content-Type: application/json" \
--data '{
"name": "my-updated-workflow",
"schedule": "weekly"
}'
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import UpdateWorkflowRequest
from unstructured_client.models.shared import UpdateWorkflow
client = UnstructuredClient(
api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
server_url=os.getenv("UNSTRUCTURED_API_URL"),
)
response = client.workflows.update_workflow(
request=UpdateWorkflowRequest(
workflow_id="f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
update_workflow=UpdateWorkflow(
name="my-updated-workflow",
schedule="weekly",
),
)
)
print(response)
import asyncio
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import UpdateWorkflowRequest
from unstructured_client.models.shared import UpdateWorkflow
async def update_workflow():
client = UnstructuredClient(
api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
server_url=os.getenv("UNSTRUCTURED_API_URL"),
)
response = await client.workflows.update_workflow_async(
request=UpdateWorkflowRequest(
workflow_id="f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
update_workflow=UpdateWorkflow(
name="my-updated-workflow",
schedule="weekly",
),
)
)
print(response)
asyncio.run(update_workflow())
{
"id": "f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
"name": "my-updated-workflow",
"key": "my-workflow-a1b2c3",
"workflow_type": "custom",
"status": "active",
"sources": ["7f3e2a1b-4c5d-6e7f-8a9b-0c1d2e3f4a5b"],
"destinations": ["1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"],
"workflow_nodes": [
{
"name": "Partition",
"type": "partition",
"subtype": "vlm",
"settings": {}
}
],
"schedule": {"crontab_entries": [{"cron_expression": "0 0 * * 0"}]},
"reprocess_all": false,
"skip_preflight": false,
"edit_lock": null,
"created_at": "2026-04-29T10:00:00Z",
"updated_at": "2026-04-29T11:00:00Z"
}
Only workflows that persist until explicitly deleted can be updated. Workflows created for the duration of a single local-file processing job cannot be updated.
Path parameters
Body
Workflow type. Use
custom to configure processing nodes. The other accepted values, basic, advanced, and platinum, are non-operational and will be removed in a future release.Repeating run schedule. Valid values and their cron equivalents:
If omitted, the workflow does not automatically run on a repeating schedule.Workflows with a local source cannot be set to run on a repeating schedule.
| Value | cron | Description |
|---|---|---|
every 15 minutes | */15 * * * * | Every 15 minutes. |
every hour | 0 * * * * | At the first minute of every hour. |
every 2 hours | 0 */2 * * * | At the first minute of every second hour. |
every 4 hours | 0 */4 * * * | At the first minute of every fourth hour. |
every 6 hours | 0 */6 * * * | At the first minute of every sixth hour. |
every 8 hours | 0 */8 * * * | At the first minute of every eighth hour. |
every 10 hours | 0 */10 * * * | At the first minute of every tenth hour. |
every 12 hours | 0 */12 * * * | At the first minute of every twelfth hour. |
daily | 0 0 * * * | At the first minute of every day. |
weekly | 0 0 * * 0 | At the first minute of every Sunday. |
monthly | 0 0 1 * * | At the first minute of the first day of every month. |
Updated processing nodes. Each node requires
name, type, and subtype, and can include an id and settings object.For more information on workflow nodes, see Workflow nodes.Default:
The following table lists the source connectors that support the
Additional considerations to take into account when setting
false. If true, reprocesses all documents in the source location on every run. If false, the workflow excludes from future processing any files Unstructured determines are unchanged since the last time the workflow ran.Unstructured determines if a document has changed based on the document version. For each workflow, Unstructured maintains a record of documents (and their versions, if present) processed by that workflow. Each document record consists of:- A
record_idderived from the document name and path. - A
record_versionderived from either the document Etag (if the source provider generates one) or the source provider’s native version identifier.
reprocess_all to false for a source connector that supports reprocess_all, Unstructured uses this list of records to determine whether or not to process each document:- If the
record_iddoes not exist in the workflow records, Unstructured processes the document. - If the
record_idexists, but therecord_versionhas changed, or there is norecord_version, Unstructured processes the document.
record-id and record_version combinations, and the action Unstructured takes in each case:record_id | record_version | Action |
|---|---|---|
| Exists | Unchanged | Do not process file |
| Exists | Changed | Process file |
| Exists | (none) | Process file |
| New | (Does not apply) | Process file |
Renaming a document results in a new
record_id; Unstructured will then reprocess the renamed document when the workflow runs.reprocess_all setting. The Record version base column specifies the versioning information Unstructured uses to generated the corresponding record version for each processed document.Source connectors that do not support reprocess_all reprocess every document in the source location each time the workflow runs.| Connector | record_version base |
|---|---|
| Amazon S3 | ETag |
| Azure Blob Storage | ETag |
| Box | Provider version ID |
| Dropbox | Provider version ID |
| Elastisearch | Provider version ID |
| Google Cloud Storage | ETag |
| Google Drive | Provider version ID |
| Microsoft OneDrive | Provider version ID |
| Microsoft SharePoint | Provider version ID |
reprocess_all to false:- Unstructured only adds document records for documents that it successfully processes. Documents that failed to process will be reprocessed the next time the workflow is run.
- Because S3 ETags are content-based, changing the metadata on an S3 object will not result in it being reprocessed.
- For source providers that support the S3 protocol, be aware that deleting an object and then reuploading it to the source location will maintain the same
record_id, but may result in a differentrecord_versionbeing generated. This is especially true of multipart uploads. This results in Unstructured reprocessing the document. - For source providers that offer Key Management Services (KMS), be aware that server-side encryption can change document ETags. This results in the the
record_versionof a document changing, and Unstructured reprocessing the document. - If you clone or recreate a source connector, the resulting connector does not include the document processing history of the previous connector.
- Changing a workflow’s configuration does not automatically result in Unstructured reprocessing all documents. For example, changing chunker, embedder, enrichment, or partitioner settings may not result in reprocessing all document. To reprocess all documents using new workflow settings, set
reprocess_alltotruefor at least the next workflow run.
Default:
false. If true, the workflow’s jobs skip the Job Preflight Check. If false, a job whose preflight check reports invalid credentials, denied permissions, or invalid configuration ends as REJECTED before it processes any documents. With the check skipped, that job fails partway through the run and ends as FAILED.Skip the check only if it adds no value for your connectors or model-provider nodes, or its latency is a problem.Omit this field to keep the workflow’s current value.Response
true reprocesses all source documents on every run. With false, supported source connectors can skip unchanged documents. Other connectors still reprocess all documents.true means jobs for this workflow skip the Job Preflight Check. false means jobs run the check (the default).Edit lock details while someone edits the workflow in the console. Updates and deletes by other users return HTTP 423 until the editor saves or the lock expires.
curl --request PUT \
--url "${UNSTRUCTURED_API_URL}/api/v1/workflows/f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c" \
--header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}" \
--header "Content-Type: application/json" \
--data '{
"name": "my-updated-workflow",
"schedule": "weekly"
}'
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import UpdateWorkflowRequest
from unstructured_client.models.shared import UpdateWorkflow
client = UnstructuredClient(
api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
server_url=os.getenv("UNSTRUCTURED_API_URL"),
)
response = client.workflows.update_workflow(
request=UpdateWorkflowRequest(
workflow_id="f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
update_workflow=UpdateWorkflow(
name="my-updated-workflow",
schedule="weekly",
),
)
)
print(response)
import asyncio
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import UpdateWorkflowRequest
from unstructured_client.models.shared import UpdateWorkflow
async def update_workflow():
client = UnstructuredClient(
api_key_auth=os.getenv("UNSTRUCTURED_API_KEY"),
server_url=os.getenv("UNSTRUCTURED_API_URL"),
)
response = await client.workflows.update_workflow_async(
request=UpdateWorkflowRequest(
workflow_id="f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
update_workflow=UpdateWorkflow(
name="my-updated-workflow",
schedule="weekly",
),
)
)
print(response)
asyncio.run(update_workflow())
{
"id": "f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
"name": "my-updated-workflow",
"key": "my-workflow-a1b2c3",
"workflow_type": "custom",
"status": "active",
"sources": ["7f3e2a1b-4c5d-6e7f-8a9b-0c1d2e3f4a5b"],
"destinations": ["1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"],
"workflow_nodes": [
{
"name": "Partition",
"type": "partition",
"subtype": "vlm",
"settings": {}
}
],
"schedule": {"crontab_entries": [{"cron_expression": "0 0 * * 0"}]},
"reprocess_all": false,
"skip_preflight": false,
"edit_lock": null,
"created_at": "2026-04-29T10:00:00Z",
"updated_at": "2026-04-29T11:00:00Z"
}
Was this page helpful?

