vodorod/Dorod-Sky
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

quick update passwords docs (#2424)

Browse Source
This commit is contained in:
Shuchang Zheng
2025-05-21 22:29:11 -07:00
committed by GitHub
parent c5b76fa5a3
commit 74cd8f7b45
5 changed files with 43 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
fern/credentials/credit_cards.mdx
View File

@@ -4,7 +4,7 @@ subtitle: How to manage credit cards in Skyvern
slug: credentials/credit-cards slug: credentials/credit-cards
--- ---
## Manage credit cards in Skyvern Cloud ## Manage Credit Cards in Skyvern Cloud
You can go to [Skyvern's Credentials page](https://app.skyvern.com/credentials) to manage your credit cards. You can go to [Skyvern's Credentials page](https://app.skyvern.com/credentials) to manage your credit cards.
@@ -22,7 +22,7 @@ Click the trash icon and confirm the deletion. If you do this, the credit card w
**Update a credit card credential:** **Update a credit card credential:**
<Warning>Skyvern only supports adding and deleting credit cards. To update a credit card, you need to delete the existing credit card and create a new one.</Warning> <Warning>Skyvern only supports adding and deleting credit cards. To update a credit card, you need to delete the existing credit card and create a new one.</Warning>
## Manage credit cards with Skyvern's API or SDK ## Manage Credit Cards with API & SDK
We also have [API and SDK](/api-reference/api-reference/credentials/create-credential) supports for credit card management: We also have [API and SDK](/api-reference/api-reference/credentials/create-credential) supports for credit card management:
**Create a new credit card credential:** **Create a new credit card credential:**
@@ -30,7 +30,7 @@ We also have [API and SDK](/api-reference/api-reference/credentials/create-crede
<CodeBlocks> <CodeBlocks>
```python title="python" ```python title="python"
from skyvern import Skyvern from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
await skyvern.credentials.create_credential( await skyvern.credentials.create_credential(
name="My Credit Card", name="My Credit Card",
credential_type="credit_card", credential_type="credit_card",
@@ -70,7 +70,7 @@ curl -X POST https://api.skyvern.com/v1/credentials \
```python title="python" ```python title="python"
from skyvern import Skyvern from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
await skyvern.credentials.delete_credential(credential_id="cred_123456789") await skyvern.credentials.delete_credential(credential_id="cred_123456789")
``` ```

8
fern/credentials/passwords.mdx
View File

@@ -8,7 +8,7 @@ slug: credentials/passwords
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 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.
## Manage passwords in Skyvern Cloud ## Manage Passwords in Skyvern Cloud
You can go to [Skyvern's Credentials page](https://app.skyvern.com/credentials) to manage your passwords. You can go to [Skyvern's Credentials page](https://app.skyvern.com/credentials) to manage your passwords.
**Add a new password credential:** **Add a new password credential:**
@@ -26,7 +26,7 @@ Click the trash icon and confirm the deletion. If you do this, the password will
**Update a password credential:** **Update a password credential:**
<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 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>
## Manage passwords with Skyvern's API or 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:
**Create a new password credential:** **Create a new password credential:**
@@ -35,7 +35,7 @@ We also have [API and SDK](/api-reference/api-reference/credentials/create-crede
```python title="python" ```python title="python"
from skyvern import Skyvern from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
await skyvern.credentials.create_credential( await skyvern.credentials.create_credential(
name="My Credential", name="My Credential",
credential_type="password", credential_type="password",
@@ -65,7 +65,7 @@ curl -X POST https://api.skyvern.com/v1/credentials \
```python title="python" ```python title="python"
from skyvern import Skyvern from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
await skyvern.credentials.delete_credential(credential_id="cred_123456789") await skyvern.credentials.delete_credential(credential_id="cred_123456789")
``` ```

4
fern/integrations/api.mdx
View File

@@ -68,7 +68,7 @@ import requests
url = "https://api.skyvern.com/api/v1/organizations" url = "https://api.skyvern.com/api/v1/organizations"
headers = { headers = {
"x-api-key": "your_api_key" "x-api-key": "YOUR_API_KEY"
} }
response = requests.get(url, headers=headers) response = requests.get(url, headers=headers)
@@ -83,4 +83,4 @@ else:
print(response.text) print(response.text)
``` ```
Remember to replace `your_api_key` with your API Key token retrieved from Skyvern's setting page Remember to replace `YOUR_API_KEY` with your API Key retrieved from Skyvern's setting page

32
fern/openapi/skyvern_openapi.json
View File

@@ -92,7 +92,7 @@
"code-samples": [ "code-samples": [
{ {
"sdk": "python", "sdk": "python",
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"your_api_key\")\nawait skyvern.agent.run_task(prompt=\"What's the top post on hackernews?\")\n" "code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.agent.run_task(prompt=\"What's the top post on hackernews?\")\n"
} }
] ]
} }
@@ -211,7 +211,7 @@
"code-samples": [ "code-samples": [
{ {
"sdk": "python", "sdk": "python",
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"your_api_key\")\nawait skyvern.agent.run_workflow(workflow_id=\"wpid_123\", parameters={\"parameter1\": \"value1\", \"parameter2\": \"value2\"})\n" "code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.agent.run_workflow(workflow_id=\"wpid_123\", parameters={\"parameter1\": \"value1\", \"parameter2\": \"value2\"})\n"
} }
] ]
} }
@@ -312,7 +312,7 @@
"code-samples": [ "code-samples": [
{ {
"sdk": "python", "sdk": "python",
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"your_api_key\")\nrun = await skyvern.agent.get_run(run_id=\"tsk_v2_123\")\nprint(run)\n" "code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nrun = await skyvern.agent.get_run(run_id=\"tsk_v2_123\")\nprint(run)\n"
} }
] ]
} }
@@ -387,7 +387,7 @@
"code-samples": [ "code-samples": [
{ {
"sdk": "python", "sdk": "python",
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"your_api_key\")\nawait skyvern.agent.cancel_run(run_id=\"tsk_v2_123\")\n" "code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.agent.cancel_run(run_id=\"tsk_v2_123\")\n"
} }
] ]
} }
@@ -458,7 +458,7 @@
}, },
{ {
"sdk": "python", "sdk": "python",
"code": "\nfrom skyvern import Skyvern\n\n# Create a workflow in JSON format\nworkflow_definition = {\n \"title\": \"Contact Forms Workflow\",\n \"description\": \"Fill the contact form on the website\",\n \"proxy_location\": \"RESIDENTIAL\",\n \"webhook_callback_url\": \"https://example.com/webhook\",\n \"totp_verification_url\": \"https://example.com/totp\",\n \"totp_identifier\": \"4155555555\",\n \"workflow_definition\": {\n \"parameters\": [\n {\n \"key\": \"website_url\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n {\n \"key\": \"name\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n {\n \"key\": \"additional_information\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": \"Message: I'd love to learn more about your...\nPhone: 123-456-7890\nInquiry type: sales\nOptional Subject: Hello from [Company Here]\",\n },\n {\n \"key\": \"email\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n ],\n \"blocks\": [\n {\n \"label\": \"Fill_Out_Contact_Form\",\n \"continue_on_failure\": True,\n \"block_type\": \"navigation\",\n \"url\": \"{{website_url}}\",\n \"title\": \"Fill_Out_Contact_Form\",\n \"engine\": \"skyvern-1.0\",\n \"navigation_goal\": \"Find the contact form. Fill out the contact us form and submit it. Your goal is complete when the page says your message has been sent. In the case you can't find a contact us form, terminate.\n\nFill out required fields as best you can using the following information:\n{{name}}\n{{email}}\n{{additional_information}}\",\n \"error_code_mapping\": None,\n \"max_retries\": 0,\n \"max_steps_per_run\": None,\n \"complete_on_download\": False,\n \"download_suffix\": None,\n \"parameter_keys\": [],\n \"totp_identifier\": None,\n \"totp_verification_url\": None,\n \"cache_actions\": False,\n \"complete_criterion\": \"\",\n \"terminate_criterion\": \"\",\n \"include_action_history_in_verification\": False,\n },\n {\n \"label\": \"Extract_Email\",\n \"continue_on_failure\": False,\n \"block_type\": \"extraction\",\n \"url\": \"\",\n \"title\": \"Extract_Email\",\n \"data_extraction_goal\": \"Extract a company email if available \",\n \"data_schema\": None,\n \"max_retries\": 0,\n \"max_steps_per_run\": None,\n \"parameter_keys\": [],\n \"cache_actions\": False,\n },\n ],\n },\n}\nskyvern = Skyvern(api_key=\"your_api_key\")\nworkflow = await skyvern.workflows.create_workflow(json_definition=workflow_definition)\nprint(workflow)\n" "code": "\nfrom skyvern import Skyvern\n\n# Create a workflow in JSON format\nworkflow_definition = {\n \"title\": \"Contact Forms Workflow\",\n \"description\": \"Fill the contact form on the website\",\n \"proxy_location\": \"RESIDENTIAL\",\n \"webhook_callback_url\": \"https://example.com/webhook\",\n \"totp_verification_url\": \"https://example.com/totp\",\n \"totp_identifier\": \"4155555555\",\n \"workflow_definition\": {\n \"parameters\": [\n {\n \"key\": \"website_url\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n {\n \"key\": \"name\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n {\n \"key\": \"additional_information\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": \"Message: I'd love to learn more about your...\nPhone: 123-456-7890\nInquiry type: sales\nOptional Subject: Hello from [Company Here]\",\n },\n {\n \"key\": \"email\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n ],\n \"blocks\": [\n {\n \"label\": \"Fill_Out_Contact_Form\",\n \"continue_on_failure\": True,\n \"block_type\": \"navigation\",\n \"url\": \"{{website_url}}\",\n \"title\": \"Fill_Out_Contact_Form\",\n \"engine\": \"skyvern-1.0\",\n \"navigation_goal\": \"Find the contact form. Fill out the contact us form and submit it. Your goal is complete when the page says your message has been sent. In the case you can't find a contact us form, terminate.\n\nFill out required fields as best you can using the following information:\n{{name}}\n{{email}}\n{{additional_information}}\",\n \"error_code_mapping\": None,\n \"max_retries\": 0,\n \"max_steps_per_run\": None,\n \"complete_on_download\": False,\n \"download_suffix\": None,\n \"parameter_keys\": [],\n \"totp_identifier\": None,\n \"totp_verification_url\": None,\n \"cache_actions\": False,\n \"complete_criterion\": \"\",\n \"terminate_criterion\": \"\",\n \"include_action_history_in_verification\": False,\n },\n {\n \"label\": \"Extract_Email\",\n \"continue_on_failure\": False,\n \"block_type\": \"extraction\",\n \"url\": \"\",\n \"title\": \"Extract_Email\",\n \"data_extraction_goal\": \"Extract a company email if available \",\n \"data_schema\": None,\n \"max_retries\": 0,\n \"max_steps_per_run\": None,\n \"parameter_keys\": [],\n \"cache_actions\": False,\n },\n ],\n },\n}\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nworkflow = await skyvern.workflows.create_workflow(json_definition=workflow_definition)\nprint(workflow)\n"
} }
] ]
} }
@@ -543,7 +543,7 @@
}, },
{ {
"sdk": "python", "sdk": "python",
"code": "\nfrom skyvern import Skyvern\n\nupdated_workflow_definition = {\n \"title\": \"Updated Contact Forms Workflow\",\n \"description\": \"Fill the contact form on the website\",\n \"proxy_location\": \"RESIDENTIAL\",\n \"webhook_callback_url\": \"https://example.com/webhook\",\n \"totp_verification_url\": \"https://example.com/totp\",\n \"totp_identifier\": \"4155555555\",\n \"workflow_definition\": {\n \"parameters\": [\n {\n \"key\": \"website_url\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n {\n \"key\": \"name\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n {\n \"key\": \"additional_information\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": \"Message: I'd love to learn more about your...\nPhone: 123-456-7890\nInquiry type: sales\nOptional Subject: Hello from [Company Here]\",\n },\n {\n \"key\": \"email\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n ],\n \"blocks\": [\n {\n \"label\": \"Fill_Out_Contact_Form\",\n \"continue_on_failure\": True,\n \"block_type\": \"navigation\",\n \"url\": \"{{website_url}}\",\n \"title\": \"Fill_Out_Contact_Form\",\n \"engine\": \"skyvern-1.0\",\n \"navigation_goal\": \"Find the contact form. Fill out the contact us form and submit it. Your goal is complete when the page says your message has been sent. In the case you can't find a contact us form, terminate.\n\nFill out required fields as best you can using the following information:\n{{name}}\n{{email}}\n{{additional_information}}\",\n \"error_code_mapping\": None,\n \"max_retries\": 0,\n \"max_steps_per_run\": None,\n \"complete_on_download\": False,\n \"download_suffix\": None,\n \"parameter_keys\": [],\n \"totp_identifier\": None,\n \"totp_verification_url\": None,\n \"cache_actions\": False,\n \"complete_criterion\": \"\",\n \"terminate_criterion\": \"\",\n \"include_action_history_in_verification\": False,\n },\n {\n \"label\": \"Extract_Email\",\n \"continue_on_failure\": False,\n \"block_type\": \"extraction\",\n \"url\": \"\",\n \"title\": \"Extract_Email\",\n \"data_extraction_goal\": \"Extract a company email if available \",\n \"data_schema\": None,\n \"max_retries\": 0,\n \"max_steps_per_run\": None,\n \"parameter_keys\": [],\n \"cache_actions\": False,\n },\n ],\n },\n}\nskyvern = Skyvern(api_key=\"your_api_key\")\nworkflow = await skyvern.workflows.update_workflow(workflow_id=\"wpid_123\", json_definition=updated_workflow_definition)\nprint(workflow)\n" "code": "\nfrom skyvern import Skyvern\n\nupdated_workflow_definition = {\n \"title\": \"Updated Contact Forms Workflow\",\n \"description\": \"Fill the contact form on the website\",\n \"proxy_location\": \"RESIDENTIAL\",\n \"webhook_callback_url\": \"https://example.com/webhook\",\n \"totp_verification_url\": \"https://example.com/totp\",\n \"totp_identifier\": \"4155555555\",\n \"workflow_definition\": {\n \"parameters\": [\n {\n \"key\": \"website_url\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n {\n \"key\": \"name\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n {\n \"key\": \"additional_information\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": \"Message: I'd love to learn more about your...\nPhone: 123-456-7890\nInquiry type: sales\nOptional Subject: Hello from [Company Here]\",\n },\n {\n \"key\": \"email\",\n \"description\": None,\n \"parameter_type\": \"workflow\",\n \"workflow_parameter_type\": \"string\",\n \"default_value\": None,\n },\n ],\n \"blocks\": [\n {\n \"label\": \"Fill_Out_Contact_Form\",\n \"continue_on_failure\": True,\n \"block_type\": \"navigation\",\n \"url\": \"{{website_url}}\",\n \"title\": \"Fill_Out_Contact_Form\",\n \"engine\": \"skyvern-1.0\",\n \"navigation_goal\": \"Find the contact form. Fill out the contact us form and submit it. Your goal is complete when the page says your message has been sent. In the case you can't find a contact us form, terminate.\n\nFill out required fields as best you can using the following information:\n{{name}}\n{{email}}\n{{additional_information}}\",\n \"error_code_mapping\": None,\n \"max_retries\": 0,\n \"max_steps_per_run\": None,\n \"complete_on_download\": False,\n \"download_suffix\": None,\n \"parameter_keys\": [],\n \"totp_identifier\": None,\n \"totp_verification_url\": None,\n \"cache_actions\": False,\n \"complete_criterion\": \"\",\n \"terminate_criterion\": \"\",\n \"include_action_history_in_verification\": False,\n },\n {\n \"label\": \"Extract_Email\",\n \"continue_on_failure\": False,\n \"block_type\": \"extraction\",\n \"url\": \"\",\n \"title\": \"Extract_Email\",\n \"data_extraction_goal\": \"Extract a company email if available \",\n \"data_schema\": None,\n \"max_retries\": 0,\n \"max_steps_per_run\": None,\n \"parameter_keys\": [],\n \"cache_actions\": False,\n },\n ],\n },\n}\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nworkflow = await skyvern.workflows.update_workflow(workflow_id=\"wpid_123\", json_definition=updated_workflow_definition)\nprint(workflow)\n"
} }
] ]
} }
@@ -621,7 +621,7 @@
"code-samples": [ "code-samples": [
{ {
"sdk": "python", "sdk": "python",
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"your_api_key\")\nawait skyvern.workflows.delete_workflow(workflow_id=\"wpid_123\")\n" "code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.workflows.delete_workflow(workflow_id=\"wpid_123\")\n"
} }
] ]
} }
@@ -698,7 +698,7 @@
"code-samples": [ "code-samples": [
{ {
"sdk": "python", "sdk": "python",
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"your_api_key\")\nbrowser_session = await skyvern.browser_sessions.create_browser_session(timeout=60)\nprint(browser_session)\n" "code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nbrowser_session = await skyvern.browser_sessions.create_browser_session(timeout=60)\nprint(browser_session)\n"
} }
] ]
} }
@@ -767,7 +767,7 @@
"code-samples": [ "code-samples": [
{ {
"sdk": "python", "sdk": "python",
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"your_api_key\")\nbrowser_sessions = await skyvern.browser_sessions.get_browser_sessions()\nprint(browser_sessions)\n" "code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nbrowser_sessions = await skyvern.browser_sessions.get_browser_sessions()\nprint(browser_sessions)\n"
} }
] ]
} }
@@ -848,7 +848,7 @@
"code-samples": [ "code-samples": [
{ {
"sdk": "python", "sdk": "python",
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"your_api_key\")\nawait skyvern.browser_sessions.close_browser_session(browser_session_id=\"pbs_123\")\n" "code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.browser_sessions.close_browser_session(browser_session_id=\"pbs_123\")\n"
} }
] ]
} }
@@ -932,7 +932,7 @@
"code-samples": [ "code-samples": [
{ {
"sdk": "python", "sdk": "python",
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"your_api_key\")\nbrowser_session = await skyvern.browser_sessions.get_browser_session(browser_session_id=\"pbs_123\")\nprint(browser_session)\n" "code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nbrowser_session = await skyvern.browser_sessions.get_browser_session(browser_session_id=\"pbs_123\")\nprint(browser_session)\n"
} }
] ]
} }
@@ -1083,11 +1083,11 @@
"code-samples": [ "code-samples": [
{ {
"sdk": "python", "sdk": "python",
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"your_api_key\")\nawait skyvern.credentials.create_credential(\n name=\"My Credential\",\n credential_type=\"password\",\n credential={\"username\": \"username\", \"password\": \"password\"},\n)\n" "code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.credentials.create_credential(\n name=\"My Credential\",\n credential_type=\"password\",\n credential={\"username\": \"username\", \"password\": \"password\"},\n)\n"
}, },
{ {
"sdk": "python", "sdk": "python",
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"your_api_key\")\nawait skyvern.credentials.create_credential(\n name=\"My Credit Card\",\n credential_type=\"credit_card\",\n credential={\n \"card_number\": \"4242424242424242\",\n \"card_cvv\": \"424\",\n \"card_exp_month\": \"12\",\n \"card_exp_year\": \"2028\",\n \"card_brand\": \"visa\",\n \"card_holder_name\": \"John Doe\",\n },\n)\n" "code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.credentials.create_credential(\n name=\"My Credit Card\",\n credential_type=\"credit_card\",\n credential={\n \"card_number\": \"4242424242424242\",\n \"card_cvv\": \"424\",\n \"card_exp_month\": \"12\",\n \"card_exp_year\": \"2028\",\n \"card_brand\": \"visa\",\n \"card_holder_name\": \"John Doe\",\n },\n)\n"
} }
] ]
} }
@@ -1187,7 +1187,7 @@
"code-samples": [ "code-samples": [
{ {
"sdk": "python", "sdk": "python",
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"your_api_key\")\ncredentials = await skyvern.credentials.get_credentials()\nprint(credentials)\n" "code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\ncredentials = await skyvern.credentials.get_credentials()\nprint(credentials)\n"
} }
] ]
} }
@@ -1259,7 +1259,7 @@
"code-samples": [ "code-samples": [
{ {
"sdk": "python", "sdk": "python",
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"your_api_key\")\nawait skyvern.credentials.delete_credential(credential_id=\"cred_123\")\n" "code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\nawait skyvern.credentials.delete_credential(credential_id=\"cred_123\")\n"
} }
] ]
} }
@@ -1338,7 +1338,7 @@
"code-samples": [ "code-samples": [
{ {
"sdk": "python", "sdk": "python",
"code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"your_api_key\")\ncredential = await skyvern.credentials.get_credential(credential_id=\"cred_123\")\nprint(credential)\n" "code": "from skyvern import Skyvern\n\nskyvern = Skyvern(api_key=\"YOUR_API_KEY\")\ncredential = await skyvern.credentials.get_credential(credential_id=\"cred_123\")\nprint(credential)\n"
} }
] ]
} }

34
skyvern/forge/sdk/routes/code_samples.py
View File

@@ -1,22 +1,22 @@
RUN_TASK_CODE_SAMPLE = """from skyvern import Skyvern RUN_TASK_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
await skyvern.agent.run_task(prompt="What's the top post on hackernews?") await skyvern.agent.run_task(prompt="What's the top post on hackernews?")
""" """
RUN_WORKFLOW_CODE_SAMPLE = """from skyvern import Skyvern RUN_WORKFLOW_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
await skyvern.agent.run_workflow(workflow_id="wpid_123", parameters={"parameter1": "value1", "parameter2": "value2"}) await skyvern.agent.run_workflow(workflow_id="wpid_123", parameters={"parameter1": "value1", "parameter2": "value2"})
""" """
GET_RUN_CODE_SAMPLE = """from skyvern import Skyvern GET_RUN_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
run = await skyvern.agent.get_run(run_id="tsk_v2_123") run = await skyvern.agent.get_run(run_id="tsk_v2_123")
print(run) print(run)
""" """
CANCEL_RUN_CODE_SAMPLE = """from skyvern import Skyvern CANCEL_RUN_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
await skyvern.agent.cancel_run(run_id="tsk_v2_123") await skyvern.agent.cancel_run(run_id="tsk_v2_123")
""" """
CREATE_WORKFLOW_CODE_SAMPLE = """curl -X POST https://api.skyvern.com/v1/workflows \ CREATE_WORKFLOW_CODE_SAMPLE = """curl -X POST https://api.skyvern.com/v1/workflows \
@@ -180,7 +180,7 @@ workflow_definition = {
], ],
}, },
} }
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
workflow = await skyvern.workflows.create_workflow(json_definition=workflow_definition) workflow = await skyvern.workflows.create_workflow(json_definition=workflow_definition)
print(workflow) print(workflow)
""" """
@@ -344,23 +344,23 @@ updated_workflow_definition = {
], ],
}, },
} }
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
workflow = await skyvern.workflows.update_workflow(workflow_id="wpid_123", json_definition=updated_workflow_definition) workflow = await skyvern.workflows.update_workflow(workflow_id="wpid_123", json_definition=updated_workflow_definition)
print(workflow) print(workflow)
""" """
DELETE_WORKFLOW_CODE_SAMPLE = """from skyvern import Skyvern DELETE_WORKFLOW_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
await skyvern.workflows.delete_workflow(workflow_id="wpid_123") await skyvern.workflows.delete_workflow(workflow_id="wpid_123")
""" """
SEND_TOTP_CODE_CODE_SAMPLE = """from skyvern import Skyvern SEND_TOTP_CODE_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
await skyvern.credentials.send_totp_code(totp_code="123456") await skyvern.credentials.send_totp_code(totp_code="123456")
""" """
CREATE_CREDENTIAL_CODE_SAMPLE = """from skyvern import Skyvern CREATE_CREDENTIAL_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
await skyvern.credentials.create_credential( await skyvern.credentials.create_credential(
name="My Credential", name="My Credential",
credential_type="password", credential_type="password",
@@ -369,7 +369,7 @@ await skyvern.credentials.create_credential(
""" """
CREATE_CREDENTIAL_CODE_SAMPLE_CREDIT_CARD = """from skyvern import Skyvern CREATE_CREDENTIAL_CODE_SAMPLE_CREDIT_CARD = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
await skyvern.credentials.create_credential( await skyvern.credentials.create_credential(
name="My Credit Card", name="My Credit Card",
credential_type="credit_card", credential_type="credit_card",
@@ -385,41 +385,41 @@ await skyvern.credentials.create_credential(
""" """
DELETE_CREDENTIAL_CODE_SAMPLE = """from skyvern import Skyvern DELETE_CREDENTIAL_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
await skyvern.credentials.delete_credential(credential_id="cred_123") await skyvern.credentials.delete_credential(credential_id="cred_123")
""" """
GET_CREDENTIAL_CODE_SAMPLE = """from skyvern import Skyvern GET_CREDENTIAL_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
credential = await skyvern.credentials.get_credential(credential_id="cred_123") credential = await skyvern.credentials.get_credential(credential_id="cred_123")
print(credential) print(credential)
""" """
GET_CREDENTIALS_CODE_SAMPLE = """from skyvern import Skyvern GET_CREDENTIALS_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
credentials = await skyvern.credentials.get_credentials() credentials = await skyvern.credentials.get_credentials()
print(credentials) print(credentials)
""" """
CREATE_BROWSER_SESSION_CODE_SAMPLE = """from skyvern import Skyvern CREATE_BROWSER_SESSION_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
browser_session = await skyvern.browser_sessions.create_browser_session(timeout=60) browser_session = await skyvern.browser_sessions.create_browser_session(timeout=60)
print(browser_session) print(browser_session)
""" """
CLOSE_BROWSER_SESSION_CODE_SAMPLE = """from skyvern import Skyvern CLOSE_BROWSER_SESSION_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
await skyvern.browser_sessions.close_browser_session(browser_session_id="pbs_123") await skyvern.browser_sessions.close_browser_session(browser_session_id="pbs_123")
""" """
GET_BROWSER_SESSION_CODE_SAMPLE = """from skyvern import Skyvern GET_BROWSER_SESSION_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
browser_session = await skyvern.browser_sessions.get_browser_session(browser_session_id="pbs_123") browser_session = await skyvern.browser_sessions.get_browser_session(browser_session_id="pbs_123")
print(browser_session) print(browser_session)
""" """
GET_BROWSER_SESSIONS_CODE_SAMPLE = """from skyvern import Skyvern GET_BROWSER_SESSIONS_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key") skyvern = Skyvern(api_key="YOUR_API_KEY")
browser_sessions = await skyvern.browser_sessions.get_browser_sessions() browser_sessions = await skyvern.browser_sessions.get_browser_sessions()
print(browser_sessions) print(browser_sessions)
""" """