diff --git a/fern/docs.yml b/fern/docs.yml index a33d17af..2ab3f38a 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -74,10 +74,12 @@ navigation: path: getting-started/prompting-guide.mdx - section: Tasks contents: - - page: Task Features + - page: Run Tasks path: running-tasks/run-tasks.mdx - page: Visualizing Results path: running-tasks/visualizing-results.mdx + - page: Cancel Task Runs + path: running-tasks/cancel-runs.mdx - page: Webhooks FAQ path: running-tasks/webhooks-faq.mdx - page: Advanced Settings for tasks diff --git a/fern/images/run_tasks/cancel_run.png b/fern/images/run_tasks/cancel_run.png new file mode 100644 index 00000000..ab7bfc46 Binary files /dev/null and b/fern/images/run_tasks/cancel_run.png differ diff --git a/fern/images/visualizing_results/navigate_to_task.png b/fern/images/visualizing_results/navigate_to_task.png index 0ca0b1d4..b5973019 100644 Binary files a/fern/images/visualizing_results/navigate_to_task.png and b/fern/images/visualizing_results/navigate_to_task.png differ diff --git a/fern/running-tasks/cancel-runs.mdx b/fern/running-tasks/cancel-runs.mdx new file mode 100644 index 00000000..e951aeef --- /dev/null +++ b/fern/running-tasks/cancel-runs.mdx @@ -0,0 +1,12 @@ +--- +title: Cancel Task Runs +subtitle: How to cancel a run +slug: running-tasks/cancel-runs +--- + +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. + + + + + diff --git a/fern/running-tasks/run-tasks.mdx b/fern/running-tasks/run-tasks.mdx index 8e68bce9..67ad69dd 100644 --- a/fern/running-tasks/run-tasks.mdx +++ b/fern/running-tasks/run-tasks.mdx @@ -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. + Configure advanced settings in the UI @@ -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. \ No newline at end of file +See the [Browser Sessions](/browser-sessions/introduction) section to see how to create a browser session. \ No newline at end of file diff --git a/fern/running-tasks/visualizing-results.mdx b/fern/running-tasks/visualizing-results.mdx index 039e6591..eee50b98 100644 --- a/fern/running-tasks/visualizing-results.mdx +++ b/fern/running-tasks/visualizing-results.mdx @@ -5,8 +5,7 @@ slug: running-tasks/visualizing-results --- -# Visualizing Results -Skyvern comes bundled with a Visualizer to help you understand what's going on with your tasks. To get started, navigate to the task history page and click on any task. +Skyvern comes bundled with a Visualizer to help you understand what's going on with your tasks. To get started, navigate to the history page and click on any agent run. @@ -29,30 +28,4 @@ The task parameters are the inputs that you provided to Skyvern. This includes t ## Diagnostic Logs The diagnostics tab contains information used by Skyvern to do its processing. It includes information such as the annotated screenshots, action screenshots, element tree, prompt, action list, page HTML, and the raw LLM Request. - - -## Accessing results via API - -You can also access the results of a task via the API. - -The following endpoint can be used to get the results of a task: -``` -GET https://api.skyvern.com/api/v1/tasks/{task_id}/steps?page=1&page_size=15 -``` - -The response will contain a list of steps, alongside their actions and other relevant information - -The following endpoint can be used to retrieve artifacts for a specific step: -``` -GET https://api.skyvern.com/api/v1/tasks/{task_id}/steps/{step_id}/artifacts -``` - -## Artifacts configurations -By default, Skyvern stores artifacts, including video recording, screenshots, llm requests and responses, html and skyvern parsed html elements locally in the `/artifacts` folder under the skyvern repository. -You can also have skyvern to upload atrifacts to your s3 buckets. To do this, first set up these environment variables: -- `AWS_DEFAULT_REGION`: `us-east-1`, `us-west-1`, ... -- `AWS_ACCESS_KEY_ID` -- `AWS_SECRET_ACCESS_KEY` -- `SKYVERN_STORAGE_TYPE`: set it to be `s3`. The default is `local` - -Make sure these s3 buckets are created: `skyvern-artifacts`, `skyvern-screenshots`. These are the default bucket names skyvern uses. To customize the bucket names, change these two env variables: `AWS_S3_BUCKET_ARTIFACTS` and `AWS_S3_BUCKET_SCREENSHOTS` + \ No newline at end of file