Create a new workflow

POST

/v1/workflows

POST

/v1/workflows

1 curl -X POST https://api.skyvern.com/v1/workflows --header 'x-api-key: {{x-api-key}}' --header 'Content-Type: text/plain' --data-raw 'title: Contact Forms
2 description: Fill the contact form on the website
3 proxy_location: RESIDENTIAL
4 webhook_callback_url: https://example.com/webhook
5 totp_verification_url: https://example.com/totp
6 persist_browser_session: false
7 model:
8   name: gpt-4.1
9 workflow_definition:
10   parameters:
11     - key: website_url
12       description: null
13       parameter_type: workflow
14       workflow_parameter_type: string
15       default_value: null
16     - key: name
17       description: null
18       parameter_type: workflow
19       workflow_parameter_type: string
20       default_value: null
21     - key: additional_information
22       description: null
23       parameter_type: workflow
24       workflow_parameter_type: string
25       default_value: |-
26         Message: I'd love to learn more about your...
27         Phone: 123-456-7890
28         Inquiry type: sales
29         Optional Subject: Hello from [Company Here]
30     - key: email
31       description: null
32       parameter_type: workflow
33       workflow_parameter_type: string
34       default_value: null
35   blocks:
36     - label: Fill_Out_Contact_Form
37       continue_on_failure: true
38       block_type: navigation
39       url: "{{website_url}}"
40       title: Fill_Out_Contact_Form
41       engine: skyvern-1.0
42       navigation_goal: >-
43         Find the contact form. Fill out the contact us form and submit it. Your
44         goal is complete when the page says your message has been sent. In the
45         case you can't find a contact us form, terminate.
46 
47 
48         Fill out required fields as best you can using the following
49         information:
50 
51         {{name}}
52 
53         {{email}}
54 
55         {{additional_information}}
56       error_code_mapping: null
57       max_retries: 0
58       max_steps_per_run: null
59       complete_on_download: false
60       download_suffix: null
61       parameter_keys: []
62       totp_identifier: null
63       totp_verification_url: null
64       cache_actions: false
65       complete_criterion: ""
66       terminate_criterion: ""
67       include_action_history_in_verification: false
68     - label: Extract_Email
69       continue_on_failure: false
70       block_type: extraction
71       url: ""
72       title: Extract_Email
73       data_extraction_goal: "Extract a company email if available "
74       data_schema: null
75       max_retries: 0
76       max_steps_per_run: null
77       parameter_keys: []
78       cache_actions: false
79 '

Try it

200createWorkflowExample

1 {
2   "workflow_id": "foo",
3   "organization_id": "foo",
4   "title": "foo",
5   "workflow_permanent_id": "foo",
6   "version": 42,
7   "is_saved_task": true,
8   "workflow_definition": {
9     "parameters": [
10       {
11         "parameter_type": "workflow",
12         "key": "foo",
13         "description": "foo",
14         "workflow_parameter_id": "foo",
15         "workflow_parameter_type": "string",
16         "workflow_id": "foo",
17         "default_value": {},
18         "created_at": "foo",
19         "modified_at": "foo",
20         "deleted_at": "foo"
21       }
22     ],
23     "blocks": [
24       {
25         "label": "foo",
26         "block_type": "for_loop",
27         "output_parameter": {
28           "parameter_type": "output",
29           "key": "foo",
30           "description": "foo",
31           "output_parameter_id": "foo",
32           "workflow_id": "foo",
33           "created_at": "foo",
34           "modified_at": "foo",
35           "deleted_at": "foo"
36         },
37         "continue_on_failure": false,
38         "model": {},
39         "loop_blocks": [
40           {
41             "label": "foo",
42             "block_type": "for_loop",
43             "output_parameter": {
44               "parameter_type": "output",
45               "key": "foo",
46               "description": "foo",
47               "output_parameter_id": "foo",
48               "workflow_id": "foo",
49               "created_at": "foo",
50               "modified_at": "foo",
51               "deleted_at": "foo"
52             },
53             "continue_on_failure": false,
54             "model": {},
55             "loop_blocks": [
56               {
57                 "label": "foo",
58                 "block_type": "for_loop",
59                 "output_parameter": {
60                   "parameter_type": "output",
61                   "key": "foo",
62                   "output_parameter_id": "foo",
63                   "workflow_id": "foo",
64                   "created_at": "foo",
65                   "modified_at": "foo"
66                 },
67                 "continue_on_failure": false,
68                 "model": {},
69                 "loop_blocks": [
70                   null
71                 ],
72                 "loop_variable_reference": "foo",
73                 "complete_if_empty": false
74               }
75             ],
76             "loop_over": {
77               "parameter_type": "workflow",
78               "key": "foo",
79               "description": "foo",
80               "workflow_parameter_id": "foo",
81               "workflow_parameter_type": "string",
82               "workflow_id": "foo",
83               "default_value": {},
84               "created_at": "foo",
85               "modified_at": "foo",
86               "deleted_at": "foo"
87             },
88             "loop_variable_reference": "foo",
89             "complete_if_empty": false
90           }
91         ],
92         "loop_over": {
93           "parameter_type": "workflow",
94           "key": "foo",
95           "description": "foo",
96           "workflow_parameter_id": "foo",
97           "workflow_parameter_type": "string",
98           "workflow_id": "foo",
99           "default_value": {},
100           "created_at": "foo",
101           "modified_at": "foo",
102           "deleted_at": "foo"
103         },
104         "loop_variable_reference": "foo",
105         "complete_if_empty": false
106       }
107     ]
108   },
109   "created_at": "foo",
110   "modified_at": "foo",
111   "description": "foo",
112   "proxy_location": "RESIDENTIAL",
113   "webhook_callback_url": "foo",
114   "totp_verification_url": "foo",
115   "totp_identifier": "foo",
116   "persist_browser_session": false,
117   "model": {},
118   "status": "published",
119   "deleted_at": "foo"
120 }

Create a new workflow

Request

This endpoint expects an object.

json_definitionobjectOptional

Workflow definition in JSON format

yaml_definitionstringOptional

Workflow definition in YAML format

Response

Successfully created workflow

workflow_idstring

organization_idstring

titlestring

workflow_permanent_idstring

versioninteger

is_saved_taskboolean

workflow_definitionobject

created_atstringformat: "date-time"

modified_atstringformat: "date-time"

descriptionstring or null

proxy_locationenum or null

webhook_callback_urlstring or null

totp_verification_urlstring or null

totp_identifierstring or null

persist_browser_sessionboolean or nullDefaults to false

modelmap from strings to any or null

statusenum or null

Allowed values:

deleted_atstring or nullformat: "date-time"

Create a new workflow

Headers

Request

Response

Errors