Skip to main content
PUT
/
workflows
/
{workflow_id}
Update Workflow
curl --request PUT \
  --url https://api.example.com/workflows/{workflow_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "nodes": [
    {
      "id": "<string>",
      "type": "<string>",
      "name": "<string>",
      "isStart": false,
      "metadata": {},
      "prompt": "<string>",
      "messagePlan": {
        "firstMessage": "<string>",
        "idleMessages": [
          "<string>"
        ],
        "idleMessageMaxSpokenCount": 123
      },
      "variableExtractionPlan": {
        "output": [
          {
            "title": "<string>",
            "type": "string",
            "enum": [
              "<string>"
            ],
            "description": "<string>"
          }
        ]
      },
      "globalNodePlan": {
        "enabled": true,
        "enterCondition": "<string>"
      },
      "tool": {
        "type": "<string>",
        "tool_key": "<string>",
        "function": {},
        "messages": [
          {}
        ],
        "destinations": [
          "<string>"
        ],
        "parameters": {}
      },
      "tool_instances": [
        {
          "instance_name": "<string>",
          "parameters": {}
        }
      ],
      "config": {}
    }
  ],
  "edges": [
    {
      "from": "<string>",
      "to": "<string>",
      "condition": "always"
    }
  ],
  "global_nodes": [
    "<string>"
  ],
  "status": "<string>"
}
'
import requests

url = "https://api.example.com/workflows/{workflow_id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "nodes": [
        {
            "id": "<string>",
            "type": "<string>",
            "name": "<string>",
            "isStart": False,
            "metadata": {},
            "prompt": "<string>",
            "messagePlan": {
                "firstMessage": "<string>",
                "idleMessages": ["<string>"],
                "idleMessageMaxSpokenCount": 123
            },
            "variableExtractionPlan": { "output": [
                    {
                        "title": "<string>",
                        "type": "string",
                        "enum": ["<string>"],
                        "description": "<string>"
                    }
                ] },
            "globalNodePlan": {
                "enabled": True,
                "enterCondition": "<string>"
            },
            "tool": {
                "type": "<string>",
                "tool_key": "<string>",
                "function": {},
                "messages": [{}],
                "destinations": ["<string>"],
                "parameters": {}
            },
            "tool_instances": [
                {
                    "instance_name": "<string>",
                    "parameters": {}
                }
            ],
            "config": {}
        }
    ],
    "edges": [
        {
            "from": "<string>",
            "to": "<string>",
            "condition": "always"
        }
    ],
    "global_nodes": ["<string>"],
    "status": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    nodes: [
      {
        id: '<string>',
        type: '<string>',
        name: '<string>',
        isStart: false,
        metadata: {},
        prompt: '<string>',
        messagePlan: {
          firstMessage: '<string>',
          idleMessages: ['<string>'],
          idleMessageMaxSpokenCount: 123
        },
        variableExtractionPlan: {
          output: [
            {title: '<string>', type: 'string', enum: ['<string>'], description: '<string>'}
          ]
        },
        globalNodePlan: {enabled: true, enterCondition: '<string>'},
        tool: {
          type: '<string>',
          tool_key: '<string>',
          function: {},
          messages: [{}],
          destinations: ['<string>'],
          parameters: {}
        },
        tool_instances: [{instance_name: '<string>', parameters: {}}],
        config: {}
      }
    ],
    edges: [{from: '<string>', to: '<string>', condition: 'always'}],
    global_nodes: ['<string>'],
    status: '<string>'
  })
};

fetch('https://api.example.com/workflows/{workflow_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/workflows/{workflow_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'nodes' => [
        [
                'id' => '<string>',
                'type' => '<string>',
                'name' => '<string>',
                'isStart' => false,
                'metadata' => [
                                
                ],
                'prompt' => '<string>',
                'messagePlan' => [
                                'firstMessage' => '<string>',
                                'idleMessages' => [
                                                                '<string>'
                                ],
                                'idleMessageMaxSpokenCount' => 123
                ],
                'variableExtractionPlan' => [
                                'output' => [
                                                                [
                                                                                                                                'title' => '<string>',
                                                                                                                                'type' => 'string',
                                                                                                                                'enum' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ],
                                                                                                                                'description' => '<string>'
                                                                ]
                                ]
                ],
                'globalNodePlan' => [
                                'enabled' => true,
                                'enterCondition' => '<string>'
                ],
                'tool' => [
                                'type' => '<string>',
                                'tool_key' => '<string>',
                                'function' => [
                                                                
                                ],
                                'messages' => [
                                                                [
                                                                                                                                
                                                                ]
                                ],
                                'destinations' => [
                                                                '<string>'
                                ],
                                'parameters' => [
                                                                
                                ]
                ],
                'tool_instances' => [
                                [
                                                                'instance_name' => '<string>',
                                                                'parameters' => [
                                                                                                                                
                                                                ]
                                ]
                ],
                'config' => [
                                
                ]
        ]
    ],
    'edges' => [
        [
                'from' => '<string>',
                'to' => '<string>',
                'condition' => 'always'
        ]
    ],
    'global_nodes' => [
        '<string>'
    ],
    'status' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/workflows/{workflow_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"nodes\": [\n    {\n      \"id\": \"<string>\",\n      \"type\": \"<string>\",\n      \"name\": \"<string>\",\n      \"isStart\": false,\n      \"metadata\": {},\n      \"prompt\": \"<string>\",\n      \"messagePlan\": {\n        \"firstMessage\": \"<string>\",\n        \"idleMessages\": [\n          \"<string>\"\n        ],\n        \"idleMessageMaxSpokenCount\": 123\n      },\n      \"variableExtractionPlan\": {\n        \"output\": [\n          {\n            \"title\": \"<string>\",\n            \"type\": \"string\",\n            \"enum\": [\n              \"<string>\"\n            ],\n            \"description\": \"<string>\"\n          }\n        ]\n      },\n      \"globalNodePlan\": {\n        \"enabled\": true,\n        \"enterCondition\": \"<string>\"\n      },\n      \"tool\": {\n        \"type\": \"<string>\",\n        \"tool_key\": \"<string>\",\n        \"function\": {},\n        \"messages\": [\n          {}\n        ],\n        \"destinations\": [\n          \"<string>\"\n        ],\n        \"parameters\": {}\n      },\n      \"tool_instances\": [\n        {\n          \"instance_name\": \"<string>\",\n          \"parameters\": {}\n        }\n      ],\n      \"config\": {}\n    }\n  ],\n  \"edges\": [\n    {\n      \"from\": \"<string>\",\n      \"to\": \"<string>\",\n      \"condition\": \"always\"\n    }\n  ],\n  \"global_nodes\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.example.com/workflows/{workflow_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"nodes\": [\n    {\n      \"id\": \"<string>\",\n      \"type\": \"<string>\",\n      \"name\": \"<string>\",\n      \"isStart\": false,\n      \"metadata\": {},\n      \"prompt\": \"<string>\",\n      \"messagePlan\": {\n        \"firstMessage\": \"<string>\",\n        \"idleMessages\": [\n          \"<string>\"\n        ],\n        \"idleMessageMaxSpokenCount\": 123\n      },\n      \"variableExtractionPlan\": {\n        \"output\": [\n          {\n            \"title\": \"<string>\",\n            \"type\": \"string\",\n            \"enum\": [\n              \"<string>\"\n            ],\n            \"description\": \"<string>\"\n          }\n        ]\n      },\n      \"globalNodePlan\": {\n        \"enabled\": true,\n        \"enterCondition\": \"<string>\"\n      },\n      \"tool\": {\n        \"type\": \"<string>\",\n        \"tool_key\": \"<string>\",\n        \"function\": {},\n        \"messages\": [\n          {}\n        ],\n        \"destinations\": [\n          \"<string>\"\n        ],\n        \"parameters\": {}\n      },\n      \"tool_instances\": [\n        {\n          \"instance_name\": \"<string>\",\n          \"parameters\": {}\n        }\n      ],\n      \"config\": {}\n    }\n  ],\n  \"edges\": [\n    {\n      \"from\": \"<string>\",\n      \"to\": \"<string>\",\n      \"condition\": \"always\"\n    }\n  ],\n  \"global_nodes\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/workflows/{workflow_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"nodes\": [\n    {\n      \"id\": \"<string>\",\n      \"type\": \"<string>\",\n      \"name\": \"<string>\",\n      \"isStart\": false,\n      \"metadata\": {},\n      \"prompt\": \"<string>\",\n      \"messagePlan\": {\n        \"firstMessage\": \"<string>\",\n        \"idleMessages\": [\n          \"<string>\"\n        ],\n        \"idleMessageMaxSpokenCount\": 123\n      },\n      \"variableExtractionPlan\": {\n        \"output\": [\n          {\n            \"title\": \"<string>\",\n            \"type\": \"string\",\n            \"enum\": [\n              \"<string>\"\n            ],\n            \"description\": \"<string>\"\n          }\n        ]\n      },\n      \"globalNodePlan\": {\n        \"enabled\": true,\n        \"enterCondition\": \"<string>\"\n      },\n      \"tool\": {\n        \"type\": \"<string>\",\n        \"tool_key\": \"<string>\",\n        \"function\": {},\n        \"messages\": [\n          {}\n        ],\n        \"destinations\": [\n          \"<string>\"\n        ],\n        \"parameters\": {}\n      },\n      \"tool_instances\": [\n        {\n          \"instance_name\": \"<string>\",\n          \"parameters\": {}\n        }\n      ],\n      \"config\": {}\n    }\n  ],\n  \"edges\": [\n    {\n      \"from\": \"<string>\",\n      \"to\": \"<string>\",\n      \"condition\": \"always\"\n    }\n  ],\n  \"global_nodes\": [\n    \"<string>\"\n  ],\n  \"status\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "nodes": [
    {}
  ],
  "edges": [
    {}
  ],
  "status": "<string>",
  "version": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "global_nodes": [
    "<string>"
  ]
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
workflow_id
string<uuid>
required

Body

application/json

Workflow update model.

​
name
string | null
Required string length: 1 - 255
​
description
string | null
​
nodes
WorkflowNode · object[] | null
​
edges
WorkflowEdge · object[] | null
​
global_nodes
string[] | null
​
status
string | null
Pattern: ^(draft|active|archived)$

Response

Successful Response

Workflow response model.

​
id
string<uuid>
required
​
tenant_id
string<uuid>
required
​
name
string
required
​
nodes
Nodes · object[]
required
​
edges
Edges · object[]
required
​
status
string
required
​
version
integer
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string | null
​
global_nodes
string[] | null