diff --git a/docs/images/visualizing_results/navigate_to_task.png b/docs/images/visualizing_results/navigate_to_task.png new file mode 100644 index 00000000..0ca0b1d4 Binary files /dev/null and b/docs/images/visualizing_results/navigate_to_task.png differ diff --git a/docs/images/visualizing_results/view_actions.png b/docs/images/visualizing_results/view_actions.png new file mode 100644 index 00000000..86dd985a Binary files /dev/null and b/docs/images/visualizing_results/view_actions.png differ diff --git a/docs/images/visualizing_results/view_diagnostics.png b/docs/images/visualizing_results/view_diagnostics.png new file mode 100644 index 00000000..f019e257 Binary files /dev/null and b/docs/images/visualizing_results/view_diagnostics.png differ diff --git a/docs/images/visualizing_results/view_parameters.png b/docs/images/visualizing_results/view_parameters.png new file mode 100644 index 00000000..d06b221d Binary files /dev/null and b/docs/images/visualizing_results/view_parameters.png differ diff --git a/docs/images/visualizing_results/view_recording.png b/docs/images/visualizing_results/view_recording.png new file mode 100644 index 00000000..bedfe2c9 Binary files /dev/null and b/docs/images/visualizing_results/view_recording.png differ diff --git a/docs/running-tasks/advanced-features.mdx b/docs/running-tasks/advanced-features.mdx index 2b8c58dd..55561174 100644 --- a/docs/running-tasks/advanced-features.mdx +++ b/docs/running-tasks/advanced-features.mdx @@ -1,2 +1,22 @@ +--- +title: Advanced Settings for tasks +description: 'How to use advanced settings for tasks' +--- - \ No newline at end of file +# Advanced Settings for tasks + +## Overriding the max_steps paramter in the task +If you want the task to execute for a specific number of steps, you can use the `x-max-steps-override` header in the request. This will override the default `max_steps` parameter set in the task. + +```json +POST https://api.skyvern.com/api/v1/tasks + +Headers: +{ + "x-api-key": "YOUR_API_KEY", + "x-max-steps-override": 10 +} + +Body: +.. usual task body .. +``` diff --git a/docs/running-tasks/visualizing-results.mdx b/docs/running-tasks/visualizing-results.mdx index 2b8c58dd..1c2fcde9 100644 --- a/docs/running-tasks/visualizing-results.mdx +++ b/docs/running-tasks/visualizing-results.mdx @@ -1,2 +1,46 @@ +--- +title: Visualizing Results +description: 'How to understand the information shown by Skyvern' +--- - \ No newline at end of file +# 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. + + + + +## Actions +Each action that Skyvern takes can be viewed in the Action viewer. It's accompanied with a screenshot of the screen state *after* the action has executed + + + +## Recording +Each Skyvern task comes with a recording of the entire operation (end to end). To view the recording, click on the recording tab. + + + +## Task Parameters +The task parameters are the inputs that you provided to Skyvern. This includes the URL, the extraction rules, and any other information that you provided to Skyvern. + + + +## 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 +``` diff --git a/docs/running-tasks/webhooks-faq.mdx b/docs/running-tasks/webhooks-faq.mdx index 281d63f6..8f945a60 100644 --- a/docs/running-tasks/webhooks-faq.mdx +++ b/docs/running-tasks/webhooks-faq.mdx @@ -28,9 +28,3 @@ SKYVERN_API_KEY: this is the [api key](/running-tasks/introduction) specific to | Parameter | Type | Required? | Sample Value | Description | | --- | --- | --- | --- | --- | | webhook_callback_url | String | yes | … | | - -# Required Headers - -| Parameter | Type | Required? | Sample Value | Description | -| --- | --- | --- | --- | --- | -| x-api-key | String | yes | eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e
yJleHAiOjQ4MjU0MjI5NzUsInN1YiI6
Im9fMTA2MTUxNzEyNjQ5ODUxMzQ2In0 | Bearer token that gives your backend access to the Skyvern API. This will be manually provided by us |