simplify docs for tasks (#2487)
This commit is contained in:
@@ -4,12 +4,11 @@ slug: running-tasks/run-tasks
|
||||
---
|
||||
|
||||
## Run A Task
|
||||
- See the [Quickstart](/getting-started/quickstart) to run a simple task.
|
||||
- See the [Run Task API and SDK](/api-reference/api-reference/agent/run-task).
|
||||
- [Quickstart](/getting-started/quickstart) to run a task.
|
||||
- [Run Task API](/api-reference/api-reference/agent/run-task)
|
||||
|
||||
There are many features to help automate and improve your task experience. Check out the features along with its parameter name below.
|
||||
|
||||
All the features are enabled through API & SDK. Some features are enabled through [Skyvern's Discover page](https://app.skyvern.com/discover) as well.
|
||||
Every feature in this page is enabled through API & SDK. Some features are enabled through [Skyvern's Discover page](https://app.skyvern.com/discover) as well.
|
||||
|
||||
<Frame caption="Run Task UI">
|
||||
<img src="../images/run_tasks/ui_run_task.png" alt="Configure advanced settings in the UI" width="400" />
|
||||
</Frame>
|
||||
@@ -65,21 +64,15 @@ Parameter: `proxy_location`
|
||||
|
||||
Some websites block requests from certain countries. You can set a proxy location to route the browser traffic through.
|
||||
|
||||
### TOTP (2FA/MFA/Verification) Code
|
||||
### 2FA Support (TOTP)
|
||||
- [totp_identifier](/api-reference/api-reference/agent/run-task#request.body.totp_identifier): Skyvern can receive the TOTP code and use this identifier to identify the code for authentication.
|
||||
- [totp_url](/api-reference/api-reference/agent/run-task#request.body.totp_url): Skyvern makes a request to this URL to fetch the TOTP code when needed.
|
||||
|
||||
More details can be found in the [TOTP section](/credentials/totp).
|
||||
|
||||
### [Run Task in a Persistent Browser Session](/api-reference/api-reference/agent/run-task#request.body.browser_session_id) (`browser_session_id`)
|
||||
You can set a browser session to use for the task. Having a browser session can persist the real-time state of the browser, so that the next run can continue from where the previous run left off.
|
||||
### [Run Task In A Persistent Browser Session](/api-reference/api-reference/agent/run-task#request.body.browser_session_id)
|
||||
Parameter: `browser_session_id`
|
||||
|
||||
See the [Browser Sessions](/browser-sessions/introduction) section to see how to create a browser session.
|
||||
You can set a browser session for a task. Having a browser session persist the real-time state of the browser, so that the next run can continue from where the previous run left off.
|
||||
|
||||
## View A Task
|
||||
Skyvern has a rich feature for you to understand what's happening with your task. See [Visualizing Results](/running-tasks/visualizing-results).
|
||||
|
||||
The [GET Run](/api-reference/api-reference/agent/get-run) endpoint shows the status of the task.
|
||||
|
||||
## Cancel A Task
|
||||
A task that has not started or is in the running state can be cancelled through the UI. It can also be done with the [Cancel Run](/api-reference/api-reference/agent/cancel-run) endpoint.
|
||||
See the [Browser Sessions](/browser-sessions/introduction) section to see how to create a browser session.
|
||||
Reference in New Issue
Block a user