vodorod/Dorod-Sky
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

update openapi json (#3193)

Browse Source
This commit is contained in:
Shuchang Zheng
2025-08-14 15:24:48 -07:00
committed by GitHub
parent 6b8d29a23d
commit 257f0e77e3
1 changed files with 75 additions and 253 deletions
Download Patch File Download Diff File Expand all files Collapse all files

328
fern/openapi/skyvern_openapi.json
View File

@@ -363,7 +363,9 @@
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
"schema": {
}
}
}
},
@@ -450,7 +452,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: >-\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: \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"
},
{
"sdk": "python",
@@ -661,7 +663,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: >-\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: \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"
},
{
"sdk": "python",
@@ -719,7 +721,9 @@
"description": "Successfully deleted workflow",
"content": {
"application/json": {
"schema": {}
"schema": {
}
}
}
},
@@ -947,7 +951,9 @@
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
"schema": {
}
}
}
},
@@ -1166,7 +1172,9 @@
"description": "Successfully closed browser session",
"content": {
"application/json": {
"schema": {}
"schema": {
}
}
}
},
@@ -1250,12 +1258,12 @@
}
}
},
"403": {
"description": "Unauthorized - Invalid or missing authentication"
},
"404": {
"description": "Browser session not found"
},
"403": {
"description": "Unauthorized - Invalid or missing authentication"
},
"422": {
"description": "Validation Error",
"content": {
@@ -1458,9 +1466,7 @@
"type": "integer",
"minimum": 1,
"description": "Page number for pagination",
"examples": [
1
],
"examples": [1],
"openapi_extra": {
"x-fern-sdk-parameter-name": "page"
},
@@ -1477,9 +1483,7 @@
"type": "integer",
"minimum": 1,
"description": "Number of items per page",
"examples": [
10
],
"examples": [10],
"openapi_extra": {
"x-fern-sdk-parameter-name": "page_size"
},
@@ -1699,126 +1703,6 @@
]
}
},
"/v1/credentials/onepassword/get": {
"get": {
"tags": [
"Auth Tokens"
],
"summary": "Get OnePassword service account token",
"description": "Retrieves the current OnePassword service account token for the organization.",
"operationId": "get_onepassword_token_v1_credentials_onepassword_get_get",
"parameters": [
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
"title": "X-Api-Key"
},
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOnePasswordTokenResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-method-name": "get_onepassword_token"
}
},
"/v1/credentials/onepassword/create": {
"post": {
"tags": [
"Auth Tokens"
],
"summary": "Create or update OnePassword service account token",
"description": "Creates or updates a OnePassword service account token for the current organization. Only one valid token is allowed per organization.",
"operationId": "update_onepassword_token_v1_credentials_onepassword_create_post",
"parameters": [
{
"name": "x-api-key",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
"title": "X-Api-Key"
},
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOnePasswordTokenRequest",
"description": "The OnePassword token data",
"openapi_extra": {
"x-fern-sdk-parameter-name": "data"
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOnePasswordTokenResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"x-fern-sdk-method-name": "update_onepassword_token"
}
},
"/v1/run/tasks/login": {
"post": {
"tags": [
@@ -1978,9 +1862,7 @@
"type": "integer",
"minimum": 1,
"description": "Page number for pagination",
"examples": [
1
],
"examples": [1],
"default": 1,
"title": "Page"
},
@@ -1994,9 +1876,7 @@
"type": "integer",
"minimum": 1,
"description": "Number of items per page",
"examples": [
10
],
"examples": [10],
"default": 10,
"title": "Page Size"
},
@@ -2241,7 +2121,9 @@
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
"schema": {
}
}
}
},
@@ -2473,7 +2355,9 @@
"type": "object"
},
{
"items": {},
"items": {
},
"type": "array"
},
{
@@ -3559,10 +3443,7 @@
],
"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": [
@@ -3888,7 +3769,9 @@
"type": "object"
},
{
"items": {},
"items": {
},
"type": "array"
},
{
@@ -4003,38 +3886,6 @@
"title": "CreateCredentialRequest",
"description": "Request model for creating a new credential."
},
"CreateOnePasswordTokenRequest": {
"properties": {
"token": {
"type": "string",
"title": "Token",
"description": "The 1Password service account token",
"examples": [
"op_1234567890abcdef"
]
}
},
"type": "object",
"required": [
"token"
],
"title": "CreateOnePasswordTokenRequest",
"description": "Request model for creating or updating a 1Password service account token."
},
"CreateOnePasswordTokenResponse": {
"properties": {
"token": {
"$ref": "#/components/schemas/OrganizationAuthToken",
"description": "The created or updated 1Password service account token"
}
},
"type": "object",
"required": [
"token"
],
"title": "CreateOnePasswordTokenResponse",
"description": "Response model for 1Password token operations."
},
"CreateScriptRequest": {
"properties": {
"workflow_id": {
@@ -4108,9 +3959,7 @@
"type": "integer",
"title": "Version",
"description": "Script version number",
"examples": [
1
]
"examples": [1]
},
"run_id": {
"anyOf": [
@@ -4552,7 +4401,9 @@
"type": "object"
},
{
"items": {},
"items": {
},
"type": "array"
},
{
@@ -4770,7 +4621,9 @@
"type": "object"
},
{
"items": {},
"items": {
},
"type": "array"
},
{
@@ -4933,7 +4786,9 @@
"type": "object"
},
{
"items": {},
"items": {
},
"type": "array"
},
{
@@ -6451,7 +6306,9 @@
"type": "object"
},
{
"items": {},
"items": {
},
"type": "array"
},
{
@@ -7063,7 +6920,9 @@
"type": "object"
},
{
"items": {},
"items": {
},
"type": "array"
},
{
@@ -7628,58 +7487,6 @@
],
"title": "OnePasswordCredentialParameterYAML"
},
"OrganizationAuthToken": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"organization_id": {
"type": "string",
"title": "Organization Id"
},
"token_type": {
"$ref": "#/components/schemas/OrganizationAuthTokenType"
},
"token": {
"type": "string",
"title": "Token"
},
"valid": {
"type": "boolean",
"title": "Valid"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"modified_at": {
"type": "string",
"format": "date-time",
"title": "Modified At"
}
},
"type": "object",
"required": [
"id",
"organization_id",
"token_type",
"token",
"valid",
"created_at",
"modified_at"
],
"title": "OrganizationAuthToken"
},
"OrganizationAuthTokenType": {
"type": "string",
"enum": [
"api",
"onepassword_service_account"
],
"title": "OrganizationAuthTokenType"
},
"OutputParameter": {
"properties": {
"parameter_type": {
@@ -8597,7 +8404,9 @@
"type": "object"
},
{
"items": {},
"items": {
},
"type": "array"
},
{
@@ -8832,7 +8641,9 @@
"type": "object"
},
{
"items": {},
"items": {
},
"type": "array"
},
{
@@ -9036,7 +8847,9 @@
"type": "object"
},
{
"items": {},
"items": {
},
"type": "array"
},
{
@@ -9083,10 +8896,7 @@
],
"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": [
@@ -9249,7 +9059,9 @@
"type": "object"
},
{
"items": {},
"items": {
},
"type": "array"
},
{
@@ -10009,7 +9821,9 @@
"type": "object"
},
{
"items": {},
"items": {
},
"type": "array"
},
{
@@ -10316,7 +10130,9 @@
"type": "object"
},
{
"items": {},
"items": {
},
"type": "array"
},
{
@@ -11413,7 +11229,9 @@
"type": "object"
},
{
"items": {},
"items": {
},
"type": "array"
},
{
@@ -11514,7 +11332,9 @@
"type": "object"
},
{
"items": {},
"items": {
},
"type": "array"
},
{
@@ -11730,7 +11550,9 @@
"type": "object"
},
{
"items": {},
"items": {
},
"type": "array"
},
{