For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Scout DocsAccess Scout
API & SDK
API & SDK
  • Endpoints
      • POSTCreate a new workflow revision
      • GETList all workflows
      • POSTCreate a new workflow
      • GETGet a workflow by ID
      • PUTUpdate a workflow
      • DELDelete a workflow
      • STREAMExecute a workflow.
      • POSTExecute a workflow with provided config.
LogoLogo
Scout DocsAccess Scout
EndpointsWorkflows

Create a new workflow revision

Beta
POST
https://api.scoutos.com/v2/workflows/revisions
POST
/v2/workflows/revisions
$curl -X POST https://api.scoutos.com/v2/workflows/revisions \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{}'
1{
2 "data": {
3 "workflow_config": {
4 "workflow_display_name": "Customer Onboarding Workflow",
5 "workflow_schema_version": "1.0",
6 "workflow_img_url": "https://cdn.scoutos.com/workflows/onboarding.png",
7 "workflow_description": "Automated workflow for onboarding new customers efficiently.",
8 "blocks": [
9 {
10 "block_archetype_id": "email_sender_v2",
11 "block_display_name": "Welcome Email Sender",
12 "block_id": "block_001",
13 "block_inputs": {},
14 "is_output": false,
15 "dependencies": [
16 {
17 "block_id": "block_000",
18 "ui": {
19 "edge_type": "plusSign"
20 }
21 }
22 ],
23 "input_schema": {},
24 "ui": {
25 "dimensions": {
26 "width": 300,
27 "height": 150
28 },
29 "position": {
30 "x": 100,
31 "y": 200
32 }
33 },
34 "trigger_config": {},
35 "ignore_error": false,
36 "block_config": [
37 {
38 "id": "send_welcome_email",
39 "display_name": "Send Welcome Email",
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": "note_001",
53 "bgColor": "#FFFACD",
54 "content": "Ensure all customer data is verified before sending emails.",
55 "author": "Jane Doe",
56 "ui": {
57 "dimensions": {
58 "width": 250,
59 "height": 100
60 },
61 "position": {
62 "x": 50,
63 "y": 50
64 }
65 }
66 }
67 ],
68 "placeholders": [
69 {
70 "block_id": "block_002",
71 "type": "triggerPlaceholder",
72 "ui": {
73 "dimensions": {
74 "width": 100,
75 "height": 100
76 },
77 "position": {
78 "x": 400,
79 "y": 300
80 }
81 },
82 "dependencies": [
83 {
84 "block_id": "block_001",
85 "ui": {
86 "edge_type": "plusSign"
87 }
88 }
89 ]
90 }
91 ],
92 "tags": [
93 "onboarding",
94 "automation",
95 "email"
96 ],
97 "is_tool": false
98 },
99 "last_updated_at": "2024-01-15T09:30:00Z",
100 "created_at": "2024-01-15T09:30:00Z",
101 "created_by": {
102 "type": "user",
103 "details": {
104 "api_key": {}
105 }
106 },
107 "last_updated_by": {
108 "type": "user",
109 "details": {
110 "api_key": {}
111 }
112 },
113 "revision_id": "rev_20240115_001",
114 "workflow_id": "wf_20240115_001",
115 "workflow_key": "onboarding_workflow_v2",
116 "is_draft": false
117 }
118}
Was this page helpful?

List all workflows

Next
Built with

Authentication

AuthorizationBearer

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

Query parameters

workflow_idstring or nullOptional
workflow_keystring or nullOptional

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

Errors

422
Unprocessable Entity Error