fix grammar errors & typos (#2493)

This commit is contained in:
Shuchang Zheng
2025-05-28 00:21:50 -07:00
committed by GitHub
parent 3d1572f462
commit 1d1827059c
16 changed files with 22 additions and 21 deletions

View File

@@ -9,7 +9,7 @@ Skyvern Browser Session is a way to persist the real-time state of the browser,
- You have multiple continuous tasks that need to interact with the browser in real-time without much delay. For example, you are developing a phone agent for your customer support center and your agent needs access to real time information in the browser. - You have multiple continuous tasks that need to interact with the browser in real-time without much delay. For example, you are developing a phone agent for your customer support center and your agent needs access to real time information in the browser.
- You have several related tasks that may need to be executed but with interruptions in between. For example, you are developing an shopping agent that needs human in the loop to help fulfill the purchase. - You have several related tasks that may need to be executed but with interruptions in between. For example, you are developing an shopping agent that needs human in the loop to help fulfill the purchase.
Skyvern Browser Sessions is currently is only available via [API & SDK](/api-reference/api-reference/browser-session/create-browser-session). Skyvern Browser Sessions are currently only available via [API & SDK](/api-reference/api-reference/browser-session/create-browser-session).
## Create a Browser Session ## Create a Browser Session
- [API doc](/api-reference/api-reference/browser-session/create-browser-session) - [API doc](/api-reference/api-reference/browser-session/create-browser-session)

View File

@@ -36,7 +36,7 @@ Please contact sales@skyvern.com to set up the integration for this step.
a. The URL is the website you'd like to navigate to. This can be parameterized by different `input_parameter` a. The URL is the website you'd like to navigate to. This can be parameterized by different `input_parameter`
b. Enter the collection id above. This can be parameterized by another input parameter b. Enter the collection id above. This can be parameterized by another input parameter
<img src="../images/bitwarden/bitwarden_tutorial_create_skyvern_workflow.png" /> <img src="../images/bitwarden/bitwarden_tutorial_create_skyvern_workflow.png" />
3. Create a login block and select the credentials as input paramters and you should be good to go! 3. Create a login block and select the credentials as input parameters and you should be good to go!
<img src="../images/bitwarden/bitwarden_tutorial_create_skyvern_task_block.png" /> <img src="../images/bitwarden/bitwarden_tutorial_create_skyvern_task_block.png" />
### Bitwarden Integration in Open Source ### Bitwarden Integration in Open Source

View File

@@ -5,7 +5,7 @@ slug: credentials/credit-cards
--- ---
## Manage Credit Cards ## Manage Credit Cards
Same as passwords, credit cards are also managed in the [Skyvern's Credentials](https://app.skyvern.com/credentials) page. Like passwords, credit cards are managed on the [Skyvern Credentials](https://app.skyvern.com/credentials) page.
### Add a new credit card: ### Add a new credit card:

View File

@@ -55,7 +55,8 @@ Skyvern can integrate with your Bitwarden account. Skyvern agent can read the cr
See [Bitwarden Integration](/credentials/bitwarden) for more details. See [Bitwarden Integration](/credentials/bitwarden) for more details.
## Coming Soon (Contact Skyvern Support if you need any password integration to help us priroitize) ## Coming Soon
(Contact support@skyvern.com if you need any password integration to help us prioritize)
- 1Password Integration - 1Password Integration
- LastPass Integration - LastPass Integration

View File

@@ -6,7 +6,7 @@ slug: credentials/passwords
## Password Management ## Password Management
You can store passwords information in Skyvern. Skyvern agent can use the stored password information to log into a website without sending your username or password to LLMs. You can store password information in Skyvern. Skyvern agent can use the stored password information to log into a website without sending your username or password to LLMs.
## How To Manage Passwords ## How To Manage Passwords
This can be done in the [Skyvern's Credentials](https://app.skyvern.com/credentials) page. This can be done in the [Skyvern's Credentials](https://app.skyvern.com/credentials) page.
@@ -25,7 +25,7 @@ Click the trash icon and confirm the deletion. If you do this, the password will
<img src="../images/credential_management/delete_password.png" /> <img src="../images/credential_management/delete_password.png" />
### Update a password: ### Update a password:
<Warning>Skyvern only allows adding and deleting passwords. If you would like to update a password, you need to delete the existing password and create a new one.</Warning> <Warning>Skyvern allows only adding and deleting passwords. If you would like to update a password, you need to delete the existing password and create a new one.</Warning>
## Manage Passwords with API & SDK ## Manage Passwords with API & SDK
We also have [API and SDK](/api-reference/api-reference/credentials/create-credential) supports for password management: We also have [API and SDK](/api-reference/api-reference/credentials/create-credential) supports for password management:

View File

@@ -18,7 +18,7 @@ See [Password Management](/credentials/passwords#manage-passwords-in-skyvern-clo
You can pass `totp_url` when running [a task](/api-reference/api-reference/agent/run-task) or a [workflow](/api-reference/api-reference/agent/run-workflow). Inside this endpoint hosted by you, you have to conform to the following schema: You can pass `totp_url` when running [a task](/api-reference/api-reference/agent/run-task) or a [workflow](/api-reference/api-reference/agent/run-workflow). Inside this endpoint hosted by you, you have to conform to the following schema:
### Set Up Your TOTP Endpoint ### Set Up Your TOTP Endpoint
For websites that requires a verification code to complete a task, you have to set up a TOTP endpoint for Skyvern to fetch the verification code. For websites that require a verification code to complete a task, you have to set up a TOTP endpoint for Skyvern to fetch the verification code.
Here's the TOTP endpoint contract you should use: Here's the TOTP endpoint contract you should use:
@@ -55,7 +55,7 @@ Find TOTP API doc [here](/api-reference/api-reference/credentials/send-totp-code
You can pass `totp_identifier` when running [a task](/api-reference/api-reference/agent/run-task) or a [workflow](/api-reference/api-reference/agent/run-workflow). When the TOTP code arrives at your inbox, all you need to do is to send the email/message (Gmail + Zapier integration can be a good solution to set up email forwarding) to Skyvern's TOTP endpoint. You can pass `totp_identifier` when running [a task](/api-reference/api-reference/agent/run-task) or a [workflow](/api-reference/api-reference/agent/run-workflow). When the TOTP code arrives at your inbox, all you need to do is to send the email/message (Gmail + Zapier integration can be a good solution to set up email forwarding) to Skyvern's TOTP endpoint.
### Forwarding Your Email To Skyvern (Gmail + Zapier) ### Forwarding Your Email To Skyvern (Gmail + Zapier)
This setup requires a Zapier pro plan account. This setup requires a Zapier Pro plan account.
**Step 1. Create a Zapier Zap** **Step 1. Create a Zapier Zap**

View File

@@ -7,7 +7,7 @@ slug: getting-started/prompting-guide
## TL;DR ## TL;DR
* Use key words “complete” or “terminate” to let Skyvern know when the task is done or should be ended, respectively * Use key words “complete” or “terminate” to let Skyvern know when the task is done or should be ended, respectively
* Be specific when prompting, write as if you are talking to a seven year old. Verbosity is your friend. * Be specific when prompting; write as if you are speaking to a sevenyearold; verbosity is your friend.
* Ensure your problem is formatted as a single clearly defined goal with guardrails * Ensure your problem is formatted as a single clearly defined goal with guardrails
* For instance, “generate an insurance quote” will be more successful than a sequence like “generate multiple insurance quotes and compare them to find the best option” * For instance, “generate an insurance quote” will be more successful than a sequence like “generate multiple insurance quotes and compare them to find the best option”
* Add guardrails like “close cookie dialogs” to instruct Skyvern when it encounters unexpected obstacles * Add guardrails like “close cookie dialogs” to instruct Skyvern when it encounters unexpected obstacles
@@ -22,7 +22,7 @@ A good 95% of the time, you can prevent a task failure before it even begins. He
Have a very clear idea of the problem youre trying to have Skyvern solve. Ask yourself: Have a very clear idea of the problem youre trying to have Skyvern solve. Ask yourself:
What is the my goal? Can I describe it very clearly so Skyvern knows I've accomplished my goal? What is my goal? Can I describe it very clearly so Skyvern knows I've accomplished my goal?
Does the site have anything that might derail Skyvern, like captchas, cookie dialogs, or pop-ups? Does the site have anything that might derail Skyvern, like captchas, cookie dialogs, or pop-ups?

View File

@@ -38,7 +38,7 @@ print(task)
More API & SDK information can be found in the [API Reference](/api-reference) section. More API & SDK information can be found in the [API Reference](/api-reference) section.
### Run Task Locally ### Run Task Locally
You can also run browser tasks locally in your python code but it takes a bit more effort to set up the environment: You can also run browser tasks locally in your Python code, though it takes a bit more effort to set up the environment:
1. **Configure Skyvern** Run the setup wizard which will guide you through the configuration process, including Skyvern [MCP](/integrations/mcp) integration. This will generate a `.env` as the configuration settings file. 1. **Configure Skyvern** Run the setup wizard which will guide you through the configuration process, including Skyvern [MCP](/integrations/mcp) integration. This will generate a `.env` as the configuration settings file.
```bash ```bash

View File

@@ -35,7 +35,7 @@ Skyvern can navigate complex and boring government forms and fill them out with
</p> </p>
## Retrieving insurance quotes from insurance providers in any language ## Retrieving insurance quotes from insurance providers in any language
Skyvern can navigate complex multi-part forms and fill out forms in any language Skyvern can navigate complex multi-part forms and fill them out in any language
[💡 See it for yourself](https://app.skyvern.com/create/geico) [💡 See it for yourself](https://app.skyvern.com/create/geico)
<p align="center"> <p align="center">

View File

@@ -14,7 +14,7 @@ slug: introduction
Traditional approaches to browser automations required writing custom scripts for websites, often relying on DOM parsing and XPath-based interactions which would break whenever the website layouts changed. Traditional approaches to browser automations required writing custom scripts for websites, often relying on DOM parsing and XPath-based interactions which would break whenever the website layouts changed.
Instead of only relying on code-defined XPath interactions, Skyvern relies on prompts in addition to computer vision and LLMs to the mix to parse items in the viewport in real-time, create a plan for interaction and interact with them. Instead of relying solely on code-defined XPath interactions, Skyvern uses prompts along with computer vision and LLMs to parse items in the viewport in real time, plan interactions, and execute them
This approach gives us a few advantages: This approach gives us a few advantages:
@@ -23,7 +23,7 @@ This approach gives us a few advantages:
1. Skyvern is able to take a single workflow and apply it to a large number of websites, as its able to reason through the interactions necessary to complete the workflow 1. Skyvern is able to take a single workflow and apply it to a large number of websites, as its able to reason through the interactions necessary to complete the workflow
1. Skyvern leverages LLMs to reason through interactions to ensure we can cover complex situations. Examples include: 1. Skyvern leverages LLMs to reason through interactions to ensure we can cover complex situations. Examples include:
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 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, its 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!) 1. If you were doing competitor analysis, it understands that an Arnold Palmer 22oz can at 7/11 is almost certainly the same product as a 23oz can at Gopuff (even though the sizes are slightly different, which could be a rounding error!)
Want to see examples of Skyvern in action? [Check out some examples we have here](/getting-started/skyvern-in-action) Want to see examples of Skyvern in action? [Check out some examples we have here](/getting-started/skyvern-in-action)

View File

@@ -5,7 +5,7 @@ slug: running-tasks/advanced-features
--- ---
<Warning> DEPRECATION ALERT: the content in this page including endpoints mentioned here is being deprecated. Last supported date: Jan 1, 2026. If you're looking for TOTP (2FA/MFA) information, move to the new [TOTP](/credentials/totp) page.</Warning> <Warning> DEPRECATION ALERT: the content in this page including endpoints mentioned here is being deprecated. Last supported date: Jan 1, 2026. If you're looking for TOTP (2FA/MFA) information, move to the new [TOTP](/credentials/totp) page.</Warning>
## Overriding the max_steps paramter in the task ## Overriding the max_steps parameter 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. 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 ```json
@@ -23,7 +23,7 @@ Body:
## Time-based One-time Password (TOTP) ## Time-based One-time Password (TOTP)
Skyvern supports one-time password (see https://www.twilio.com/docs/glossary/totp for more information), also known as 2FA/MFA, in two ways: 1) Skyvern gets the code from your endpoint 2) You push the the code to Skyvern. Skyvern supports one-time password (see https://www.twilio.com/docs/glossary/totp for more information), also known as 2FA/MFA, in two ways: 1) Skyvern gets the code from your endpoint 2) You push the code to Skyvern.
### Get Code From Your Endpoint ### Get Code From Your Endpoint
You can pass `totp_verification_url` when [creating a task](/running-tasks/api-spec#request-initiate-a-task). Inside this endpoint hosted by you, you have to conform to the following schema: You can pass `totp_verification_url` when [creating a task](/running-tasks/api-spec#request-initiate-a-task). Inside this endpoint hosted by you, you have to conform to the following schema:

View File

@@ -26,7 +26,7 @@ Production:`https://api.skyvern.com/api/v2/tasks/`
| proxy_location | String | no | RESIDENTIAL | Proxy location for the web-browsing request. Please pass RESIDENTIAL as a value | | 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_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://docs.skyvern.com/running-tasks/advanced-features#push-code-to-skyvern) |
| extracted_information_schema | JSON object, list, string | no | `{"type": "object", "properties": {"title": {"type": "string", "descripption": "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 | | 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) ## Example Request (Apply for a job)

View File

@@ -10,7 +10,7 @@ slug: running-tasks/introduction
1. Navigate to [app.skyvern.com](https://app.skyvern.com) and log into your account 1. Navigate to [app.skyvern.com](https://app.skyvern.com) and log into your account
1. Validate that you're in the correct account (personal vs organization) 1. Validate that you're in the correct account (personal vs organization)
1. Click on "Settings" 1. Click on "Settings"
1. Click Reveal to see your API key. This is the unique key associated with your account that allows you to intract with Skyvern 1. Click Reveal to see your API key. This is the unique key associated with your account that allows you to interact with Skyvern
<img src="../images/api_key_image.png" /> <img src="../images/api_key_image.png" />

View File

@@ -41,7 +41,7 @@ You can set the `webhook_url` to receive the update when the task is done. Check
Parameter: `max_steps` Parameter: `max_steps`
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. Maximum number of steps the task can take. Task will fail if it exceeds this number. Caution: you are charged per step, so set this number to a reasonable value. Contact sales@skyvern.com for custom pricing.
### [Error Code Mapping](/api-reference/api-reference/agent/run-task#request.body.error_code_mapping) ### [Error Code Mapping](/api-reference/api-reference/agent/run-task#request.body.error_code_mapping)

View File

@@ -30,7 +30,7 @@ With these registered as parameters, the user doesnt have to change the value
<img src="../images/what_is_a_parameter/p.3.png"/> <img src="../images/what_is_a_parameter/p.3.png"/>
**Step 3.** Add a key that will act as the name for the parameter. You can also include a description or set a default value if you wish. Note that a default value pre-populates the run parameter, but can be overrode **Step 3.** Add a key that will act as the name for the parameter. You can also include a description or set a default value if you wish. Note that a default value pre-populates the run parameter, but can be overridden
<img src="../images/what_is_a_parameter/p.4.png"/> <img src="../images/what_is_a_parameter/p.4.png"/>

View File

@@ -28,7 +28,7 @@ With these registered as parameters, the user doesnt have to change the value
<img src="../images/what_is_a_parameter/p.3.png"/> <img src="../images/what_is_a_parameter/p.3.png"/>
**Step 3.** Add a key that will act as the name for the parameter. You can also include a description or set a default value if you wish. Note that a default value pre-populates the run parameter, but can be overrode **Step 3.** Add a key that will act as the name for the parameter. You can also include a description or set a default value if you wish. Note that a default value pre-populates the run parameter, but can be overridden.
<img src="../images/what_is_a_parameter/p.4.png"/> <img src="../images/what_is_a_parameter/p.4.png"/>