Update API specifications with fern api update (#3215)
Co-authored-by: github-actions <github-actions@github.com>
This commit is contained in:
Shuchang Zheng
@@ -363,9 +363,7 @@
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
|
||||
}
|
||||
"schema": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -452,7 +450,7 @@
|
||||
"code-samples": [
|
||||
{
|
||||
"sdk": "curl",
|
||||
"code": "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\ndescription: Fill the contact form on the website\nproxy_location: RESIDENTIAL\nwebhook_callback_url: https://example.com/webhook\ntotp_verification_url: https://example.com/totp\npersist_browser_session: false\nmodel:\n name: gpt-4.1\nworkflow_definition:\n parameters:\n - key: website_url\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n - key: name\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n - key: additional_information\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: |-\n Message: I'd love to learn more about your...\n Phone: 123-456-7890\n Inquiry type: sales\n Optional Subject: Hello from [Company Here]\n - key: email\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n blocks:\n - label: Fill_Out_Contact_Form\n continue_on_failure: true\n block_type: navigation\n url: \"{{website_url}}\"\n title: Fill_Out_Contact_Form\n engine: skyvern-1.0\n navigation_goal: \u003E-\n Find the contact form. Fill out the contact us form and submit it. Your\n goal is complete when the page says your message has been sent. In the\n case you can't find a contact us form, terminate.\n\n\n Fill out required fields as best you can using the following\n information:\n\n {{name}}\n\n {{email}}\n\n {{additional_information}}\n error_code_mapping: null\n max_retries: 0\n max_steps_per_run: null\n complete_on_download: false\n download_suffix: null\n parameter_keys: []\n totp_identifier: null\n totp_verification_url: null\n cache_actions: false\n complete_criterion: \"\"\n terminate_criterion: \"\"\n include_action_history_in_verification: false\n - label: Extract_Email\n continue_on_failure: false\n block_type: extraction\n url: \"\"\n title: Extract_Email\n data_extraction_goal: \"Extract a company email if available \"\n data_schema: null\n max_retries: 0\n max_steps_per_run: null\n parameter_keys: []\n cache_actions: false\n'\n"
|
||||
"code": "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\ndescription: Fill the contact form on the website\nproxy_location: RESIDENTIAL\nwebhook_callback_url: https://example.com/webhook\ntotp_verification_url: https://example.com/totp\npersist_browser_session: false\nmodel:\n name: gpt-4.1\nworkflow_definition:\n parameters:\n - key: website_url\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n - key: name\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n - key: additional_information\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: |-\n Message: I'd love to learn more about your...\n Phone: 123-456-7890\n Inquiry type: sales\n Optional Subject: Hello from [Company Here]\n - key: email\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n blocks:\n - label: Fill_Out_Contact_Form\n continue_on_failure: true\n block_type: navigation\n url: \"{{website_url}}\"\n title: Fill_Out_Contact_Form\n engine: skyvern-1.0\n navigation_goal: >-\n Find the contact form. Fill out the contact us form and submit it. Your\n goal is complete when the page says your message has been sent. In the\n case you can't find a contact us form, terminate.\n\n\n Fill out required fields as best you can using the following\n information:\n\n {{name}}\n\n {{email}}\n\n {{additional_information}}\n error_code_mapping: null\n max_retries: 0\n max_steps_per_run: null\n complete_on_download: false\n download_suffix: null\n parameter_keys: []\n totp_identifier: null\n totp_verification_url: null\n cache_actions: false\n complete_criterion: \"\"\n terminate_criterion: \"\"\n include_action_history_in_verification: false\n - label: Extract_Email\n continue_on_failure: false\n block_type: extraction\n url: \"\"\n title: Extract_Email\n data_extraction_goal: \"Extract a company email if available \"\n data_schema: null\n max_retries: 0\n max_steps_per_run: null\n parameter_keys: []\n cache_actions: false\n'\n"
|
||||
},
|
||||
{
|
||||
"sdk": "python",
|
||||
@@ -663,7 +661,7 @@
|
||||
"code-samples": [
|
||||
{
|
||||
"sdk": "curl",
|
||||
"code": "curl -X POST https://api.skyvern.com/v1/workflows/wpid_123 --header 'x-api-key: {{x-api-key}}' --header 'Content-Type: text/plain' --data-raw 'title: Contact Forms\ndescription: Fill the contact form on the website\nproxy_location: RESIDENTIAL\nwebhook_callback_url: https://example.com/webhook\ntotp_verification_url: https://example.com/totp\npersist_browser_session: false\nmodel:\n name: gpt-4.1\nworkflow_definition:\n parameters:\n - key: website_url\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n - key: name\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n - key: additional_information\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: |-\n Message: I'd love to learn more about your...\n Phone: 123-456-7890\n Inquiry type: sales\n Optional Subject: Hello from [Company Here]\n - key: email\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n blocks:\n - label: Fill_Out_Contact_Form\n continue_on_failure: true\n block_type: navigation\n url: \"{{website_url}}\"\n title: Fill_Out_Contact_Form\n engine: skyvern-1.0\n navigation_goal: \u003E-\n Find the contact form. Fill out the contact us form and submit it. Your\n goal is complete when the page says your message has been sent. In the\n case you can't find a contact us form, terminate.\n\n\n Fill out required fields as best you can using the following\n information:\n\n {{name}}\n\n {{email}}\n\n {{additional_information}}\n error_code_mapping: null\n max_retries: 0\n max_steps_per_run: null\n complete_on_download: false\n download_suffix: null\n parameter_keys: []\n totp_identifier: null\n totp_verification_url: null\n cache_actions: false\n complete_criterion: \"\"\n terminate_criterion: \"\"\n include_action_history_in_verification: false\n - label: Extract_Email\n continue_on_failure: false\n block_type: extraction\n url: \"\"\n title: Extract_Email\n data_extraction_goal: \"Extract a company email if available \"\n data_schema: null\n max_retries: 0\n max_steps_per_run: null\n parameter_keys: []\n cache_actions: false\n'\n"
|
||||
"code": "curl -X POST https://api.skyvern.com/v1/workflows/wpid_123 --header 'x-api-key: {{x-api-key}}' --header 'Content-Type: text/plain' --data-raw 'title: Contact Forms\ndescription: Fill the contact form on the website\nproxy_location: RESIDENTIAL\nwebhook_callback_url: https://example.com/webhook\ntotp_verification_url: https://example.com/totp\npersist_browser_session: false\nmodel:\n name: gpt-4.1\nworkflow_definition:\n parameters:\n - key: website_url\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n - key: name\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n - key: additional_information\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: |-\n Message: I'd love to learn more about your...\n Phone: 123-456-7890\n Inquiry type: sales\n Optional Subject: Hello from [Company Here]\n - key: email\n description: null\n parameter_type: workflow\n workflow_parameter_type: string\n default_value: null\n blocks:\n - label: Fill_Out_Contact_Form\n continue_on_failure: true\n block_type: navigation\n url: \"{{website_url}}\"\n title: Fill_Out_Contact_Form\n engine: skyvern-1.0\n navigation_goal: >-\n Find the contact form. Fill out the contact us form and submit it. Your\n goal is complete when the page says your message has been sent. In the\n case you can't find a contact us form, terminate.\n\n\n Fill out required fields as best you can using the following\n information:\n\n {{name}}\n\n {{email}}\n\n {{additional_information}}\n error_code_mapping: null\n max_retries: 0\n max_steps_per_run: null\n complete_on_download: false\n download_suffix: null\n parameter_keys: []\n totp_identifier: null\n totp_verification_url: null\n cache_actions: false\n complete_criterion: \"\"\n terminate_criterion: \"\"\n include_action_history_in_verification: false\n - label: Extract_Email\n continue_on_failure: false\n block_type: extraction\n url: \"\"\n title: Extract_Email\n data_extraction_goal: \"Extract a company email if available \"\n data_schema: null\n max_retries: 0\n max_steps_per_run: null\n parameter_keys: []\n cache_actions: false\n'\n"
|
||||
},
|
||||
{
|
||||
"sdk": "python",
|
||||
@@ -721,9 +719,7 @@
|
||||
"description": "Successfully deleted workflow",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
|
||||
}
|
||||
"schema": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -951,9 +947,7 @@
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
|
||||
}
|
||||
"schema": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1172,9 +1166,7 @@
|
||||
"description": "Successfully closed browser session",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
|
||||
}
|
||||
"schema": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -1258,12 +1250,12 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Browser session not found"
|
||||
},
|
||||
"403": {
|
||||
"description": "Unauthorized - Invalid or missing authentication"
|
||||
},
|
||||
"404": {
|
||||
"description": "Browser session not found"
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
@@ -1466,7 +1458,9 @@
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"description": "Page number for pagination",
|
||||
"examples": [1],
|
||||
"examples": [
|
||||
1
|
||||
],
|
||||
"openapi_extra": {
|
||||
"x-fern-sdk-parameter-name": "page"
|
||||
},
|
||||
@@ -1483,7 +1477,9 @@
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"description": "Number of items per page",
|
||||
"examples": [10],
|
||||
"examples": [
|
||||
10
|
||||
],
|
||||
"openapi_extra": {
|
||||
"x-fern-sdk-parameter-name": "page_size"
|
||||
},
|
||||
@@ -1862,7 +1858,9 @@
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"description": "Page number for pagination",
|
||||
"examples": [1],
|
||||
"examples": [
|
||||
1
|
||||
],
|
||||
"default": 1,
|
||||
"title": "Page"
|
||||
},
|
||||
@@ -1876,7 +1874,9 @@
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"description": "Number of items per page",
|
||||
"examples": [10],
|
||||
"examples": [
|
||||
10
|
||||
],
|
||||
"default": 10,
|
||||
"title": "Page Size"
|
||||
},
|
||||
@@ -2121,9 +2121,7 @@
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
|
||||
}
|
||||
"schema": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -2355,9 +2353,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"items": {
|
||||
|
||||
},
|
||||
"items": {},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
@@ -3443,7 +3439,10 @@
|
||||
],
|
||||
"title": "Timeout",
|
||||
"description": "Timeout in minutes for the session. Timeout is applied after the session is started. Defaults to 60 minutes.",
|
||||
"examples": [60, 120]
|
||||
"examples": [
|
||||
60,
|
||||
120
|
||||
]
|
||||
},
|
||||
"browser_address": {
|
||||
"anyOf": [
|
||||
@@ -3769,9 +3768,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"items": {
|
||||
|
||||
},
|
||||
"items": {},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
@@ -3959,7 +3956,9 @@
|
||||
"type": "integer",
|
||||
"title": "Version",
|
||||
"description": "Script version number",
|
||||
"examples": [1]
|
||||
"examples": [
|
||||
1
|
||||
]
|
||||
},
|
||||
"run_id": {
|
||||
"anyOf": [
|
||||
@@ -4401,9 +4400,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"items": {
|
||||
|
||||
},
|
||||
"items": {},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
@@ -4621,9 +4618,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"items": {
|
||||
|
||||
},
|
||||
"items": {},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
@@ -4786,9 +4781,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"items": {
|
||||
|
||||
},
|
||||
"items": {},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
@@ -6306,9 +6299,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"items": {
|
||||
|
||||
},
|
||||
"items": {},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
@@ -6920,9 +6911,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"items": {
|
||||
|
||||
},
|
||||
"items": {},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
@@ -8404,9 +8393,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"items": {
|
||||
|
||||
},
|
||||
"items": {},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
@@ -8641,9 +8628,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"items": {
|
||||
|
||||
},
|
||||
"items": {},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
@@ -8847,9 +8832,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"items": {
|
||||
|
||||
},
|
||||
"items": {},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
@@ -8896,7 +8879,10 @@
|
||||
],
|
||||
"title": "Max Steps",
|
||||
"description": "\nMaximum number of steps the task can take. Task will fail if it exceeds this number. Cautions: you are charged per step so please set this number to a reasonable value. Contact sales@skyvern.com for custom pricing.\n",
|
||||
"examples": [10, 25]
|
||||
"examples": [
|
||||
10,
|
||||
25
|
||||
]
|
||||
},
|
||||
"webhook_url": {
|
||||
"anyOf": [
|
||||
@@ -9059,9 +9045,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"items": {
|
||||
|
||||
},
|
||||
"items": {},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
@@ -9821,9 +9805,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"items": {
|
||||
|
||||
},
|
||||
"items": {},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
@@ -10130,9 +10112,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"items": {
|
||||
|
||||
},
|
||||
"items": {},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
@@ -11229,9 +11209,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"items": {
|
||||
|
||||
},
|
||||
"items": {},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
@@ -11332,9 +11310,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"items": {
|
||||
|
||||
},
|
||||
"items": {},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
@@ -11550,9 +11526,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"items": {
|
||||
|
||||
},
|
||||
"items": {},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user