Update a workflow

Beta

PUT

https://api-prod.scoutos.com/v2/workflows/:workflow_id

PUT

/v2/workflows/:workflow_id

1 from scoutos import Scout
2 
3 client = Scout(
4     api_key="YOUR_API_KEY",
5 )
6 client.workflows.update(
7     workflow_id="workflow_id",
8 )

Try it

1 {
2   "data": {
3     "workflow_config": {
4       "workflow_display_name": "Untitled",
5       "workflow_schema_version": "1.0",
6       "workflow_img_url": "string",
7       "workflow_description": "string",
8       "blocks": [
9         {
10           "block_archetype_id": "string",
11           "block_display_name": "string",
12           "block_id": "string",
13           "block_inputs": {},
14           "is_output": false,
15           "dependencies": [
16             {
17               "block_id": "string",
18               "ui": {
19                 "edge_type": "plusSign"
20               }
21             }
22           ],
23           "input_schema": {},
24           "ui": {
25             "dimensions": {
26               "width": 1,
27               "height": 1
28             },
29             "position": {
30               "x": 1,
31               "y": 1
32             }
33           },
34           "trigger_config": {},
35           "ignore_error": false,
36           "block_config": [
37             {
38               "id": "string",
39               "display_name": "string",
40               "type": "boolean",
41               "default_value": true,
42               "value": true
43             }
44           ],
45           "output_schema": [
46             null
47           ]
48         }
49       ],
50       "notes": [
51         {
52           "id": "string",
53           "bgColor": "string",
54           "content": "",
55           "author": "Your name",
56           "ui": {
57             "dimensions": {
58               "width": 1,
59               "height": 1
60             },
61             "position": {
62               "x": 1,
63               "y": 1
64             }
65           }
66         }
67       ],
68       "placeholders": [
69         {
70           "block_id": "string",
71           "type": "triggerPlaceholder",
72           "ui": {
73             "dimensions": {
74               "width": 1,
75               "height": 1
76             },
77             "position": {
78               "x": 1,
79               "y": 1
80             }
81           },
82           "dependencies": [
83             {
84               "block_id": "string",
85               "ui": {
86                 "edge_type": "plusSign"
87               }
88             }
89           ]
90         }
91       ],
92       "tags": [
93         "string"
94       ],
95       "is_tool": false
96     },
97     "last_updated_at": "2024-01-15T09:30:00Z",
98     "created_at": "2024-01-15T09:30:00Z",
99     "created_by": {
100       "type": "user",
101       "details": {
102         "api_key": {}
103       }
104     },
105     "last_updated_by": {
106       "type": "user",
107       "details": {
108         "api_key": {}
109       }
110     },
111     "revision_id": "string",
112     "workflow_id": "string",
113     "workflow_key": "string",
114     "is_draft": false
115   }
116 }

Authentication

AuthorizationBearer

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

Path Parameters

workflow_idstringRequired

Request

This endpoint expects an object.

workflow_display_namestringOptionalDefaults to Untitled

workflow_schema_versionstringOptionalDefaults to 1.0

workflow_img_urlstring or nullOptional

workflow_descriptionstring or nullOptional

blockslist of objectsOptional

noteslist of objectsOptional

placeholderslist of objectsOptional

tagslist of stringsOptional

is_toolbooleanOptionalDefaults to false

Response

Successful Response

dataobject or null

Authentication

Path Parameters

Request

Response

Errors