From cfe77924e30d1419049be2faff3522809392f427 Mon Sep 17 00:00:00 2001 From: Benji Visser Date: Fri, 10 Oct 2025 10:40:58 -0400 Subject: [PATCH] update blog and docs urls (#3671) Signed-off-by: Benji Visser --- CONTRIBUTING.md | 6 ++-- README.md | 18 +++++------ fern/docs.yml | 2 +- fern/integrations/zapier.mdx | 2 +- fern/openapi/skyvern_openapi.json | 12 +++---- fern/running-tasks/api-v2-spec.mdx | 14 ++++---- fern/running-tasks/run-tasks.mdx | 6 ++-- .../credentials/PasswordCredentialContent.tsx | 2 +- .../workflows/WorkflowsBetaAlertCard.tsx | 2 +- skyvern/cli/docs.py | 2 +- skyvern/client/client.py | 24 +++++++------- skyvern/client/types/task_run_request.py | 32 +++++++++---------- skyvern/client/types/workflow_run_request.py | 14 ++++---- skyvern/schemas/docs/doc_strings.py | 6 ++-- skyvern/schemas/runs.py | 2 +- 15 files changed, 72 insertions(+), 72 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 44c66c44..cbc1304d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,7 +60,7 @@ to . ## I Have a Question -> If you want to ask a question, we assume that you have read the available [Documentation](docs.skyvern.com). +> If you want to ask a question, we assume that you have read the available [Documentation](www.skyvern.com/docs). Before you ask a question, it is best to search for existing [Issues](https://github.com/Skyvern-AI/skyvern-agent/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first. @@ -100,7 +100,7 @@ Depending on how large the project is, you may want to outsource the questioning A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. - Make sure that you are using the latest version. -- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](docs.skyvern.com). If you are looking for support, you might want to check [this section](#i-have-a-question)). +- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](www.skyvern.com/docs). If you are looking for support, you might want to check [this section](#i-have-a-question)). - To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/Skyvern-AI/skyvern-agentissues?q=label%3Abug). - Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue. - Collect information about the bug: @@ -140,7 +140,7 @@ This section guides you through submitting an enhancement suggestion for Skyvern #### Before Submitting an Enhancement - Make sure that you are using the latest version. -- Read the [documentation](docs.skyvern.com) carefully and find out if the functionality is already covered, maybe by an individual configuration. +- Read the [documentation](www.skyvern.com/docs) carefully and find out if the functionality is already covered, maybe by an individual configuration. - Perform a [search](https://github.com/Skyvern-AI/skyvern-agent/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. - Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. diff --git a/README.md b/README.md index 51cc9207..5f65be10 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@

- + @@ -52,7 +52,7 @@ This approach has a few advantages: 1. If you wanted to get an auto insurance quote from Geico, the answer to a common question "Were you eligible to drive at 18?" could be inferred from the driver receiving their license at age 16 1. If you were doing competitor analysis, it's understanding that an Arnold Palmer 22 oz can at 7/11 is almost definitely the same product as a 23 oz can at Gopuff (even though the sizes are slightly different, which could be a rounding error!) -A detailed technical report can be found [here](https://blog.skyvern.com/skyvern-2-0-state-of-the-art-web-navigation-with-85-8-on-webvoyager-eval/). +A detailed technical report can be found [here](https://www.skyvern.com/blog/skyvern-2-0-state-of-the-art-web-navigation-with-85-8-on-webvoyager-eval/). # Demo @@ -60,7 +60,7 @@ https://github.com/user-attachments/assets/5cab4668-e8e2-4982-8551-aab05ff73a7f # Performance & Evaluation -Skyvern has SOTA performance on the [WebBench benchmark](webbench.ai) with a 64.4% accuracy. The technical report + evaluation can be found [here](https://blog.skyvern.com/web-bench-a-new-way-to-compare-ai-browser-agents/) +Skyvern has SOTA performance on the [WebBench benchmark](webbench.ai) with a 64.4% accuracy. The technical report + evaluation can be found [here](https://www.skyvern.com/blog/web-bench-a-new-way-to-compare-ai-browser-agents/)

@@ -325,7 +325,7 @@ Examples include: 1. Email based 2FA 1. SMS based 2FA -🔐 Learn more about 2FA support [here](https://docs.skyvern.com/credentials/totp). +🔐 Learn more about 2FA support [here](https://www.skyvern.com/docs/credentials/totp). ### Password Manager Integrations Skyvern currently supports the following password manager integrations: @@ -342,11 +342,11 @@ See the MCP documentation [here](https://github.com/Skyvern-AI/skyvern/blob/main ## Zapier / Make.com / N8N Integration Skyvern supports Zapier, Make.com, and N8N to allow you to connect your Skyvern workflows to other apps. -* [Zapier](https://docs.skyvern.com/integrations/zapier) -* [Make.com](https://docs.skyvern.com/integrations/make.com) -* [N8N](https://docs.skyvern.com/integrations/n8n) +* [Zapier](https://www.skyvern.com/docs/integrations/zapier) +* [Make.com](https://www.skyvern.com/docs/integrations/make.com) +* [N8N](https://www.skyvern.com/docs/integrations/n8n) -🔐 Learn more about 2FA support [here](https://docs.skyvern.com/credentials/totp). +🔐 Learn more about 2FA support [here](https://www.skyvern.com/docs/credentials/totp). # Real-world examples of Skyvern @@ -412,7 +412,7 @@ Make sure to have [uv](https://docs.astral.sh/uv/getting-started/installation/) # Documentation -More extensive documentation can be found on our [📕 docs page](https://docs.skyvern.com). Please let us know if something is unclear or missing by opening an issue or reaching out to us [via email](mailto:founders@skyvern.com) or [discord](https://discord.gg/fG2XXEuQX3). +More extensive documentation can be found on our [📕 docs page](https://www.skyvern.com/docs). Please let us know if something is unclear or missing by opening an issue or reaching out to us [via email](mailto:founders@skyvern.com) or [discord](https://discord.gg/fG2XXEuQX3). # Supported LLMs | Provider | Supported Models | diff --git a/fern/docs.yml b/fern/docs.yml index 56b502e9..68ffbe4f 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -43,7 +43,7 @@ tabs: blog: display-name: Blog icon: newspaper - href: https://blog.skyvern.com + href: https://www.skyvern.com/blog community: display-name: Community icon: fa-brands fa-discord diff --git a/fern/integrations/zapier.mdx b/fern/integrations/zapier.mdx index 32480f48..a3e408f7 100644 --- a/fern/integrations/zapier.mdx +++ b/fern/integrations/zapier.mdx @@ -12,7 +12,7 @@ slug: integrations/zapier 2. Add a Skyvern Block, and select the “Run a Task” Action Event -3. A required “Account” section should populate, here is where you paste your [API Key](https://docs.skyvern.com/running-tasks/introduction#getting-your-api-key) +3. A required “Account” section should populate, here is where you paste your [API Key](https://www.skyvern.com/docs/running-tasks/introduction#getting-your-api-key) 4. Once you’ve connected your account, you can press next and proceed to the second step “Configure” ![image](../images/zapier/z.1.png) diff --git a/fern/openapi/skyvern_openapi.json b/fern/openapi/skyvern_openapi.json index 4b7dac1a..db963e67 100644 --- a/fern/openapi/skyvern_openapi.json +++ b/fern/openapi/skyvern_openapi.json @@ -9932,7 +9932,7 @@ } ], "title": "Webhook Url", - "description": "\nAfter a run is finished, send an update to this URL. Refer to https://docs.skyvern.com/running-tasks/webhooks-faq for more details.\n", + "description": "\nAfter a run is finished, send an update to this URL. Refer to https://www.skyvern.com/docs/running-tasks/webhooks-faq for more details.\n", "examples": [ "https://my-site.com/webhook" ] @@ -9947,7 +9947,7 @@ } ], "title": "Totp Identifier", - "description": "\nIdentifier for the TOTP/2FA/MFA code when the code is pushed to Skyvern. Refer to https://docs.skyvern.com/credentials/totp#option-3-push-code-to-skyvern for more details.\n", + "description": "\nIdentifier for the TOTP/2FA/MFA code when the code is pushed to Skyvern. Refer to https://www.skyvern.com/docs/credentials/totp#option-3-push-code-to-skyvern for more details.\n", "examples": [ "john.doe@example.com", "4155555555", @@ -9964,7 +9964,7 @@ } ], "title": "Totp Url", - "description": "\nURL that serves TOTP/2FA/MFA codes for Skyvern to use during the workflow run. Refer to https://docs.skyvern.com/credentials/totp#option-2-get-code-from-your-endpoint for more details.\n", + "description": "\nURL that serves TOTP/2FA/MFA codes for Skyvern to use during the workflow run. Refer to https://www.skyvern.com/docs/credentials/totp#option-2-get-code-from-your-endpoint for more details.\n", "examples": [ "https://my-totp-service.com/totp" ] @@ -13220,7 +13220,7 @@ } ], "title": "Webhook Url", - "description": "URL to send workflow status updates to after a run is finished. Refer to https://docs.skyvern.com/running-tasks/webhooks-faq for webhook questions." + "description": "URL to send workflow status updates to after a run is finished. Refer to https://www.skyvern.com/docs/running-tasks/webhooks-faq for webhook questions." }, "totp_url": { "anyOf": [ @@ -13232,7 +13232,7 @@ } ], "title": "Totp Url", - "description": "\nURL that serves TOTP/2FA/MFA codes for Skyvern to use during the workflow run. Refer to https://docs.skyvern.com/credentials/totp#option-2-get-code-from-your-endpoint for more details.\n", + "description": "\nURL that serves TOTP/2FA/MFA codes for Skyvern to use during the workflow run. Refer to https://www.skyvern.com/docs/credentials/totp#option-2-get-code-from-your-endpoint for more details.\n", "examples": [ "https://my-totp-service.com/totp" ] @@ -13247,7 +13247,7 @@ } ], "title": "Totp Identifier", - "description": "\nIdentifier for the TOTP/2FA/MFA code when the code is pushed to Skyvern. Refer to https://docs.skyvern.com/credentials/totp#option-3-push-code-to-skyvern for more details.\n", + "description": "\nIdentifier for the TOTP/2FA/MFA code when the code is pushed to Skyvern. Refer to https://www.skyvern.com/docs/credentials/totp#option-3-push-code-to-skyvern for more details.\n", "examples": [ "john.doe@example.com", "4155555555", diff --git a/fern/running-tasks/api-v2-spec.mdx b/fern/running-tasks/api-v2-spec.mdx index 8298a6e1..017ae3c6 100644 --- a/fern/running-tasks/api-v2-spec.mdx +++ b/fern/running-tasks/api-v2-spec.mdx @@ -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

We’ll 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: ``` diff --git a/fern/running-tasks/run-tasks.mdx b/fern/running-tasks/run-tasks.mdx index 3195a39b..1936aa79 100644 --- a/fern/running-tasks/run-tasks.mdx +++ b/fern/running-tasks/run-tasks.mdx @@ -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. - + Configure advanced settings in the UI @@ -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) 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. **Just With Python Code** diff --git a/skyvern-frontend/src/routes/credentials/PasswordCredentialContent.tsx b/skyvern-frontend/src/routes/credentials/PasswordCredentialContent.tsx index 7aef2ce4..e591ce10 100644 --- a/skyvern-frontend/src/routes/credentials/PasswordCredentialContent.tsx +++ b/skyvern-frontend/src/routes/credentials/PasswordCredentialContent.tsx @@ -194,7 +194,7 @@ function PasswordCredentialContent({ {" "} or{" "}