Sign in

v1

latestOpenAPI 3.1.02026-07-1245137133.6 KB
workflows

Create Workflow

Create a new workflow, either custom or auto, and configure its settings.

post/api/v1/workflows/

Headers

unstructured-api-keystring nullable

Request body

namestring required
workflow_type'basic' | 'advanced' | 'platinum' | 'custom' required
template_idstring nullable
schedule'every 15 minutes' | 'every hour' | 'every 2 hours' | 'every 4 hours' | 'every 6 hours' | 'every 8 hours' | 'every 10 hours' | 'every 12 hours' | 'daily' | 'weekly' | 'monthly' nullable
reprocess_allboolean nullable
keystring nullable

Stable workspace level identifier for the workflow. If omitted, derived from name. Immutable once set. 1-63 characters, lowercase alphanumeric and hyphens, no consecutive/leading/trailing hyphens.

Example request

{
  "key": "invoice-processing-v2"
}

Response

Successful Response

idstring uuid required
namestring required
keystring nullable
sourcesstring[] required
destinationsstring[] required
workflow_type'basic' | 'advanced' | 'platinum' | 'custom'
status'active' | 'inactive' required
created_atstring date-time required
updated_atstring date-time nullable
reprocess_allboolean

Example response

{
  "schedule": {
    "crontab_entries": [
      {
        "cron_expression": "0 0 * * *"
      }
    ]
  }
}