From 1d1827059c59383d9a4d6adc53b5cc39070c9292 Mon Sep 17 00:00:00 2001 From: Shuchang Zheng Date: Wed, 28 May 2025 00:21:50 -0700 Subject: [PATCH] fix grammar errors & typos (#2493) --- fern/browser-sessions/introduction.mdx | 2 +- fern/credentials/bitwarden.mdx | 2 +- fern/credentials/credit-cards.mdx | 2 +- fern/credentials/introduction.mdx | 3 ++- fern/credentials/passwords.mdx | 4 ++-- fern/credentials/totp.mdx | 4 ++-- fern/getting-started/prompting-guide.mdx | 4 ++-- fern/getting-started/quickstart.mdx | 2 +- fern/getting-started/skyvern-in-action.mdx | 2 +- fern/introduction.mdx | 4 ++-- fern/running-tasks/advanced-features.mdx | 4 ++-- fern/running-tasks/api-v2-spec.mdx | 2 +- fern/running-tasks/introduction.mdx | 2 +- fern/running-tasks/run-tasks.mdx | 2 +- fern/workflows/what-is-a-parameter.mdx | 2 +- fern/workflows/workflow-parameters.mdx | 2 +- 16 files changed, 22 insertions(+), 21 deletions(-) diff --git a/fern/browser-sessions/introduction.mdx b/fern/browser-sessions/introduction.mdx index d6c72d52..c244b249 100644 --- a/fern/browser-sessions/introduction.mdx +++ b/fern/browser-sessions/introduction.mdx @@ -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 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 - [API doc](/api-reference/api-reference/browser-session/create-browser-session) diff --git a/fern/credentials/bitwarden.mdx b/fern/credentials/bitwarden.mdx index 7885b3d5..03bbf351 100644 --- a/fern/credentials/bitwarden.mdx +++ b/fern/credentials/bitwarden.mdx @@ -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` b. Enter the collection id above. This can be parameterized by another input parameter -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! ### Bitwarden Integration in Open Source diff --git a/fern/credentials/credit-cards.mdx b/fern/credentials/credit-cards.mdx index be5930de..b819d5ae 100644 --- a/fern/credentials/credit-cards.mdx +++ b/fern/credentials/credit-cards.mdx @@ -5,7 +5,7 @@ slug: credentials/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: diff --git a/fern/credentials/introduction.mdx b/fern/credentials/introduction.mdx index a3dc9ece..af311487 100644 --- a/fern/credentials/introduction.mdx +++ b/fern/credentials/introduction.mdx @@ -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. -## 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 - LastPass Integration diff --git a/fern/credentials/passwords.mdx b/fern/credentials/passwords.mdx index 1cf116f4..d19fd934 100644 --- a/fern/credentials/passwords.mdx +++ b/fern/credentials/passwords.mdx @@ -6,7 +6,7 @@ slug: credentials/passwords ## 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 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 ### Update a password: -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. +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. ## Manage Passwords with API & SDK We also have [API and SDK](/api-reference/api-reference/credentials/create-credential) supports for password management: diff --git a/fern/credentials/totp.mdx b/fern/credentials/totp.mdx index 727980f3..48d0e044 100644 --- a/fern/credentials/totp.mdx +++ b/fern/credentials/totp.mdx @@ -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: ### 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: @@ -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. ### 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** diff --git a/fern/getting-started/prompting-guide.mdx b/fern/getting-started/prompting-guide.mdx index 69ddaec4..d5da1697 100644 --- a/fern/getting-started/prompting-guide.mdx +++ b/fern/getting-started/prompting-guide.mdx @@ -7,7 +7,7 @@ slug: getting-started/prompting-guide ## TL;DR * 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 seven‑year‑old; verbosity is your friend. * 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” * 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 you’re 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? diff --git a/fern/getting-started/quickstart.mdx b/fern/getting-started/quickstart.mdx index 21b5ef25..993435ef 100644 --- a/fern/getting-started/quickstart.mdx +++ b/fern/getting-started/quickstart.mdx @@ -38,7 +38,7 @@ print(task) More API & SDK information can be found in the [API Reference](/api-reference) section. ### 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. ```bash diff --git a/fern/getting-started/skyvern-in-action.mdx b/fern/getting-started/skyvern-in-action.mdx index af97f0b5..f144bd51 100644 --- a/fern/getting-started/skyvern-in-action.mdx +++ b/fern/getting-started/skyvern-in-action.mdx @@ -35,7 +35,7 @@ Skyvern can navigate complex and boring government forms and fill them out with

## 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)

diff --git a/fern/introduction.mdx b/fern/introduction.mdx index 0f387d9d..a4e5b4c5 100644 --- a/fern/introduction.mdx +++ b/fern/introduction.mdx @@ -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. -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: @@ -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 it’s 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. 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!) + 1. If you were doing competitor analysis, it understands that an Arnold Palmer 22‑oz can at 7/11 is almost certainly the same product as a 23‑oz 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) diff --git a/fern/running-tasks/advanced-features.mdx b/fern/running-tasks/advanced-features.mdx index 04fb18c4..ac8ae079 100644 --- a/fern/running-tasks/advanced-features.mdx +++ b/fern/running-tasks/advanced-features.mdx @@ -5,7 +5,7 @@ slug: running-tasks/advanced-features --- 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. -## 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. ```json @@ -23,7 +23,7 @@ Body: ## 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 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: diff --git a/fern/running-tasks/api-v2-spec.mdx b/fern/running-tasks/api-v2-spec.mdx index f56efbac..8298a6e1 100644 --- a/fern/running-tasks/api-v2-spec.mdx +++ b/fern/running-tasks/api-v2-spec.mdx @@ -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 | | 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) | -| 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) diff --git a/fern/running-tasks/introduction.mdx b/fern/running-tasks/introduction.mdx index 7b0b6620..94f7715b 100644 --- a/fern/running-tasks/introduction.mdx +++ b/fern/running-tasks/introduction.mdx @@ -10,7 +10,7 @@ slug: running-tasks/introduction 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. 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 \ No newline at end of file diff --git a/fern/running-tasks/run-tasks.mdx b/fern/running-tasks/run-tasks.mdx index 67ad69dd..e2cf1f69 100644 --- a/fern/running-tasks/run-tasks.mdx +++ b/fern/running-tasks/run-tasks.mdx @@ -41,7 +41,7 @@ You can set the `webhook_url` to receive the update when the task is done. Check 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) diff --git a/fern/workflows/what-is-a-parameter.mdx b/fern/workflows/what-is-a-parameter.mdx index e95e0c1f..291b0544 100644 --- a/fern/workflows/what-is-a-parameter.mdx +++ b/fern/workflows/what-is-a-parameter.mdx @@ -30,7 +30,7 @@ With these registered as parameters, the user doesn’t have to change the value -**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 diff --git a/fern/workflows/workflow-parameters.mdx b/fern/workflows/workflow-parameters.mdx index 4cfa53ba..cb2e8f1d 100644 --- a/fern/workflows/workflow-parameters.mdx +++ b/fern/workflows/workflow-parameters.mdx @@ -28,7 +28,7 @@ With these registered as parameters, the user doesn’t have to change the value -**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.