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

fix api v2 doc (#1583)

Browse Source
This commit is contained in:
Shuchang Zheng
2025-01-16 12:24:26 -08:00
committed by GitHub
parent 0d0c4f5626
commit fbf328afcd
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/running-tasks/api-v2-spec.mdx
View File

@@ -1,6 +1,6 @@
--- ---
title: Tasks API V2 title: Tasks API V2
description: 'The latest version of Skyvern agent task, with better reasoning and validation' description: 'Powerd by the latest version of Skyvern agent, with better reasoning and validation. State of the art web navigation with 85.8% on WebVoyager Eval'
--- ---
## Request - Initiate a task ## Request - Initiate a task
@@ -51,7 +51,7 @@ Each task has an associated `task_id` -- a unique identifier you can use to look
| workflow_run_id | String | yes | wr_123456 | The ID of the workflow run | | workflow_run_id | String | yes | wr_123456 | The ID of the workflow run |
| workflow_permanent_id | String | yes | wpid_123456 | The workflow permanent id | | workflow_permanent_id | String | yes | wpid_123456 | The workflow permanent id |
| summary | String | no | The summary of what skyvern did when the task is completed | | summary | String | no | The summary of what skyvern did when the task is completed |
| output | Object | no | { "name": "Chris P. Bacon", "email": "chris@pbacon.com" } | The output of the task. This is the structured data that skyvern extracted from the website. | | output | Object | no | `{ "name": "Chris P. Bacon", "email": "chris@pbacon.com" }` | The output of the task. This is the structured data that skyvern extracted from the website. |
| webhook_callback_url | HttpUrl | no | https://mywebsite.com/webhook | The url of your webhook endpoint if sent to execute the task. | | webhook_callback_url | HttpUrl | no | https://mywebsite.com/webhook | The url of your webhook endpoint if sent to execute the task. |
| totp_verification_url | HttpUrl | no | https://mywebsite.com/two_factor_code | The url of your TOTP endpoint if sent to execute the task. | | totp_verification_url | HttpUrl | no | https://mywebsite.com/two_factor_code | The url of your TOTP endpoint if sent to execute the task. |
| totp_identifier | String | no | myemail@example.com / 4155558888 | The totp_identifier sent to execute the task.| | totp_identifier | String | no | myemail@example.com / 4155558888 | The totp_identifier sent to execute the task.|