POST
/
api
/
v1
/
workflows
/
Create Workflow
curl --request POST \
  --url https://platform.unstructuredapp.io/api/v1/workflows/ \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "destination_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_type": "basic",
  "workflow_nodes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "type": "<string>",
      "subtype": "<string>",
      "settings": {}
    }
  ],
  "schedule": "every 15 minutes",
  "reprocess_all": true
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "sources": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "destinations": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "workflow_type": "basic",
  "workflow_nodes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "type": "<string>",
      "subtype": "<string>",
      "settings": {}
    }
  ],
  "schedule": {
    "crontab_entries": [
      {
        "cron_expression": "0 0 * * *"
      }
    ]
  },
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "reprocess_all": true
}

Headers

​
unstructured-api-key
string | null

Body

application/json
​
name
string
required
​
workflow_type
enum<string>
required
Available options:
basic,
advanced,
platinum,
custom
​
source_id
string<uuid> | null
​
destination_id
string<uuid> | null
​
workflow_nodes
WorkflowNode · object[] | null
​
schedule
enum<string> | null
Available options:
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
​
reprocess_all
boolean | null
default:false

Response

Successful Response

​
id
string<uuid>
required
​
name
string
required
​
sources
string<uuid>[]
required
​
destinations
string<uuid>[]
required
​
workflow_nodes
WorkflowNode · object[]
required
​
status
enum<string>
required
Available options:
active,
inactive
​
created_at
string<date-time>
required
​
workflow_type
enum<string> | null
Available options:
basic,
advanced,
platinum,
custom
​
schedule
object | null
Examples:
{
  "crontab_entries": [{ "cron_expression": "0 0 * * *" }]
}
​
updated_at
string<date-time> | null
​
reprocess_all
boolean | null