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

@@ -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>
## 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:

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

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. 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
<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`
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)