Update Workflow Public
curl --request PATCH \
--url https://api.example.com/v1/workflows/{workflow_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"saved": true,
"definition": {},
"error_handler": {},
"meta": {
"tags": [],
"icon": "<string>",
"log_sync_sheet": {
"name": "<string>",
"id": "<string>",
"time_created": "<string>"
},
"columns": [
{
"name": "<string>",
"visible": true
}
],
"spreadsheet": {
"name": "<string>",
"id": "<string>",
"timestamp": "<string>",
"url": "<string>"
},
"chatflow_settings": {},
"template_id": "<string>",
"variables": [
{}
]
},
"workflow_hash": "<string>",
"is_app_published": true,
"app_settings_v2": {
"is_active": false,
"version_id": "<string>",
"extra_settings": {},
"published_at": "2023-11-07T05:31:56Z"
},
"settings": {
"pii_banner": "",
"pii_info": "",
"pii_lock": false,
"pii_anonimization": [
{
"value": "PERSON",
"label": "Name"
},
{
"value": "EMAIL_ADDRESS",
"label": "Email"
},
{
"value": "PHONE_NUMBER",
"label": "Phone Number"
},
{
"value": "CREDIT_CARD",
"label": "Credit Card"
}
],
"divider1": "",
"guardrail_info": "",
"guardrail_lock": false,
"guardrail_latency_banner": "",
"violence_and_hate": {
"value": "Off",
"context": ""
},
"sexual_content": {
"value": "Off",
"context": ""
},
"guns_and_weapons": {
"value": "Off",
"context": ""
},
"suicide": {
"value": "Off",
"context": ""
},
"crime": {
"value": "Off",
"context": ""
},
"toxicity": {
"value": "Off",
"context": ""
},
"bias": {
"value": "Off",
"context": ""
},
"profanity": {
"value": "Off",
"context": ""
},
"guardrails_scan_output": false,
"guardrails_output_mode": "post_stream",
"divider2": "",
"guardrail_action": {
"value": "fail",
"label": "Fail/block run"
},
"guardrail_action_replace": "",
"guardrail_action_human": "",
"block_after_violations": 0,
"block_message": "This conversation has been locked due to repeated safety violations. Please start a new conversation.",
"divider3": "",
"prompt_defense": "",
"prompt_lock": false,
"jailbreak": false,
"prompt_injection": false,
"context_leak": false,
"auto_model_pick": false,
"auto_model_preference": "cost",
"model": [
"preset:cost"
],
"parameter_preset": "default",
"intro": "",
"basic_params_section": "",
"max_tokens": 64000,
"temperature": 0.7,
"top_p": 1,
"top_k": 40,
"timeout": 120,
"divider_7": "",
"penalty_section": "",
"presence_penalty": 0.3,
"frequency_penalty": 0.6,
"stop_sequences": [],
"divider_8": "",
"reasoning_section": "",
"enable_reasoning": true,
"reasoning_effort": "Low",
"divider": "",
"reliability_section": "",
"max_retries_per_model": 3,
"retry_on_status_codes": [
429,
500,
502,
503,
504
],
"datacenter_fallback": true,
"exclude_user_identity_from_prompt": false,
"enable_prompt_caching": true,
"protect_instructions_in_preview": false,
"agentflow_enabled": true,
"usage_limits_section": "",
"usage_limits_maximum_request": 1000,
"usage_limits_maximum_tokens": 2000000,
"usage_limits_max_messages": 100,
"usage_limits_agent_timeout": 120,
"divider_11": "",
"compaction_enabled": true,
"compaction_strategy": "auto",
"compaction_threshold": 0.75,
"compaction_tool_enabled": false,
"tool_calling_section": "",
"parallel_tool_calls": true,
"tool_timeout": 15,
"agent_flow_id": "<string>",
"is_coworker": true,
"preset_selector": "<string>",
"introductory_message": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"persona": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"tone": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"extra_instructions": {},
"tools": [],
"mcp_servers": [],
"skills_enabled": true,
"convert_unsupported_files_to_text": true,
"skills": [],
"subagents_enabled": false,
"subagents": [],
"subagents_instructions": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"subagents_model": [
"preset:cost"
],
"guidelines_enabled": false,
"guidelines": [],
"glossary": [],
"memories": [],
"hidden_tools": [
"todos_read_todos",
"todos_add_todo",
"todos_write_todos",
"todos_update_todo_status",
"todos_remove_todo"
]
}
}
'import requests
url = "https://api.example.com/v1/workflows/{workflow_id}"
payload = {
"name": "<string>",
"description": "<string>",
"saved": True,
"definition": {},
"error_handler": {},
"meta": {
"tags": [],
"icon": "<string>",
"log_sync_sheet": {
"name": "<string>",
"id": "<string>",
"time_created": "<string>"
},
"columns": [
{
"name": "<string>",
"visible": True
}
],
"spreadsheet": {
"name": "<string>",
"id": "<string>",
"timestamp": "<string>",
"url": "<string>"
},
"chatflow_settings": {},
"template_id": "<string>",
"variables": [{}]
},
"workflow_hash": "<string>",
"is_app_published": True,
"app_settings_v2": {
"is_active": False,
"version_id": "<string>",
"extra_settings": {},
"published_at": "2023-11-07T05:31:56Z"
},
"settings": {
"pii_banner": "",
"pii_info": "",
"pii_lock": False,
"pii_anonimization": [
{
"value": "PERSON",
"label": "Name"
},
{
"value": "EMAIL_ADDRESS",
"label": "Email"
},
{
"value": "PHONE_NUMBER",
"label": "Phone Number"
},
{
"value": "CREDIT_CARD",
"label": "Credit Card"
}
],
"divider1": "",
"guardrail_info": "",
"guardrail_lock": False,
"guardrail_latency_banner": "",
"violence_and_hate": {
"value": "Off",
"context": ""
},
"sexual_content": {
"value": "Off",
"context": ""
},
"guns_and_weapons": {
"value": "Off",
"context": ""
},
"suicide": {
"value": "Off",
"context": ""
},
"crime": {
"value": "Off",
"context": ""
},
"toxicity": {
"value": "Off",
"context": ""
},
"bias": {
"value": "Off",
"context": ""
},
"profanity": {
"value": "Off",
"context": ""
},
"guardrails_scan_output": False,
"guardrails_output_mode": "post_stream",
"divider2": "",
"guardrail_action": {
"value": "fail",
"label": "Fail/block run"
},
"guardrail_action_replace": "",
"guardrail_action_human": "",
"block_after_violations": 0,
"block_message": "This conversation has been locked due to repeated safety violations. Please start a new conversation.",
"divider3": "",
"prompt_defense": "",
"prompt_lock": False,
"jailbreak": False,
"prompt_injection": False,
"context_leak": False,
"auto_model_pick": False,
"auto_model_preference": "cost",
"model": ["preset:cost"],
"parameter_preset": "default",
"intro": "",
"basic_params_section": "",
"max_tokens": 64000,
"temperature": 0.7,
"top_p": 1,
"top_k": 40,
"timeout": 120,
"divider_7": "",
"penalty_section": "",
"presence_penalty": 0.3,
"frequency_penalty": 0.6,
"stop_sequences": [],
"divider_8": "",
"reasoning_section": "",
"enable_reasoning": True,
"reasoning_effort": "Low",
"divider": "",
"reliability_section": "",
"max_retries_per_model": 3,
"retry_on_status_codes": [429, 500, 502, 503, 504],
"datacenter_fallback": True,
"exclude_user_identity_from_prompt": False,
"enable_prompt_caching": True,
"protect_instructions_in_preview": False,
"agentflow_enabled": True,
"usage_limits_section": "",
"usage_limits_maximum_request": 1000,
"usage_limits_maximum_tokens": 2000000,
"usage_limits_max_messages": 100,
"usage_limits_agent_timeout": 120,
"divider_11": "",
"compaction_enabled": True,
"compaction_strategy": "auto",
"compaction_threshold": 0.75,
"compaction_tool_enabled": False,
"tool_calling_section": "",
"parallel_tool_calls": True,
"tool_timeout": 15,
"agent_flow_id": "<string>",
"is_coworker": True,
"preset_selector": "<string>",
"introductory_message": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"persona": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"tone": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"extra_instructions": {},
"tools": [],
"mcp_servers": [],
"skills_enabled": True,
"convert_unsupported_files_to_text": True,
"skills": [],
"subagents_enabled": False,
"subagents": [],
"subagents_instructions": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"subagents_model": ["preset:cost"],
"guidelines_enabled": False,
"guidelines": [],
"glossary": [],
"memories": [],
"hidden_tools": ["todos_read_todos", "todos_add_todo", "todos_write_todos", "todos_update_todo_status", "todos_remove_todo"]
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
saved: true,
definition: {},
error_handler: {},
meta: {
tags: [],
icon: '<string>',
log_sync_sheet: {name: '<string>', id: '<string>', time_created: '<string>'},
columns: [{name: '<string>', visible: true}],
spreadsheet: {name: '<string>', id: '<string>', timestamp: '<string>', url: '<string>'},
chatflow_settings: {},
template_id: '<string>',
variables: [{}]
},
workflow_hash: '<string>',
is_app_published: true,
app_settings_v2: {
is_active: false,
version_id: '<string>',
extra_settings: {},
published_at: '2023-11-07T05:31:56Z'
},
settings: {
pii_banner: '',
pii_info: '',
pii_lock: false,
pii_anonimization: [
{value: 'PERSON', label: 'Name'},
{value: 'EMAIL_ADDRESS', label: 'Email'},
{value: 'PHONE_NUMBER', label: 'Phone Number'},
{value: 'CREDIT_CARD', label: 'Credit Card'}
],
divider1: '',
guardrail_info: '',
guardrail_lock: false,
guardrail_latency_banner: '',
violence_and_hate: {value: 'Off', context: ''},
sexual_content: {value: 'Off', context: ''},
guns_and_weapons: {value: 'Off', context: ''},
suicide: {value: 'Off', context: ''},
crime: {value: 'Off', context: ''},
toxicity: {value: 'Off', context: ''},
bias: {value: 'Off', context: ''},
profanity: {value: 'Off', context: ''},
guardrails_scan_output: false,
guardrails_output_mode: 'post_stream',
divider2: '',
guardrail_action: {value: 'fail', label: 'Fail/block run'},
guardrail_action_replace: '',
guardrail_action_human: '',
block_after_violations: 0,
block_message: 'This conversation has been locked due to repeated safety violations. Please start a new conversation.',
divider3: '',
prompt_defense: '',
prompt_lock: false,
jailbreak: false,
prompt_injection: false,
context_leak: false,
auto_model_pick: false,
auto_model_preference: 'cost',
model: ['preset:cost'],
parameter_preset: 'default',
intro: '',
basic_params_section: '',
max_tokens: 64000,
temperature: 0.7,
top_p: 1,
top_k: 40,
timeout: 120,
divider_7: '',
penalty_section: '',
presence_penalty: 0.3,
frequency_penalty: 0.6,
stop_sequences: [],
divider_8: '',
reasoning_section: '',
enable_reasoning: true,
reasoning_effort: 'Low',
divider: '',
reliability_section: '',
max_retries_per_model: 3,
retry_on_status_codes: [429, 500, 502, 503, 504],
datacenter_fallback: true,
exclude_user_identity_from_prompt: false,
enable_prompt_caching: true,
protect_instructions_in_preview: false,
agentflow_enabled: true,
usage_limits_section: '',
usage_limits_maximum_request: 1000,
usage_limits_maximum_tokens: 2000000,
usage_limits_max_messages: 100,
usage_limits_agent_timeout: 120,
divider_11: '',
compaction_enabled: true,
compaction_strategy: 'auto',
compaction_threshold: 0.75,
compaction_tool_enabled: false,
tool_calling_section: '',
parallel_tool_calls: true,
tool_timeout: 15,
agent_flow_id: '<string>',
is_coworker: true,
preset_selector: '<string>',
introductory_message: [{text: '<string>', definition: {type: 'doc', content: []}}],
persona: [{text: '<string>', definition: {type: 'doc', content: []}}],
tone: [{text: '<string>', definition: {type: 'doc', content: []}}],
extra_instructions: {},
tools: [],
mcp_servers: [],
skills_enabled: true,
convert_unsupported_files_to_text: true,
skills: [],
subagents_enabled: false,
subagents: [],
subagents_instructions: [{text: '<string>', definition: {type: 'doc', content: []}}],
subagents_model: ['preset:cost'],
guidelines_enabled: false,
guidelines: [],
glossary: [],
memories: [],
hidden_tools: [
'todos_read_todos',
'todos_add_todo',
'todos_write_todos',
'todos_update_todo_status',
'todos_remove_todo'
]
}
})
};
fetch('https://api.example.com/v1/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/v1/workflows/{workflow_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'saved' => true,
'definition' => [
],
'error_handler' => [
],
'meta' => [
'tags' => [
],
'icon' => '<string>',
'log_sync_sheet' => [
'name' => '<string>',
'id' => '<string>',
'time_created' => '<string>'
],
'columns' => [
[
'name' => '<string>',
'visible' => true
]
],
'spreadsheet' => [
'name' => '<string>',
'id' => '<string>',
'timestamp' => '<string>',
'url' => '<string>'
],
'chatflow_settings' => [
],
'template_id' => '<string>',
'variables' => [
[
]
]
],
'workflow_hash' => '<string>',
'is_app_published' => true,
'app_settings_v2' => [
'is_active' => false,
'version_id' => '<string>',
'extra_settings' => [
],
'published_at' => '2023-11-07T05:31:56Z'
],
'settings' => [
'pii_banner' => '',
'pii_info' => '',
'pii_lock' => false,
'pii_anonimization' => [
[
'value' => 'PERSON',
'label' => 'Name'
],
[
'value' => 'EMAIL_ADDRESS',
'label' => 'Email'
],
[
'value' => 'PHONE_NUMBER',
'label' => 'Phone Number'
],
[
'value' => 'CREDIT_CARD',
'label' => 'Credit Card'
]
],
'divider1' => '',
'guardrail_info' => '',
'guardrail_lock' => false,
'guardrail_latency_banner' => '',
'violence_and_hate' => [
'value' => 'Off',
'context' => ''
],
'sexual_content' => [
'value' => 'Off',
'context' => ''
],
'guns_and_weapons' => [
'value' => 'Off',
'context' => ''
],
'suicide' => [
'value' => 'Off',
'context' => ''
],
'crime' => [
'value' => 'Off',
'context' => ''
],
'toxicity' => [
'value' => 'Off',
'context' => ''
],
'bias' => [
'value' => 'Off',
'context' => ''
],
'profanity' => [
'value' => 'Off',
'context' => ''
],
'guardrails_scan_output' => false,
'guardrails_output_mode' => 'post_stream',
'divider2' => '',
'guardrail_action' => [
'value' => 'fail',
'label' => 'Fail/block run'
],
'guardrail_action_replace' => '',
'guardrail_action_human' => '',
'block_after_violations' => 0,
'block_message' => 'This conversation has been locked due to repeated safety violations. Please start a new conversation.',
'divider3' => '',
'prompt_defense' => '',
'prompt_lock' => false,
'jailbreak' => false,
'prompt_injection' => false,
'context_leak' => false,
'auto_model_pick' => false,
'auto_model_preference' => 'cost',
'model' => [
'preset:cost'
],
'parameter_preset' => 'default',
'intro' => '',
'basic_params_section' => '',
'max_tokens' => 64000,
'temperature' => 0.7,
'top_p' => 1,
'top_k' => 40,
'timeout' => 120,
'divider_7' => '',
'penalty_section' => '',
'presence_penalty' => 0.3,
'frequency_penalty' => 0.6,
'stop_sequences' => [
],
'divider_8' => '',
'reasoning_section' => '',
'enable_reasoning' => true,
'reasoning_effort' => 'Low',
'divider' => '',
'reliability_section' => '',
'max_retries_per_model' => 3,
'retry_on_status_codes' => [
429,
500,
502,
503,
504
],
'datacenter_fallback' => true,
'exclude_user_identity_from_prompt' => false,
'enable_prompt_caching' => true,
'protect_instructions_in_preview' => false,
'agentflow_enabled' => true,
'usage_limits_section' => '',
'usage_limits_maximum_request' => 1000,
'usage_limits_maximum_tokens' => 2000000,
'usage_limits_max_messages' => 100,
'usage_limits_agent_timeout' => 120,
'divider_11' => '',
'compaction_enabled' => true,
'compaction_strategy' => 'auto',
'compaction_threshold' => 0.75,
'compaction_tool_enabled' => false,
'tool_calling_section' => '',
'parallel_tool_calls' => true,
'tool_timeout' => 15,
'agent_flow_id' => '<string>',
'is_coworker' => true,
'preset_selector' => '<string>',
'introductory_message' => [
[
'text' => '<string>',
'definition' => [
'type' => 'doc',
'content' => [
]
]
]
],
'persona' => [
[
'text' => '<string>',
'definition' => [
'type' => 'doc',
'content' => [
]
]
]
],
'tone' => [
[
'text' => '<string>',
'definition' => [
'type' => 'doc',
'content' => [
]
]
]
],
'extra_instructions' => [
],
'tools' => [
],
'mcp_servers' => [
],
'skills_enabled' => true,
'convert_unsupported_files_to_text' => true,
'skills' => [
],
'subagents_enabled' => false,
'subagents' => [
],
'subagents_instructions' => [
[
'text' => '<string>',
'definition' => [
'type' => 'doc',
'content' => [
]
]
]
],
'subagents_model' => [
'preset:cost'
],
'guidelines_enabled' => false,
'guidelines' => [
],
'glossary' => [
],
'memories' => [
],
'hidden_tools' => [
'todos_read_todos',
'todos_add_todo',
'todos_write_todos',
'todos_update_todo_status',
'todos_remove_todo'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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/v1/workflows/{workflow_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"saved\": true,\n \"definition\": {},\n \"error_handler\": {},\n \"meta\": {\n \"tags\": [],\n \"icon\": \"<string>\",\n \"log_sync_sheet\": {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"time_created\": \"<string>\"\n },\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"visible\": true\n }\n ],\n \"spreadsheet\": {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"timestamp\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"chatflow_settings\": {},\n \"template_id\": \"<string>\",\n \"variables\": [\n {}\n ]\n },\n \"workflow_hash\": \"<string>\",\n \"is_app_published\": true,\n \"app_settings_v2\": {\n \"is_active\": false,\n \"version_id\": \"<string>\",\n \"extra_settings\": {},\n \"published_at\": \"2023-11-07T05:31:56Z\"\n },\n \"settings\": {\n \"pii_banner\": \"\",\n \"pii_info\": \"\",\n \"pii_lock\": false,\n \"pii_anonimization\": [\n {\n \"value\": \"PERSON\",\n \"label\": \"Name\"\n },\n {\n \"value\": \"EMAIL_ADDRESS\",\n \"label\": \"Email\"\n },\n {\n \"value\": \"PHONE_NUMBER\",\n \"label\": \"Phone Number\"\n },\n {\n \"value\": \"CREDIT_CARD\",\n \"label\": \"Credit Card\"\n }\n ],\n \"divider1\": \"\",\n \"guardrail_info\": \"\",\n \"guardrail_lock\": false,\n \"guardrail_latency_banner\": \"\",\n \"violence_and_hate\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"sexual_content\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guns_and_weapons\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"suicide\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"crime\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"toxicity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"bias\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"profanity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guardrails_scan_output\": false,\n \"guardrails_output_mode\": \"post_stream\",\n \"divider2\": \"\",\n \"guardrail_action\": {\n \"value\": \"fail\",\n \"label\": \"Fail/block run\"\n },\n \"guardrail_action_replace\": \"\",\n \"guardrail_action_human\": \"\",\n \"block_after_violations\": 0,\n \"block_message\": \"This conversation has been locked due to repeated safety violations. Please start a new conversation.\",\n \"divider3\": \"\",\n \"prompt_defense\": \"\",\n \"prompt_lock\": false,\n \"jailbreak\": false,\n \"prompt_injection\": false,\n \"context_leak\": false,\n \"auto_model_pick\": false,\n \"auto_model_preference\": \"cost\",\n \"model\": [\n \"preset:cost\"\n ],\n \"parameter_preset\": \"default\",\n \"intro\": \"\",\n \"basic_params_section\": \"\",\n \"max_tokens\": 64000,\n \"temperature\": 0.7,\n \"top_p\": 1,\n \"top_k\": 40,\n \"timeout\": 120,\n \"divider_7\": \"\",\n \"penalty_section\": \"\",\n \"presence_penalty\": 0.3,\n \"frequency_penalty\": 0.6,\n \"stop_sequences\": [],\n \"divider_8\": \"\",\n \"reasoning_section\": \"\",\n \"enable_reasoning\": true,\n \"reasoning_effort\": \"Low\",\n \"divider\": \"\",\n \"reliability_section\": \"\",\n \"max_retries_per_model\": 3,\n \"retry_on_status_codes\": [\n 429,\n 500,\n 502,\n 503,\n 504\n ],\n \"datacenter_fallback\": true,\n \"exclude_user_identity_from_prompt\": false,\n \"enable_prompt_caching\": true,\n \"protect_instructions_in_preview\": false,\n \"agentflow_enabled\": true,\n \"usage_limits_section\": \"\",\n \"usage_limits_maximum_request\": 1000,\n \"usage_limits_maximum_tokens\": 2000000,\n \"usage_limits_max_messages\": 100,\n \"usage_limits_agent_timeout\": 120,\n \"divider_11\": \"\",\n \"compaction_enabled\": true,\n \"compaction_strategy\": \"auto\",\n \"compaction_threshold\": 0.75,\n \"compaction_tool_enabled\": false,\n \"tool_calling_section\": \"\",\n \"parallel_tool_calls\": true,\n \"tool_timeout\": 15,\n \"agent_flow_id\": \"<string>\",\n \"is_coworker\": true,\n \"preset_selector\": \"<string>\",\n \"introductory_message\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"persona\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"tone\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"extra_instructions\": {},\n \"tools\": [],\n \"mcp_servers\": [],\n \"skills_enabled\": true,\n \"convert_unsupported_files_to_text\": true,\n \"skills\": [],\n \"subagents_enabled\": false,\n \"subagents\": [],\n \"subagents_instructions\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"subagents_model\": [\n \"preset:cost\"\n ],\n \"guidelines_enabled\": false,\n \"guidelines\": [],\n \"glossary\": [],\n \"memories\": [],\n \"hidden_tools\": [\n \"todos_read_todos\",\n \"todos_add_todo\",\n \"todos_write_todos\",\n \"todos_update_todo_status\",\n \"todos_remove_todo\"\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.patch("https://api.example.com/v1/workflows/{workflow_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"saved\": true,\n \"definition\": {},\n \"error_handler\": {},\n \"meta\": {\n \"tags\": [],\n \"icon\": \"<string>\",\n \"log_sync_sheet\": {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"time_created\": \"<string>\"\n },\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"visible\": true\n }\n ],\n \"spreadsheet\": {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"timestamp\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"chatflow_settings\": {},\n \"template_id\": \"<string>\",\n \"variables\": [\n {}\n ]\n },\n \"workflow_hash\": \"<string>\",\n \"is_app_published\": true,\n \"app_settings_v2\": {\n \"is_active\": false,\n \"version_id\": \"<string>\",\n \"extra_settings\": {},\n \"published_at\": \"2023-11-07T05:31:56Z\"\n },\n \"settings\": {\n \"pii_banner\": \"\",\n \"pii_info\": \"\",\n \"pii_lock\": false,\n \"pii_anonimization\": [\n {\n \"value\": \"PERSON\",\n \"label\": \"Name\"\n },\n {\n \"value\": \"EMAIL_ADDRESS\",\n \"label\": \"Email\"\n },\n {\n \"value\": \"PHONE_NUMBER\",\n \"label\": \"Phone Number\"\n },\n {\n \"value\": \"CREDIT_CARD\",\n \"label\": \"Credit Card\"\n }\n ],\n \"divider1\": \"\",\n \"guardrail_info\": \"\",\n \"guardrail_lock\": false,\n \"guardrail_latency_banner\": \"\",\n \"violence_and_hate\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"sexual_content\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guns_and_weapons\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"suicide\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"crime\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"toxicity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"bias\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"profanity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guardrails_scan_output\": false,\n \"guardrails_output_mode\": \"post_stream\",\n \"divider2\": \"\",\n \"guardrail_action\": {\n \"value\": \"fail\",\n \"label\": \"Fail/block run\"\n },\n \"guardrail_action_replace\": \"\",\n \"guardrail_action_human\": \"\",\n \"block_after_violations\": 0,\n \"block_message\": \"This conversation has been locked due to repeated safety violations. Please start a new conversation.\",\n \"divider3\": \"\",\n \"prompt_defense\": \"\",\n \"prompt_lock\": false,\n \"jailbreak\": false,\n \"prompt_injection\": false,\n \"context_leak\": false,\n \"auto_model_pick\": false,\n \"auto_model_preference\": \"cost\",\n \"model\": [\n \"preset:cost\"\n ],\n \"parameter_preset\": \"default\",\n \"intro\": \"\",\n \"basic_params_section\": \"\",\n \"max_tokens\": 64000,\n \"temperature\": 0.7,\n \"top_p\": 1,\n \"top_k\": 40,\n \"timeout\": 120,\n \"divider_7\": \"\",\n \"penalty_section\": \"\",\n \"presence_penalty\": 0.3,\n \"frequency_penalty\": 0.6,\n \"stop_sequences\": [],\n \"divider_8\": \"\",\n \"reasoning_section\": \"\",\n \"enable_reasoning\": true,\n \"reasoning_effort\": \"Low\",\n \"divider\": \"\",\n \"reliability_section\": \"\",\n \"max_retries_per_model\": 3,\n \"retry_on_status_codes\": [\n 429,\n 500,\n 502,\n 503,\n 504\n ],\n \"datacenter_fallback\": true,\n \"exclude_user_identity_from_prompt\": false,\n \"enable_prompt_caching\": true,\n \"protect_instructions_in_preview\": false,\n \"agentflow_enabled\": true,\n \"usage_limits_section\": \"\",\n \"usage_limits_maximum_request\": 1000,\n \"usage_limits_maximum_tokens\": 2000000,\n \"usage_limits_max_messages\": 100,\n \"usage_limits_agent_timeout\": 120,\n \"divider_11\": \"\",\n \"compaction_enabled\": true,\n \"compaction_strategy\": \"auto\",\n \"compaction_threshold\": 0.75,\n \"compaction_tool_enabled\": false,\n \"tool_calling_section\": \"\",\n \"parallel_tool_calls\": true,\n \"tool_timeout\": 15,\n \"agent_flow_id\": \"<string>\",\n \"is_coworker\": true,\n \"preset_selector\": \"<string>\",\n \"introductory_message\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"persona\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"tone\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"extra_instructions\": {},\n \"tools\": [],\n \"mcp_servers\": [],\n \"skills_enabled\": true,\n \"convert_unsupported_files_to_text\": true,\n \"skills\": [],\n \"subagents_enabled\": false,\n \"subagents\": [],\n \"subagents_instructions\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"subagents_model\": [\n \"preset:cost\"\n ],\n \"guidelines_enabled\": false,\n \"guidelines\": [],\n \"glossary\": [],\n \"memories\": [],\n \"hidden_tools\": [\n \"todos_read_todos\",\n \"todos_add_todo\",\n \"todos_write_todos\",\n \"todos_update_todo_status\",\n \"todos_remove_todo\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/workflows/{workflow_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"saved\": true,\n \"definition\": {},\n \"error_handler\": {},\n \"meta\": {\n \"tags\": [],\n \"icon\": \"<string>\",\n \"log_sync_sheet\": {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"time_created\": \"<string>\"\n },\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"visible\": true\n }\n ],\n \"spreadsheet\": {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"timestamp\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"chatflow_settings\": {},\n \"template_id\": \"<string>\",\n \"variables\": [\n {}\n ]\n },\n \"workflow_hash\": \"<string>\",\n \"is_app_published\": true,\n \"app_settings_v2\": {\n \"is_active\": false,\n \"version_id\": \"<string>\",\n \"extra_settings\": {},\n \"published_at\": \"2023-11-07T05:31:56Z\"\n },\n \"settings\": {\n \"pii_banner\": \"\",\n \"pii_info\": \"\",\n \"pii_lock\": false,\n \"pii_anonimization\": [\n {\n \"value\": \"PERSON\",\n \"label\": \"Name\"\n },\n {\n \"value\": \"EMAIL_ADDRESS\",\n \"label\": \"Email\"\n },\n {\n \"value\": \"PHONE_NUMBER\",\n \"label\": \"Phone Number\"\n },\n {\n \"value\": \"CREDIT_CARD\",\n \"label\": \"Credit Card\"\n }\n ],\n \"divider1\": \"\",\n \"guardrail_info\": \"\",\n \"guardrail_lock\": false,\n \"guardrail_latency_banner\": \"\",\n \"violence_and_hate\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"sexual_content\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guns_and_weapons\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"suicide\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"crime\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"toxicity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"bias\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"profanity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guardrails_scan_output\": false,\n \"guardrails_output_mode\": \"post_stream\",\n \"divider2\": \"\",\n \"guardrail_action\": {\n \"value\": \"fail\",\n \"label\": \"Fail/block run\"\n },\n \"guardrail_action_replace\": \"\",\n \"guardrail_action_human\": \"\",\n \"block_after_violations\": 0,\n \"block_message\": \"This conversation has been locked due to repeated safety violations. Please start a new conversation.\",\n \"divider3\": \"\",\n \"prompt_defense\": \"\",\n \"prompt_lock\": false,\n \"jailbreak\": false,\n \"prompt_injection\": false,\n \"context_leak\": false,\n \"auto_model_pick\": false,\n \"auto_model_preference\": \"cost\",\n \"model\": [\n \"preset:cost\"\n ],\n \"parameter_preset\": \"default\",\n \"intro\": \"\",\n \"basic_params_section\": \"\",\n \"max_tokens\": 64000,\n \"temperature\": 0.7,\n \"top_p\": 1,\n \"top_k\": 40,\n \"timeout\": 120,\n \"divider_7\": \"\",\n \"penalty_section\": \"\",\n \"presence_penalty\": 0.3,\n \"frequency_penalty\": 0.6,\n \"stop_sequences\": [],\n \"divider_8\": \"\",\n \"reasoning_section\": \"\",\n \"enable_reasoning\": true,\n \"reasoning_effort\": \"Low\",\n \"divider\": \"\",\n \"reliability_section\": \"\",\n \"max_retries_per_model\": 3,\n \"retry_on_status_codes\": [\n 429,\n 500,\n 502,\n 503,\n 504\n ],\n \"datacenter_fallback\": true,\n \"exclude_user_identity_from_prompt\": false,\n \"enable_prompt_caching\": true,\n \"protect_instructions_in_preview\": false,\n \"agentflow_enabled\": true,\n \"usage_limits_section\": \"\",\n \"usage_limits_maximum_request\": 1000,\n \"usage_limits_maximum_tokens\": 2000000,\n \"usage_limits_max_messages\": 100,\n \"usage_limits_agent_timeout\": 120,\n \"divider_11\": \"\",\n \"compaction_enabled\": true,\n \"compaction_strategy\": \"auto\",\n \"compaction_threshold\": 0.75,\n \"compaction_tool_enabled\": false,\n \"tool_calling_section\": \"\",\n \"parallel_tool_calls\": true,\n \"tool_timeout\": 15,\n \"agent_flow_id\": \"<string>\",\n \"is_coworker\": true,\n \"preset_selector\": \"<string>\",\n \"introductory_message\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"persona\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"tone\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"extra_instructions\": {},\n \"tools\": [],\n \"mcp_servers\": [],\n \"skills_enabled\": true,\n \"convert_unsupported_files_to_text\": true,\n \"skills\": [],\n \"subagents_enabled\": false,\n \"subagents\": [],\n \"subagents_instructions\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"subagents_model\": [\n \"preset:cost\"\n ],\n \"guidelines_enabled\": false,\n \"guidelines\": [],\n \"glossary\": [],\n \"memories\": [],\n \"hidden_tools\": [\n \"todos_read_todos\",\n \"todos_add_todo\",\n \"todos_write_todos\",\n \"todos_update_todo_status\",\n \"todos_remove_todo\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"definition": {},
"workflow_hash": "<string>",
"meta": {
"tags": [],
"icon": "<string>",
"log_sync_sheet": {
"name": "<string>",
"id": "<string>",
"time_created": "<string>"
},
"columns": [
{
"name": "<string>",
"visible": true
}
],
"spreadsheet": {
"name": "<string>",
"id": "<string>",
"timestamp": "<string>",
"url": "<string>"
},
"chatflow_settings": {},
"template_id": "<string>",
"variables": [
{}
]
},
"settings": {
"pii_banner": "",
"pii_info": "",
"pii_lock": false,
"pii_anonimization": [
{
"value": "PERSON",
"label": "Name"
},
{
"value": "EMAIL_ADDRESS",
"label": "Email"
},
{
"value": "PHONE_NUMBER",
"label": "Phone Number"
},
{
"value": "CREDIT_CARD",
"label": "Credit Card"
}
],
"divider1": "",
"guardrail_info": "",
"guardrail_lock": false,
"guardrail_latency_banner": "",
"violence_and_hate": {
"value": "Off",
"context": ""
},
"sexual_content": {
"value": "Off",
"context": ""
},
"guns_and_weapons": {
"value": "Off",
"context": ""
},
"suicide": {
"value": "Off",
"context": ""
},
"crime": {
"value": "Off",
"context": ""
},
"toxicity": {
"value": "Off",
"context": ""
},
"bias": {
"value": "Off",
"context": ""
},
"profanity": {
"value": "Off",
"context": ""
},
"guardrails_scan_output": false,
"guardrails_output_mode": "post_stream",
"divider2": "",
"guardrail_action": {
"value": "fail",
"label": "Fail/block run"
},
"guardrail_action_replace": "",
"guardrail_action_human": "",
"block_after_violations": 0,
"block_message": "This conversation has been locked due to repeated safety violations. Please start a new conversation.",
"divider3": "",
"prompt_defense": "",
"prompt_lock": false,
"jailbreak": false,
"prompt_injection": false,
"context_leak": false,
"auto_model_pick": false,
"auto_model_preference": "cost",
"model": [
"preset:cost"
],
"parameter_preset": "default",
"intro": "",
"basic_params_section": "",
"max_tokens": 64000,
"temperature": 0.7,
"top_p": 1,
"top_k": 40,
"timeout": 120,
"divider_7": "",
"penalty_section": "",
"presence_penalty": 0.3,
"frequency_penalty": 0.6,
"stop_sequences": [],
"divider_8": "",
"reasoning_section": "",
"enable_reasoning": true,
"reasoning_effort": "Low",
"divider": "",
"reliability_section": "",
"max_retries_per_model": 3,
"retry_on_status_codes": [
429,
500,
502,
503,
504
],
"datacenter_fallback": true,
"exclude_user_identity_from_prompt": false,
"enable_prompt_caching": true,
"protect_instructions_in_preview": false,
"agentflow_enabled": true,
"usage_limits_section": "",
"usage_limits_maximum_request": 1000,
"usage_limits_maximum_tokens": 2000000,
"usage_limits_max_messages": 100,
"usage_limits_agent_timeout": 120,
"divider_11": "",
"compaction_enabled": true,
"compaction_strategy": "auto",
"compaction_threshold": 0.75,
"compaction_tool_enabled": false,
"tool_calling_section": "",
"parallel_tool_calls": true,
"tool_timeout": 15,
"agent_flow_id": "<string>",
"is_coworker": true,
"preset_selector": "<string>",
"introductory_message": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"persona": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"tone": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"extra_instructions": {},
"tools": [],
"mcp_servers": [],
"skills_enabled": true,
"convert_unsupported_files_to_text": true,
"skills": [],
"subagents_enabled": false,
"subagents": [],
"subagents_instructions": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"subagents_model": [
"preset:cost"
],
"guidelines_enabled": false,
"guidelines": [],
"glossary": [],
"memories": [],
"hidden_tools": [
"todos_read_todos",
"todos_add_todo",
"todos_write_todos",
"todos_update_todo_status",
"todos_remove_todo"
]
},
"last_updated_at": "2023-11-07T05:31:56Z",
"last_run_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"runs_count": 123,
"author_name": "<string>",
"description": "<string>",
"saved": true,
"error_handler": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_app_published": true,
"app_settings_v2": {
"is_active": false,
"version_id": "<string>",
"extra_settings": {},
"published_at": "2023-11-07T05:31:56Z"
},
"flow_version": "v1"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Workflows
Update workflow public
PATCH
/
v1
/
workflows
/
{workflow_id}
Update Workflow Public
curl --request PATCH \
--url https://api.example.com/v1/workflows/{workflow_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"saved": true,
"definition": {},
"error_handler": {},
"meta": {
"tags": [],
"icon": "<string>",
"log_sync_sheet": {
"name": "<string>",
"id": "<string>",
"time_created": "<string>"
},
"columns": [
{
"name": "<string>",
"visible": true
}
],
"spreadsheet": {
"name": "<string>",
"id": "<string>",
"timestamp": "<string>",
"url": "<string>"
},
"chatflow_settings": {},
"template_id": "<string>",
"variables": [
{}
]
},
"workflow_hash": "<string>",
"is_app_published": true,
"app_settings_v2": {
"is_active": false,
"version_id": "<string>",
"extra_settings": {},
"published_at": "2023-11-07T05:31:56Z"
},
"settings": {
"pii_banner": "",
"pii_info": "",
"pii_lock": false,
"pii_anonimization": [
{
"value": "PERSON",
"label": "Name"
},
{
"value": "EMAIL_ADDRESS",
"label": "Email"
},
{
"value": "PHONE_NUMBER",
"label": "Phone Number"
},
{
"value": "CREDIT_CARD",
"label": "Credit Card"
}
],
"divider1": "",
"guardrail_info": "",
"guardrail_lock": false,
"guardrail_latency_banner": "",
"violence_and_hate": {
"value": "Off",
"context": ""
},
"sexual_content": {
"value": "Off",
"context": ""
},
"guns_and_weapons": {
"value": "Off",
"context": ""
},
"suicide": {
"value": "Off",
"context": ""
},
"crime": {
"value": "Off",
"context": ""
},
"toxicity": {
"value": "Off",
"context": ""
},
"bias": {
"value": "Off",
"context": ""
},
"profanity": {
"value": "Off",
"context": ""
},
"guardrails_scan_output": false,
"guardrails_output_mode": "post_stream",
"divider2": "",
"guardrail_action": {
"value": "fail",
"label": "Fail/block run"
},
"guardrail_action_replace": "",
"guardrail_action_human": "",
"block_after_violations": 0,
"block_message": "This conversation has been locked due to repeated safety violations. Please start a new conversation.",
"divider3": "",
"prompt_defense": "",
"prompt_lock": false,
"jailbreak": false,
"prompt_injection": false,
"context_leak": false,
"auto_model_pick": false,
"auto_model_preference": "cost",
"model": [
"preset:cost"
],
"parameter_preset": "default",
"intro": "",
"basic_params_section": "",
"max_tokens": 64000,
"temperature": 0.7,
"top_p": 1,
"top_k": 40,
"timeout": 120,
"divider_7": "",
"penalty_section": "",
"presence_penalty": 0.3,
"frequency_penalty": 0.6,
"stop_sequences": [],
"divider_8": "",
"reasoning_section": "",
"enable_reasoning": true,
"reasoning_effort": "Low",
"divider": "",
"reliability_section": "",
"max_retries_per_model": 3,
"retry_on_status_codes": [
429,
500,
502,
503,
504
],
"datacenter_fallback": true,
"exclude_user_identity_from_prompt": false,
"enable_prompt_caching": true,
"protect_instructions_in_preview": false,
"agentflow_enabled": true,
"usage_limits_section": "",
"usage_limits_maximum_request": 1000,
"usage_limits_maximum_tokens": 2000000,
"usage_limits_max_messages": 100,
"usage_limits_agent_timeout": 120,
"divider_11": "",
"compaction_enabled": true,
"compaction_strategy": "auto",
"compaction_threshold": 0.75,
"compaction_tool_enabled": false,
"tool_calling_section": "",
"parallel_tool_calls": true,
"tool_timeout": 15,
"agent_flow_id": "<string>",
"is_coworker": true,
"preset_selector": "<string>",
"introductory_message": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"persona": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"tone": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"extra_instructions": {},
"tools": [],
"mcp_servers": [],
"skills_enabled": true,
"convert_unsupported_files_to_text": true,
"skills": [],
"subagents_enabled": false,
"subagents": [],
"subagents_instructions": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"subagents_model": [
"preset:cost"
],
"guidelines_enabled": false,
"guidelines": [],
"glossary": [],
"memories": [],
"hidden_tools": [
"todos_read_todos",
"todos_add_todo",
"todos_write_todos",
"todos_update_todo_status",
"todos_remove_todo"
]
}
}
'import requests
url = "https://api.example.com/v1/workflows/{workflow_id}"
payload = {
"name": "<string>",
"description": "<string>",
"saved": True,
"definition": {},
"error_handler": {},
"meta": {
"tags": [],
"icon": "<string>",
"log_sync_sheet": {
"name": "<string>",
"id": "<string>",
"time_created": "<string>"
},
"columns": [
{
"name": "<string>",
"visible": True
}
],
"spreadsheet": {
"name": "<string>",
"id": "<string>",
"timestamp": "<string>",
"url": "<string>"
},
"chatflow_settings": {},
"template_id": "<string>",
"variables": [{}]
},
"workflow_hash": "<string>",
"is_app_published": True,
"app_settings_v2": {
"is_active": False,
"version_id": "<string>",
"extra_settings": {},
"published_at": "2023-11-07T05:31:56Z"
},
"settings": {
"pii_banner": "",
"pii_info": "",
"pii_lock": False,
"pii_anonimization": [
{
"value": "PERSON",
"label": "Name"
},
{
"value": "EMAIL_ADDRESS",
"label": "Email"
},
{
"value": "PHONE_NUMBER",
"label": "Phone Number"
},
{
"value": "CREDIT_CARD",
"label": "Credit Card"
}
],
"divider1": "",
"guardrail_info": "",
"guardrail_lock": False,
"guardrail_latency_banner": "",
"violence_and_hate": {
"value": "Off",
"context": ""
},
"sexual_content": {
"value": "Off",
"context": ""
},
"guns_and_weapons": {
"value": "Off",
"context": ""
},
"suicide": {
"value": "Off",
"context": ""
},
"crime": {
"value": "Off",
"context": ""
},
"toxicity": {
"value": "Off",
"context": ""
},
"bias": {
"value": "Off",
"context": ""
},
"profanity": {
"value": "Off",
"context": ""
},
"guardrails_scan_output": False,
"guardrails_output_mode": "post_stream",
"divider2": "",
"guardrail_action": {
"value": "fail",
"label": "Fail/block run"
},
"guardrail_action_replace": "",
"guardrail_action_human": "",
"block_after_violations": 0,
"block_message": "This conversation has been locked due to repeated safety violations. Please start a new conversation.",
"divider3": "",
"prompt_defense": "",
"prompt_lock": False,
"jailbreak": False,
"prompt_injection": False,
"context_leak": False,
"auto_model_pick": False,
"auto_model_preference": "cost",
"model": ["preset:cost"],
"parameter_preset": "default",
"intro": "",
"basic_params_section": "",
"max_tokens": 64000,
"temperature": 0.7,
"top_p": 1,
"top_k": 40,
"timeout": 120,
"divider_7": "",
"penalty_section": "",
"presence_penalty": 0.3,
"frequency_penalty": 0.6,
"stop_sequences": [],
"divider_8": "",
"reasoning_section": "",
"enable_reasoning": True,
"reasoning_effort": "Low",
"divider": "",
"reliability_section": "",
"max_retries_per_model": 3,
"retry_on_status_codes": [429, 500, 502, 503, 504],
"datacenter_fallback": True,
"exclude_user_identity_from_prompt": False,
"enable_prompt_caching": True,
"protect_instructions_in_preview": False,
"agentflow_enabled": True,
"usage_limits_section": "",
"usage_limits_maximum_request": 1000,
"usage_limits_maximum_tokens": 2000000,
"usage_limits_max_messages": 100,
"usage_limits_agent_timeout": 120,
"divider_11": "",
"compaction_enabled": True,
"compaction_strategy": "auto",
"compaction_threshold": 0.75,
"compaction_tool_enabled": False,
"tool_calling_section": "",
"parallel_tool_calls": True,
"tool_timeout": 15,
"agent_flow_id": "<string>",
"is_coworker": True,
"preset_selector": "<string>",
"introductory_message": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"persona": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"tone": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"extra_instructions": {},
"tools": [],
"mcp_servers": [],
"skills_enabled": True,
"convert_unsupported_files_to_text": True,
"skills": [],
"subagents_enabled": False,
"subagents": [],
"subagents_instructions": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"subagents_model": ["preset:cost"],
"guidelines_enabled": False,
"guidelines": [],
"glossary": [],
"memories": [],
"hidden_tools": ["todos_read_todos", "todos_add_todo", "todos_write_todos", "todos_update_todo_status", "todos_remove_todo"]
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
saved: true,
definition: {},
error_handler: {},
meta: {
tags: [],
icon: '<string>',
log_sync_sheet: {name: '<string>', id: '<string>', time_created: '<string>'},
columns: [{name: '<string>', visible: true}],
spreadsheet: {name: '<string>', id: '<string>', timestamp: '<string>', url: '<string>'},
chatflow_settings: {},
template_id: '<string>',
variables: [{}]
},
workflow_hash: '<string>',
is_app_published: true,
app_settings_v2: {
is_active: false,
version_id: '<string>',
extra_settings: {},
published_at: '2023-11-07T05:31:56Z'
},
settings: {
pii_banner: '',
pii_info: '',
pii_lock: false,
pii_anonimization: [
{value: 'PERSON', label: 'Name'},
{value: 'EMAIL_ADDRESS', label: 'Email'},
{value: 'PHONE_NUMBER', label: 'Phone Number'},
{value: 'CREDIT_CARD', label: 'Credit Card'}
],
divider1: '',
guardrail_info: '',
guardrail_lock: false,
guardrail_latency_banner: '',
violence_and_hate: {value: 'Off', context: ''},
sexual_content: {value: 'Off', context: ''},
guns_and_weapons: {value: 'Off', context: ''},
suicide: {value: 'Off', context: ''},
crime: {value: 'Off', context: ''},
toxicity: {value: 'Off', context: ''},
bias: {value: 'Off', context: ''},
profanity: {value: 'Off', context: ''},
guardrails_scan_output: false,
guardrails_output_mode: 'post_stream',
divider2: '',
guardrail_action: {value: 'fail', label: 'Fail/block run'},
guardrail_action_replace: '',
guardrail_action_human: '',
block_after_violations: 0,
block_message: 'This conversation has been locked due to repeated safety violations. Please start a new conversation.',
divider3: '',
prompt_defense: '',
prompt_lock: false,
jailbreak: false,
prompt_injection: false,
context_leak: false,
auto_model_pick: false,
auto_model_preference: 'cost',
model: ['preset:cost'],
parameter_preset: 'default',
intro: '',
basic_params_section: '',
max_tokens: 64000,
temperature: 0.7,
top_p: 1,
top_k: 40,
timeout: 120,
divider_7: '',
penalty_section: '',
presence_penalty: 0.3,
frequency_penalty: 0.6,
stop_sequences: [],
divider_8: '',
reasoning_section: '',
enable_reasoning: true,
reasoning_effort: 'Low',
divider: '',
reliability_section: '',
max_retries_per_model: 3,
retry_on_status_codes: [429, 500, 502, 503, 504],
datacenter_fallback: true,
exclude_user_identity_from_prompt: false,
enable_prompt_caching: true,
protect_instructions_in_preview: false,
agentflow_enabled: true,
usage_limits_section: '',
usage_limits_maximum_request: 1000,
usage_limits_maximum_tokens: 2000000,
usage_limits_max_messages: 100,
usage_limits_agent_timeout: 120,
divider_11: '',
compaction_enabled: true,
compaction_strategy: 'auto',
compaction_threshold: 0.75,
compaction_tool_enabled: false,
tool_calling_section: '',
parallel_tool_calls: true,
tool_timeout: 15,
agent_flow_id: '<string>',
is_coworker: true,
preset_selector: '<string>',
introductory_message: [{text: '<string>', definition: {type: 'doc', content: []}}],
persona: [{text: '<string>', definition: {type: 'doc', content: []}}],
tone: [{text: '<string>', definition: {type: 'doc', content: []}}],
extra_instructions: {},
tools: [],
mcp_servers: [],
skills_enabled: true,
convert_unsupported_files_to_text: true,
skills: [],
subagents_enabled: false,
subagents: [],
subagents_instructions: [{text: '<string>', definition: {type: 'doc', content: []}}],
subagents_model: ['preset:cost'],
guidelines_enabled: false,
guidelines: [],
glossary: [],
memories: [],
hidden_tools: [
'todos_read_todos',
'todos_add_todo',
'todos_write_todos',
'todos_update_todo_status',
'todos_remove_todo'
]
}
})
};
fetch('https://api.example.com/v1/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/v1/workflows/{workflow_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'saved' => true,
'definition' => [
],
'error_handler' => [
],
'meta' => [
'tags' => [
],
'icon' => '<string>',
'log_sync_sheet' => [
'name' => '<string>',
'id' => '<string>',
'time_created' => '<string>'
],
'columns' => [
[
'name' => '<string>',
'visible' => true
]
],
'spreadsheet' => [
'name' => '<string>',
'id' => '<string>',
'timestamp' => '<string>',
'url' => '<string>'
],
'chatflow_settings' => [
],
'template_id' => '<string>',
'variables' => [
[
]
]
],
'workflow_hash' => '<string>',
'is_app_published' => true,
'app_settings_v2' => [
'is_active' => false,
'version_id' => '<string>',
'extra_settings' => [
],
'published_at' => '2023-11-07T05:31:56Z'
],
'settings' => [
'pii_banner' => '',
'pii_info' => '',
'pii_lock' => false,
'pii_anonimization' => [
[
'value' => 'PERSON',
'label' => 'Name'
],
[
'value' => 'EMAIL_ADDRESS',
'label' => 'Email'
],
[
'value' => 'PHONE_NUMBER',
'label' => 'Phone Number'
],
[
'value' => 'CREDIT_CARD',
'label' => 'Credit Card'
]
],
'divider1' => '',
'guardrail_info' => '',
'guardrail_lock' => false,
'guardrail_latency_banner' => '',
'violence_and_hate' => [
'value' => 'Off',
'context' => ''
],
'sexual_content' => [
'value' => 'Off',
'context' => ''
],
'guns_and_weapons' => [
'value' => 'Off',
'context' => ''
],
'suicide' => [
'value' => 'Off',
'context' => ''
],
'crime' => [
'value' => 'Off',
'context' => ''
],
'toxicity' => [
'value' => 'Off',
'context' => ''
],
'bias' => [
'value' => 'Off',
'context' => ''
],
'profanity' => [
'value' => 'Off',
'context' => ''
],
'guardrails_scan_output' => false,
'guardrails_output_mode' => 'post_stream',
'divider2' => '',
'guardrail_action' => [
'value' => 'fail',
'label' => 'Fail/block run'
],
'guardrail_action_replace' => '',
'guardrail_action_human' => '',
'block_after_violations' => 0,
'block_message' => 'This conversation has been locked due to repeated safety violations. Please start a new conversation.',
'divider3' => '',
'prompt_defense' => '',
'prompt_lock' => false,
'jailbreak' => false,
'prompt_injection' => false,
'context_leak' => false,
'auto_model_pick' => false,
'auto_model_preference' => 'cost',
'model' => [
'preset:cost'
],
'parameter_preset' => 'default',
'intro' => '',
'basic_params_section' => '',
'max_tokens' => 64000,
'temperature' => 0.7,
'top_p' => 1,
'top_k' => 40,
'timeout' => 120,
'divider_7' => '',
'penalty_section' => '',
'presence_penalty' => 0.3,
'frequency_penalty' => 0.6,
'stop_sequences' => [
],
'divider_8' => '',
'reasoning_section' => '',
'enable_reasoning' => true,
'reasoning_effort' => 'Low',
'divider' => '',
'reliability_section' => '',
'max_retries_per_model' => 3,
'retry_on_status_codes' => [
429,
500,
502,
503,
504
],
'datacenter_fallback' => true,
'exclude_user_identity_from_prompt' => false,
'enable_prompt_caching' => true,
'protect_instructions_in_preview' => false,
'agentflow_enabled' => true,
'usage_limits_section' => '',
'usage_limits_maximum_request' => 1000,
'usage_limits_maximum_tokens' => 2000000,
'usage_limits_max_messages' => 100,
'usage_limits_agent_timeout' => 120,
'divider_11' => '',
'compaction_enabled' => true,
'compaction_strategy' => 'auto',
'compaction_threshold' => 0.75,
'compaction_tool_enabled' => false,
'tool_calling_section' => '',
'parallel_tool_calls' => true,
'tool_timeout' => 15,
'agent_flow_id' => '<string>',
'is_coworker' => true,
'preset_selector' => '<string>',
'introductory_message' => [
[
'text' => '<string>',
'definition' => [
'type' => 'doc',
'content' => [
]
]
]
],
'persona' => [
[
'text' => '<string>',
'definition' => [
'type' => 'doc',
'content' => [
]
]
]
],
'tone' => [
[
'text' => '<string>',
'definition' => [
'type' => 'doc',
'content' => [
]
]
]
],
'extra_instructions' => [
],
'tools' => [
],
'mcp_servers' => [
],
'skills_enabled' => true,
'convert_unsupported_files_to_text' => true,
'skills' => [
],
'subagents_enabled' => false,
'subagents' => [
],
'subagents_instructions' => [
[
'text' => '<string>',
'definition' => [
'type' => 'doc',
'content' => [
]
]
]
],
'subagents_model' => [
'preset:cost'
],
'guidelines_enabled' => false,
'guidelines' => [
],
'glossary' => [
],
'memories' => [
],
'hidden_tools' => [
'todos_read_todos',
'todos_add_todo',
'todos_write_todos',
'todos_update_todo_status',
'todos_remove_todo'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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/v1/workflows/{workflow_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"saved\": true,\n \"definition\": {},\n \"error_handler\": {},\n \"meta\": {\n \"tags\": [],\n \"icon\": \"<string>\",\n \"log_sync_sheet\": {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"time_created\": \"<string>\"\n },\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"visible\": true\n }\n ],\n \"spreadsheet\": {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"timestamp\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"chatflow_settings\": {},\n \"template_id\": \"<string>\",\n \"variables\": [\n {}\n ]\n },\n \"workflow_hash\": \"<string>\",\n \"is_app_published\": true,\n \"app_settings_v2\": {\n \"is_active\": false,\n \"version_id\": \"<string>\",\n \"extra_settings\": {},\n \"published_at\": \"2023-11-07T05:31:56Z\"\n },\n \"settings\": {\n \"pii_banner\": \"\",\n \"pii_info\": \"\",\n \"pii_lock\": false,\n \"pii_anonimization\": [\n {\n \"value\": \"PERSON\",\n \"label\": \"Name\"\n },\n {\n \"value\": \"EMAIL_ADDRESS\",\n \"label\": \"Email\"\n },\n {\n \"value\": \"PHONE_NUMBER\",\n \"label\": \"Phone Number\"\n },\n {\n \"value\": \"CREDIT_CARD\",\n \"label\": \"Credit Card\"\n }\n ],\n \"divider1\": \"\",\n \"guardrail_info\": \"\",\n \"guardrail_lock\": false,\n \"guardrail_latency_banner\": \"\",\n \"violence_and_hate\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"sexual_content\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guns_and_weapons\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"suicide\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"crime\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"toxicity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"bias\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"profanity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guardrails_scan_output\": false,\n \"guardrails_output_mode\": \"post_stream\",\n \"divider2\": \"\",\n \"guardrail_action\": {\n \"value\": \"fail\",\n \"label\": \"Fail/block run\"\n },\n \"guardrail_action_replace\": \"\",\n \"guardrail_action_human\": \"\",\n \"block_after_violations\": 0,\n \"block_message\": \"This conversation has been locked due to repeated safety violations. Please start a new conversation.\",\n \"divider3\": \"\",\n \"prompt_defense\": \"\",\n \"prompt_lock\": false,\n \"jailbreak\": false,\n \"prompt_injection\": false,\n \"context_leak\": false,\n \"auto_model_pick\": false,\n \"auto_model_preference\": \"cost\",\n \"model\": [\n \"preset:cost\"\n ],\n \"parameter_preset\": \"default\",\n \"intro\": \"\",\n \"basic_params_section\": \"\",\n \"max_tokens\": 64000,\n \"temperature\": 0.7,\n \"top_p\": 1,\n \"top_k\": 40,\n \"timeout\": 120,\n \"divider_7\": \"\",\n \"penalty_section\": \"\",\n \"presence_penalty\": 0.3,\n \"frequency_penalty\": 0.6,\n \"stop_sequences\": [],\n \"divider_8\": \"\",\n \"reasoning_section\": \"\",\n \"enable_reasoning\": true,\n \"reasoning_effort\": \"Low\",\n \"divider\": \"\",\n \"reliability_section\": \"\",\n \"max_retries_per_model\": 3,\n \"retry_on_status_codes\": [\n 429,\n 500,\n 502,\n 503,\n 504\n ],\n \"datacenter_fallback\": true,\n \"exclude_user_identity_from_prompt\": false,\n \"enable_prompt_caching\": true,\n \"protect_instructions_in_preview\": false,\n \"agentflow_enabled\": true,\n \"usage_limits_section\": \"\",\n \"usage_limits_maximum_request\": 1000,\n \"usage_limits_maximum_tokens\": 2000000,\n \"usage_limits_max_messages\": 100,\n \"usage_limits_agent_timeout\": 120,\n \"divider_11\": \"\",\n \"compaction_enabled\": true,\n \"compaction_strategy\": \"auto\",\n \"compaction_threshold\": 0.75,\n \"compaction_tool_enabled\": false,\n \"tool_calling_section\": \"\",\n \"parallel_tool_calls\": true,\n \"tool_timeout\": 15,\n \"agent_flow_id\": \"<string>\",\n \"is_coworker\": true,\n \"preset_selector\": \"<string>\",\n \"introductory_message\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"persona\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"tone\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"extra_instructions\": {},\n \"tools\": [],\n \"mcp_servers\": [],\n \"skills_enabled\": true,\n \"convert_unsupported_files_to_text\": true,\n \"skills\": [],\n \"subagents_enabled\": false,\n \"subagents\": [],\n \"subagents_instructions\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"subagents_model\": [\n \"preset:cost\"\n ],\n \"guidelines_enabled\": false,\n \"guidelines\": [],\n \"glossary\": [],\n \"memories\": [],\n \"hidden_tools\": [\n \"todos_read_todos\",\n \"todos_add_todo\",\n \"todos_write_todos\",\n \"todos_update_todo_status\",\n \"todos_remove_todo\"\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.patch("https://api.example.com/v1/workflows/{workflow_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"saved\": true,\n \"definition\": {},\n \"error_handler\": {},\n \"meta\": {\n \"tags\": [],\n \"icon\": \"<string>\",\n \"log_sync_sheet\": {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"time_created\": \"<string>\"\n },\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"visible\": true\n }\n ],\n \"spreadsheet\": {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"timestamp\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"chatflow_settings\": {},\n \"template_id\": \"<string>\",\n \"variables\": [\n {}\n ]\n },\n \"workflow_hash\": \"<string>\",\n \"is_app_published\": true,\n \"app_settings_v2\": {\n \"is_active\": false,\n \"version_id\": \"<string>\",\n \"extra_settings\": {},\n \"published_at\": \"2023-11-07T05:31:56Z\"\n },\n \"settings\": {\n \"pii_banner\": \"\",\n \"pii_info\": \"\",\n \"pii_lock\": false,\n \"pii_anonimization\": [\n {\n \"value\": \"PERSON\",\n \"label\": \"Name\"\n },\n {\n \"value\": \"EMAIL_ADDRESS\",\n \"label\": \"Email\"\n },\n {\n \"value\": \"PHONE_NUMBER\",\n \"label\": \"Phone Number\"\n },\n {\n \"value\": \"CREDIT_CARD\",\n \"label\": \"Credit Card\"\n }\n ],\n \"divider1\": \"\",\n \"guardrail_info\": \"\",\n \"guardrail_lock\": false,\n \"guardrail_latency_banner\": \"\",\n \"violence_and_hate\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"sexual_content\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guns_and_weapons\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"suicide\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"crime\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"toxicity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"bias\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"profanity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guardrails_scan_output\": false,\n \"guardrails_output_mode\": \"post_stream\",\n \"divider2\": \"\",\n \"guardrail_action\": {\n \"value\": \"fail\",\n \"label\": \"Fail/block run\"\n },\n \"guardrail_action_replace\": \"\",\n \"guardrail_action_human\": \"\",\n \"block_after_violations\": 0,\n \"block_message\": \"This conversation has been locked due to repeated safety violations. Please start a new conversation.\",\n \"divider3\": \"\",\n \"prompt_defense\": \"\",\n \"prompt_lock\": false,\n \"jailbreak\": false,\n \"prompt_injection\": false,\n \"context_leak\": false,\n \"auto_model_pick\": false,\n \"auto_model_preference\": \"cost\",\n \"model\": [\n \"preset:cost\"\n ],\n \"parameter_preset\": \"default\",\n \"intro\": \"\",\n \"basic_params_section\": \"\",\n \"max_tokens\": 64000,\n \"temperature\": 0.7,\n \"top_p\": 1,\n \"top_k\": 40,\n \"timeout\": 120,\n \"divider_7\": \"\",\n \"penalty_section\": \"\",\n \"presence_penalty\": 0.3,\n \"frequency_penalty\": 0.6,\n \"stop_sequences\": [],\n \"divider_8\": \"\",\n \"reasoning_section\": \"\",\n \"enable_reasoning\": true,\n \"reasoning_effort\": \"Low\",\n \"divider\": \"\",\n \"reliability_section\": \"\",\n \"max_retries_per_model\": 3,\n \"retry_on_status_codes\": [\n 429,\n 500,\n 502,\n 503,\n 504\n ],\n \"datacenter_fallback\": true,\n \"exclude_user_identity_from_prompt\": false,\n \"enable_prompt_caching\": true,\n \"protect_instructions_in_preview\": false,\n \"agentflow_enabled\": true,\n \"usage_limits_section\": \"\",\n \"usage_limits_maximum_request\": 1000,\n \"usage_limits_maximum_tokens\": 2000000,\n \"usage_limits_max_messages\": 100,\n \"usage_limits_agent_timeout\": 120,\n \"divider_11\": \"\",\n \"compaction_enabled\": true,\n \"compaction_strategy\": \"auto\",\n \"compaction_threshold\": 0.75,\n \"compaction_tool_enabled\": false,\n \"tool_calling_section\": \"\",\n \"parallel_tool_calls\": true,\n \"tool_timeout\": 15,\n \"agent_flow_id\": \"<string>\",\n \"is_coworker\": true,\n \"preset_selector\": \"<string>\",\n \"introductory_message\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"persona\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"tone\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"extra_instructions\": {},\n \"tools\": [],\n \"mcp_servers\": [],\n \"skills_enabled\": true,\n \"convert_unsupported_files_to_text\": true,\n \"skills\": [],\n \"subagents_enabled\": false,\n \"subagents\": [],\n \"subagents_instructions\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"subagents_model\": [\n \"preset:cost\"\n ],\n \"guidelines_enabled\": false,\n \"guidelines\": [],\n \"glossary\": [],\n \"memories\": [],\n \"hidden_tools\": [\n \"todos_read_todos\",\n \"todos_add_todo\",\n \"todos_write_todos\",\n \"todos_update_todo_status\",\n \"todos_remove_todo\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/workflows/{workflow_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"saved\": true,\n \"definition\": {},\n \"error_handler\": {},\n \"meta\": {\n \"tags\": [],\n \"icon\": \"<string>\",\n \"log_sync_sheet\": {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"time_created\": \"<string>\"\n },\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"visible\": true\n }\n ],\n \"spreadsheet\": {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"timestamp\": \"<string>\",\n \"url\": \"<string>\"\n },\n \"chatflow_settings\": {},\n \"template_id\": \"<string>\",\n \"variables\": [\n {}\n ]\n },\n \"workflow_hash\": \"<string>\",\n \"is_app_published\": true,\n \"app_settings_v2\": {\n \"is_active\": false,\n \"version_id\": \"<string>\",\n \"extra_settings\": {},\n \"published_at\": \"2023-11-07T05:31:56Z\"\n },\n \"settings\": {\n \"pii_banner\": \"\",\n \"pii_info\": \"\",\n \"pii_lock\": false,\n \"pii_anonimization\": [\n {\n \"value\": \"PERSON\",\n \"label\": \"Name\"\n },\n {\n \"value\": \"EMAIL_ADDRESS\",\n \"label\": \"Email\"\n },\n {\n \"value\": \"PHONE_NUMBER\",\n \"label\": \"Phone Number\"\n },\n {\n \"value\": \"CREDIT_CARD\",\n \"label\": \"Credit Card\"\n }\n ],\n \"divider1\": \"\",\n \"guardrail_info\": \"\",\n \"guardrail_lock\": false,\n \"guardrail_latency_banner\": \"\",\n \"violence_and_hate\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"sexual_content\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guns_and_weapons\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"suicide\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"crime\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"toxicity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"bias\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"profanity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guardrails_scan_output\": false,\n \"guardrails_output_mode\": \"post_stream\",\n \"divider2\": \"\",\n \"guardrail_action\": {\n \"value\": \"fail\",\n \"label\": \"Fail/block run\"\n },\n \"guardrail_action_replace\": \"\",\n \"guardrail_action_human\": \"\",\n \"block_after_violations\": 0,\n \"block_message\": \"This conversation has been locked due to repeated safety violations. Please start a new conversation.\",\n \"divider3\": \"\",\n \"prompt_defense\": \"\",\n \"prompt_lock\": false,\n \"jailbreak\": false,\n \"prompt_injection\": false,\n \"context_leak\": false,\n \"auto_model_pick\": false,\n \"auto_model_preference\": \"cost\",\n \"model\": [\n \"preset:cost\"\n ],\n \"parameter_preset\": \"default\",\n \"intro\": \"\",\n \"basic_params_section\": \"\",\n \"max_tokens\": 64000,\n \"temperature\": 0.7,\n \"top_p\": 1,\n \"top_k\": 40,\n \"timeout\": 120,\n \"divider_7\": \"\",\n \"penalty_section\": \"\",\n \"presence_penalty\": 0.3,\n \"frequency_penalty\": 0.6,\n \"stop_sequences\": [],\n \"divider_8\": \"\",\n \"reasoning_section\": \"\",\n \"enable_reasoning\": true,\n \"reasoning_effort\": \"Low\",\n \"divider\": \"\",\n \"reliability_section\": \"\",\n \"max_retries_per_model\": 3,\n \"retry_on_status_codes\": [\n 429,\n 500,\n 502,\n 503,\n 504\n ],\n \"datacenter_fallback\": true,\n \"exclude_user_identity_from_prompt\": false,\n \"enable_prompt_caching\": true,\n \"protect_instructions_in_preview\": false,\n \"agentflow_enabled\": true,\n \"usage_limits_section\": \"\",\n \"usage_limits_maximum_request\": 1000,\n \"usage_limits_maximum_tokens\": 2000000,\n \"usage_limits_max_messages\": 100,\n \"usage_limits_agent_timeout\": 120,\n \"divider_11\": \"\",\n \"compaction_enabled\": true,\n \"compaction_strategy\": \"auto\",\n \"compaction_threshold\": 0.75,\n \"compaction_tool_enabled\": false,\n \"tool_calling_section\": \"\",\n \"parallel_tool_calls\": true,\n \"tool_timeout\": 15,\n \"agent_flow_id\": \"<string>\",\n \"is_coworker\": true,\n \"preset_selector\": \"<string>\",\n \"introductory_message\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"persona\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"tone\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"extra_instructions\": {},\n \"tools\": [],\n \"mcp_servers\": [],\n \"skills_enabled\": true,\n \"convert_unsupported_files_to_text\": true,\n \"skills\": [],\n \"subagents_enabled\": false,\n \"subagents\": [],\n \"subagents_instructions\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"subagents_model\": [\n \"preset:cost\"\n ],\n \"guidelines_enabled\": false,\n \"guidelines\": [],\n \"glossary\": [],\n \"memories\": [],\n \"hidden_tools\": [\n \"todos_read_todos\",\n \"todos_add_todo\",\n \"todos_write_todos\",\n \"todos_update_todo_status\",\n \"todos_remove_todo\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"definition": {},
"workflow_hash": "<string>",
"meta": {
"tags": [],
"icon": "<string>",
"log_sync_sheet": {
"name": "<string>",
"id": "<string>",
"time_created": "<string>"
},
"columns": [
{
"name": "<string>",
"visible": true
}
],
"spreadsheet": {
"name": "<string>",
"id": "<string>",
"timestamp": "<string>",
"url": "<string>"
},
"chatflow_settings": {},
"template_id": "<string>",
"variables": [
{}
]
},
"settings": {
"pii_banner": "",
"pii_info": "",
"pii_lock": false,
"pii_anonimization": [
{
"value": "PERSON",
"label": "Name"
},
{
"value": "EMAIL_ADDRESS",
"label": "Email"
},
{
"value": "PHONE_NUMBER",
"label": "Phone Number"
},
{
"value": "CREDIT_CARD",
"label": "Credit Card"
}
],
"divider1": "",
"guardrail_info": "",
"guardrail_lock": false,
"guardrail_latency_banner": "",
"violence_and_hate": {
"value": "Off",
"context": ""
},
"sexual_content": {
"value": "Off",
"context": ""
},
"guns_and_weapons": {
"value": "Off",
"context": ""
},
"suicide": {
"value": "Off",
"context": ""
},
"crime": {
"value": "Off",
"context": ""
},
"toxicity": {
"value": "Off",
"context": ""
},
"bias": {
"value": "Off",
"context": ""
},
"profanity": {
"value": "Off",
"context": ""
},
"guardrails_scan_output": false,
"guardrails_output_mode": "post_stream",
"divider2": "",
"guardrail_action": {
"value": "fail",
"label": "Fail/block run"
},
"guardrail_action_replace": "",
"guardrail_action_human": "",
"block_after_violations": 0,
"block_message": "This conversation has been locked due to repeated safety violations. Please start a new conversation.",
"divider3": "",
"prompt_defense": "",
"prompt_lock": false,
"jailbreak": false,
"prompt_injection": false,
"context_leak": false,
"auto_model_pick": false,
"auto_model_preference": "cost",
"model": [
"preset:cost"
],
"parameter_preset": "default",
"intro": "",
"basic_params_section": "",
"max_tokens": 64000,
"temperature": 0.7,
"top_p": 1,
"top_k": 40,
"timeout": 120,
"divider_7": "",
"penalty_section": "",
"presence_penalty": 0.3,
"frequency_penalty": 0.6,
"stop_sequences": [],
"divider_8": "",
"reasoning_section": "",
"enable_reasoning": true,
"reasoning_effort": "Low",
"divider": "",
"reliability_section": "",
"max_retries_per_model": 3,
"retry_on_status_codes": [
429,
500,
502,
503,
504
],
"datacenter_fallback": true,
"exclude_user_identity_from_prompt": false,
"enable_prompt_caching": true,
"protect_instructions_in_preview": false,
"agentflow_enabled": true,
"usage_limits_section": "",
"usage_limits_maximum_request": 1000,
"usage_limits_maximum_tokens": 2000000,
"usage_limits_max_messages": 100,
"usage_limits_agent_timeout": 120,
"divider_11": "",
"compaction_enabled": true,
"compaction_strategy": "auto",
"compaction_threshold": 0.75,
"compaction_tool_enabled": false,
"tool_calling_section": "",
"parallel_tool_calls": true,
"tool_timeout": 15,
"agent_flow_id": "<string>",
"is_coworker": true,
"preset_selector": "<string>",
"introductory_message": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"persona": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"tone": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"extra_instructions": {},
"tools": [],
"mcp_servers": [],
"skills_enabled": true,
"convert_unsupported_files_to_text": true,
"skills": [],
"subagents_enabled": false,
"subagents": [],
"subagents_instructions": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"subagents_model": [
"preset:cost"
],
"guidelines_enabled": false,
"guidelines": [],
"glossary": [],
"memories": [],
"hidden_tools": [
"todos_read_todos",
"todos_add_todo",
"todos_write_todos",
"todos_update_todo_status",
"todos_remove_todo"
]
},
"last_updated_at": "2023-11-07T05:31:56Z",
"last_run_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"runs_count": 123,
"author_name": "<string>",
"description": "<string>",
"saved": true,
"error_handler": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_app_published": true,
"app_settings_v2": {
"is_active": false,
"version_id": "<string>",
"extra_settings": {},
"published_at": "2023-11-07T05:31:56Z"
},
"flow_version": "v1"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Path Parameters
Query Parameters
Body
application/json
Available options:
flow, agent_flow, handler, ingestion, inbox_process, inbox_filtering, inbox_extraction, task_automation Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Successful Response
Available options:
flow, agent_flow, handler, ingestion, inbox_process, inbox_filtering, inbox_extraction, task_automation Show child attributes
Show child attributes
- ChatflowSettingsConfig
- Settings
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I