update blog and docs urls (#3671)

Signed-off-by: Benji Visser <benji@093b.org>
This commit is contained in:
Benji Visser
2025-10-10 10:40:58 -04:00
committed by GitHub
parent af23e27822
commit cfe77924e3
15 changed files with 72 additions and 72 deletions

View File

@@ -3,12 +3,12 @@ title: Tasks API V2
description: 'Powered 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
Request type: `POST`
Production:`https://api.skyvern.com/api/v2/tasks/`
### Header
### Header
| Parameter | Type | Required? | Sample Value | Description |
| --- | --- | --- | --- | --- |
@@ -25,13 +25,13 @@ Production:`https://api.skyvern.com/api/v2/tasks/`
| webhook_callback_url | HttpUrl | no | https://mywebsite.com/webhook | The callback URL once our system is finished processing this async task |
| proxy_location | String | no | RESIDENTIAL | Proxy location for the web-browsing request. Please pass RESIDENTIAL as a value |
| totp_verification_url | HttpUrl | no | https://mywebsite.com/two_factor_code | The url of your TOTP endpoint. If this field is provided, Skyvern will call the url to fetch the TOTP/2FA/MFA code when needed |
| totp_identifier | String | no | myemail@example.com / 4155558888 | The email address or the phone number which receives the TOTP/2FA/MFA code. If this field is provided, Skyvern will fetch the code that is pushed to [Skyvern's TOTP API](https://docs.skyvern.com/running-tasks/advanced-features#push-code-to-skyvern) |
| totp_identifier | String | no | myemail@example.com / 4155558888 | The email address or the phone number which receives the TOTP/2FA/MFA code. If this field is provided, Skyvern will fetch the code that is pushed to [Skyvern's TOTP API](https://www.skyvern.com/docs/running-tasks/advanced-features#push-code-to-skyvern) |
| extracted_information_schema | JSON object, list, string | no | `{"type": "object", "properties": {"title": {"type": "string", "description": "The title of the post"}, "url": {"type": "string", "description": "The url link to the post"}}}` | Use jsonschema to define the schema of the output. You can also describe the schema but it won't be as reliable as defining it in the jsonschema format |
## Example Request (Apply for a job)
```python
POST https://api.skyvern.com/api/v2/tasks/
POST https://api.skyvern.com/api/v2/tasks/
{
"user_prompt": "Find a route between Chicago to Los Angeles on google maps, then print the route details.",
@@ -63,9 +63,9 @@ Each task has an associated `task_id` -- a unique identifier you can use to look
## Response Webhook - Task conclusion (POST)
If a `webhook_callback_url` is specified within your task request, Skyvern will make a callback to your system letting you know that it has either finished, terminated or failed a task execution.
If a `webhook_callback_url` is specified within your task request, Skyvern will make a callback to your system letting you know that it has either finished, terminated or failed a task execution.
The following headers can be used to validate it's an authentic Skyvern request.
The following headers can be used to validate it's an authentic Skyvern request.
### Headers
@@ -75,7 +75,7 @@ The following headers can be used to validate it's an authentic Skyvern request.
| x-skyvern-timestamp | String | yes | 1531420618 | Timestamp used to decode and validate the incoming webhook call<br/><br/>Well be using the same strategy slack uses, as defined here: https://api.slack.com/authentication/verifying-requests-from-slack#making__validating-a-request |
### Body
These parameters are sent in the body of the request to `webhook_callback_url`.
These parameters are sent in the body of the request to `webhook_callback_url`.
Here's an example of the webhook body:
```

View File

@@ -7,7 +7,7 @@ slug: running-tasks/run-tasks
- [Run Task API](/api-reference/api-reference/agent/run-task)
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>
@@ -20,7 +20,7 @@ Parameter: `engine`
This parameter defines the engine that powers the agent task.
- `skyvern-2.0`: this is the default engine. It's the latest Skyvern agent that performs really well with complex and multi-step tasks. It scores **state of the art** 85.85% on the [WebVoyager benchmark](https://blog.skyvern.com/skyvern-2-0-state-of-the-art-web-navigation-with-85-8-on-webvoyager-eval/).
- `skyvern-2.0`: this is the default engine. It's the latest Skyvern agent that performs really well with complex and multi-step tasks. It scores **state of the art** 85.85% on the [WebVoyager benchmark](https://www.skyvern.com/blog/skyvern-2-0-state-of-the-art-web-navigation-with-85-8-on-webvoyager-eval/).
- `skyvern-1.0`: performs really well for tasks with a simple goal, like filling a form, or searching for information on Google.
- `openai-cua`: uses OpenAI's CUA model.
- `anthropic-cua`: uses Anthropic's Claude Sonnet 3.7 model with the computer use tool.
@@ -80,7 +80,7 @@ You can set a browser session for a task. Having a browser session persist the r
See the [Browser Sessions](/browser-sessions/introduction) section to see how to create a browser session.
## Use Cases
### Control Your Own Browser (Chrome)
### Control Your Own Browser (Chrome)
<Warning>Since [Chrome 136](https://developer.chrome.com/blog/remote-debugging-port), Chrome refuses any CDP connect to the browser using the default user_data_dir. In order to use your browser data, Skyvern copies your default user_data_dir to `./tmp/user_data_dir` the first time connecting to your local browser.</Warning>
**Just With Python Code**