mirror of
https://github.com/Skyvern-AI/skyvern.git
synced 2026-04-26 10:41:14 +00:00
update blog and docs urls (#3671)
Signed-off-by: Benji Visser <benji@093b.org>
This commit is contained in:
Benji Visser
GitHub
parent
af23e27822
commit
cfe77924e3
15 changed files with 72 additions and 72 deletions
|
|
@ -60,7 +60,7 @@ to <enforcement@skyvern.com>.
|
|||
|
||||
## 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.
|
||||
|
||||
|
|
|
|||
18
README.md
18
README.md
|
|
@ -14,7 +14,7 @@
|
|||
</p>
|
||||
<p align="center">
|
||||
<a href="https://www.skyvern.com/"><img src="https://img.shields.io/badge/Website-blue?logo=googlechrome&logoColor=black"/></a>
|
||||
<a href="https://docs.skyvern.com/"><img src="https://img.shields.io/badge/Docs-yellow?logo=gitbook&logoColor=black"/></a>
|
||||
<a href="https://www.skyvern.com/docs/"><img src="https://img.shields.io/badge/Docs-yellow?logo=gitbook&logoColor=black"/></a>
|
||||
<a href="https://discord.gg/fG2XXEuQX3"><img src="https://img.shields.io/discord/1212486326352617534?logo=discord&label=discord"/></a>
|
||||
<!-- <a href="https://pepy.tech/project/skyvern" target="_blank"><img src="https://static.pepy.tech/badge/skyvern" alt="Total Downloads"/></a> -->
|
||||
<a href="https://github.com/skyvern-ai/skyvern"><img src="https://img.shields.io/github/stars/skyvern-ai/skyvern" /></a>
|
||||
|
|
@ -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
|
||||
<!-- Redo 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/)
|
||||
|
||||
<p align="center">
|
||||
<img src="fern/images/performance/webbench_overall.png"/>
|
||||
|
|
@ -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 |
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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”
|
||||
|
||||
|
|
|
|||
|
|
@ -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",
|
||||
|
|
|
|||
|
|
@ -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/>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:
|
||||
```
|
||||
|
|
|
|||
|
|
@ -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**
|
||||
|
|
|
|||
|
|
@ -194,7 +194,7 @@ function PasswordCredentialContent({
|
|||
</Link>{" "}
|
||||
or{" "}
|
||||
<Link
|
||||
to="https://docs.skyvern.com/running-tasks/advanced-features#time-based-one-time-password-totp"
|
||||
to="https://www.skyvern.com/docs/running-tasks/advanced-features#time-based-one-time-password-totp"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="underline underline-offset-2"
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ function WorkflowsBetaAlertCard() {
|
|||
<div className="flex gap-4 py-4">
|
||||
<Button variant="secondary" asChild>
|
||||
<a
|
||||
href="https://docs.skyvern.com/workflows/creating-workflows"
|
||||
href="https://www.skyvern.com/docs/workflows/creating-workflows"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
>
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ from rich.panel import Panel
|
|||
|
||||
from .console import console
|
||||
|
||||
DOCS_URL = "https://docs.skyvern.com"
|
||||
DOCS_URL = "https://www.skyvern.com/docs"
|
||||
|
||||
docs_app = typer.Typer(
|
||||
invoke_without_command=True,
|
||||
|
|
|
|||
|
|
@ -184,15 +184,15 @@ class Skyvern:
|
|||
|
||||
webhook_url : typing.Optional[str]
|
||||
|
||||
After a run is finished, send an update to this URL. Refer to https://docs.skyvern.com/running-tasks/webhooks-faq for more details.
|
||||
After a run is finished, send an update to this URL. Refer to https://www.skyvern.com/docs/running-tasks/webhooks-faq for more details.
|
||||
|
||||
totp_identifier : typing.Optional[str]
|
||||
|
||||
Identifier 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.
|
||||
Identifier 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.
|
||||
|
||||
totp_url : typing.Optional[str]
|
||||
|
||||
URL 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.
|
||||
URL 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.
|
||||
|
||||
browser_session_id : typing.Optional[str]
|
||||
|
||||
|
|
@ -362,15 +362,15 @@ class Skyvern:
|
|||
- NONE: No proxy
|
||||
|
||||
webhook_url : typing.Optional[str]
|
||||
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.
|
||||
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 : typing.Optional[str]
|
||||
|
||||
URL 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.
|
||||
URL 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.
|
||||
|
||||
totp_identifier : typing.Optional[str]
|
||||
|
||||
Identifier 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.
|
||||
Identifier 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.
|
||||
|
||||
browser_session_id : typing.Optional[str]
|
||||
ID of a Skyvern browser session to reuse, having it continue from the current screen state
|
||||
|
|
@ -2027,15 +2027,15 @@ class AsyncSkyvern:
|
|||
|
||||
webhook_url : typing.Optional[str]
|
||||
|
||||
After a run is finished, send an update to this URL. Refer to https://docs.skyvern.com/running-tasks/webhooks-faq for more details.
|
||||
After a run is finished, send an update to this URL. Refer to https://www.skyvern.com/docs/running-tasks/webhooks-faq for more details.
|
||||
|
||||
totp_identifier : typing.Optional[str]
|
||||
|
||||
Identifier 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.
|
||||
Identifier 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.
|
||||
|
||||
totp_url : typing.Optional[str]
|
||||
|
||||
URL 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.
|
||||
URL 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.
|
||||
|
||||
browser_session_id : typing.Optional[str]
|
||||
|
||||
|
|
@ -2213,15 +2213,15 @@ class AsyncSkyvern:
|
|||
- NONE: No proxy
|
||||
|
||||
webhook_url : typing.Optional[str]
|
||||
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.
|
||||
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 : typing.Optional[str]
|
||||
|
||||
URL 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.
|
||||
URL 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.
|
||||
|
||||
totp_identifier : typing.Optional[str]
|
||||
|
||||
Identifier 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.
|
||||
Identifier 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.
|
||||
|
||||
browser_session_id : typing.Optional[str]
|
||||
ID of a Skyvern browser session to reuse, having it continue from the current screen state
|
||||
|
|
|
|||
|
|
@ -12,19 +12,19 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2
|
|||
class TaskRunRequest(UniversalBaseModel):
|
||||
prompt: str = pydantic.Field()
|
||||
"""
|
||||
|
||||
|
||||
The goal or task description for Skyvern to accomplish
|
||||
"""
|
||||
|
||||
url: typing.Optional[str] = pydantic.Field(default=None)
|
||||
"""
|
||||
|
||||
|
||||
The starting URL for the task. If not provided, Skyvern will attempt to determine an appropriate URL
|
||||
"""
|
||||
|
||||
engine: typing.Optional[RunEngine] = pydantic.Field(default=None)
|
||||
"""
|
||||
|
||||
|
||||
The engine that powers the agent task. The default value is `skyvern-2.0`, the latest Skyvern agent that performs pretty well with complex and multi-step tasks. `skyvern-1.0` is good for simple tasks like filling a form, or searching for information on Google. The `openai-cua` engine uses OpenAI's CUA model. The `anthropic-cua` uses Anthropic's Claude Sonnet 3.7 model with the computer use tool.
|
||||
"""
|
||||
|
||||
|
|
@ -35,9 +35,9 @@ class TaskRunRequest(UniversalBaseModel):
|
|||
|
||||
proxy_location: typing.Optional[ProxyLocation] = pydantic.Field(default=None)
|
||||
"""
|
||||
|
||||
|
||||
Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
|
||||
|
||||
|
||||
Available geotargeting options:
|
||||
- RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.
|
||||
- RESIDENTIAL_ES: Spain
|
||||
|
|
@ -62,49 +62,49 @@ class TaskRunRequest(UniversalBaseModel):
|
|||
|
||||
data_extraction_schema: typing.Optional[TaskRunRequestDataExtractionSchema] = pydantic.Field(default=None)
|
||||
"""
|
||||
|
||||
|
||||
The schema for data to be extracted from the webpage. If you're looking for consistent data schema being returned by the agent, it's highly recommended to use https://json-schema.org/.
|
||||
"""
|
||||
|
||||
error_code_mapping: typing.Optional[typing.Dict[str, typing.Optional[str]]] = pydantic.Field(default=None)
|
||||
"""
|
||||
|
||||
|
||||
Custom mapping of error codes to error messages if Skyvern encounters an error.
|
||||
"""
|
||||
|
||||
max_steps: typing.Optional[int] = pydantic.Field(default=None)
|
||||
"""
|
||||
|
||||
|
||||
Maximum number of steps the task can take. Task will fail if it exceeds this number. Cautions: you are charged per step so please set this number to a reasonable value. Contact sales@skyvern.com for custom pricing.
|
||||
"""
|
||||
|
||||
webhook_url: typing.Optional[str] = pydantic.Field(default=None)
|
||||
"""
|
||||
|
||||
After a run is finished, send an update to this URL. Refer to https://docs.skyvern.com/running-tasks/webhooks-faq for more details.
|
||||
|
||||
After a run is finished, send an update to this URL. Refer to https://www.skyvern.com/docs/running-tasks/webhooks-faq for more details.
|
||||
"""
|
||||
|
||||
totp_identifier: typing.Optional[str] = pydantic.Field(default=None)
|
||||
"""
|
||||
|
||||
Identifier 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.
|
||||
|
||||
Identifier 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.
|
||||
"""
|
||||
|
||||
totp_url: typing.Optional[str] = pydantic.Field(default=None)
|
||||
"""
|
||||
|
||||
URL 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.
|
||||
|
||||
URL 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.
|
||||
"""
|
||||
|
||||
browser_session_id: typing.Optional[str] = pydantic.Field(default=None)
|
||||
"""
|
||||
|
||||
|
||||
Run the task or workflow in the specific Skyvern browser session. 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.
|
||||
"""
|
||||
|
||||
model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
|
||||
"""
|
||||
|
||||
|
||||
Optional model configuration.
|
||||
"""
|
||||
|
||||
|
|
|
|||
|
|
@ -25,9 +25,9 @@ class WorkflowRunRequest(UniversalBaseModel):
|
|||
|
||||
proxy_location: typing.Optional[ProxyLocation] = pydantic.Field(default=None)
|
||||
"""
|
||||
|
||||
|
||||
Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
|
||||
|
||||
|
||||
Available geotargeting options:
|
||||
- RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.
|
||||
- RESIDENTIAL_ES: Spain
|
||||
|
|
@ -52,19 +52,19 @@ class WorkflowRunRequest(UniversalBaseModel):
|
|||
|
||||
webhook_url: typing.Optional[str] = pydantic.Field(default=None)
|
||||
"""
|
||||
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.
|
||||
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: typing.Optional[str] = pydantic.Field(default=None)
|
||||
"""
|
||||
|
||||
URL 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.
|
||||
|
||||
URL 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.
|
||||
"""
|
||||
|
||||
totp_identifier: typing.Optional[str] = pydantic.Field(default=None)
|
||||
"""
|
||||
|
||||
Identifier 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.
|
||||
|
||||
Identifier 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.
|
||||
"""
|
||||
|
||||
browser_session_id: typing.Optional[str] = pydantic.Field(default=None)
|
||||
|
|
|
|||
|
|
@ -48,15 +48,15 @@ Maximum number of steps the task can take. Task will fail if it exceeds this num
|
|||
"""
|
||||
|
||||
WEBHOOK_URL_DOC_STRING = """
|
||||
After a run is finished, send an update to this URL. Refer to https://docs.skyvern.com/running-tasks/webhooks-faq for more details.
|
||||
After a run is finished, send an update to this URL. Refer to https://www.skyvern.com/docs/running-tasks/webhooks-faq for more details.
|
||||
"""
|
||||
|
||||
TOTP_IDENTIFIER_DOC_STRING = """
|
||||
Identifier 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.
|
||||
Identifier 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.
|
||||
"""
|
||||
|
||||
TOTP_URL_DOC_STRING = """
|
||||
URL 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.
|
||||
URL 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.
|
||||
"""
|
||||
|
||||
BROWSER_SESSION_ID_DOC_STRING = """
|
||||
|
|
|
|||
|
|
@ -371,7 +371,7 @@ class WorkflowRunRequest(BaseModel):
|
|||
)
|
||||
webhook_url: str | None = Field(
|
||||
default=None,
|
||||
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: str | None = Field(
|
||||
default=None,
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue