doc for extracted_information_schema (#1971)

This commit is contained in:
Shuchang Zheng
2025-03-19 15:17:56 -07:00
committed by GitHub
parent ab2e5afd72
commit 3bd4d806c8

View File

@@ -26,6 +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 |
## Example Request (Apply for a job)