simplify credentials doc (#2488)

This commit is contained in:
Shuchang Zheng
2025-05-27 11:06:12 -07:00
committed by GitHub
parent 9e646bd9a1
commit 306eac8a58
7 changed files with 43 additions and 25 deletions

View File

@@ -12,6 +12,7 @@ Skyvern Browser Session is a way to persist the real-time state of the browser,
Skyvern Browser Sessions is currently is only available via [API & SDK](/api-reference/api-reference/browser-session/create-browser-session). Skyvern Browser Sessions is currently is 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)
```python ```python
from skyvern import Skyvern from skyvern import Skyvern
@@ -22,12 +23,29 @@ browser_session = await skyvern.browser_sessions.create_browser_session(
) )
``` ```
The `timeout` parameter (`>=5, <=10080`) is the max time in minutes that the browser session can run. - The `timeout` parameter (`>=5, <=10080`) is the max time in minutes that the browser session can run. By default, the timeout is 60 minutes.
- The `browser_session_id` the session ID you should note.
## Get A Browser Session
- [API doc](/api-reference/api-reference/browser-session/get-browser-session)
```python
from skyvern import Skyvern
## Get Information Of A Browser Session skyvern = Skyvern(api_key="YOUR_API_KEY")
[API doc](/api-reference/api-reference/browser-session/get-browser-session) browser_session = await skyvern.browser_sessions.get_browser_session(
browser_session_id="YOUR_BROWSER_SESSION_ID",
)
```
## Close a Browser Session ## Close A Browser Session
[API doc](/api-reference/api-reference/browser-session/close-browser-session) - [API doc](/api-reference/api-reference/browser-session/close-browser-session)
```python
from skyvern import Skyvern
skyvern = Skyvern(api_key="YOUR_API_KEY")
await skyvern.browser_sessions.close_browser_session(
browser_session_id="YOUR_BROWSER_SESSION_ID",
)
```

View File

@@ -4,28 +4,27 @@ 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
You can go to [Skyvern's Credentials page](https://app.skyvern.com/credentials) to manage your credit cards. Same as passwords, credit cards are also managed in the [Skyvern's Credentials](https://app.skyvern.com/credentials) page.
### Add a new credit card:
**Add a new credit card credential:**
<img src="../images/credential_management/add_credit_card.png" /> <img src="../images/credential_management/add_credit_card.png" />
<img src="../images/credential_management/add_credit_card_detail.png" /> <img src="../images/credential_management/add_credit_card_detail.png" />
**Delete a credit card credential:** ### Delete a credit card:
Click the trash icon and confirm the deletion. If you do this, the credit card will be deleted from Skyvern PERMANENTLY. Click the trash icon and confirm the deletion. If you do this, the credit card will be deleted from Skyvern PERMANENTLY.
<img src="../images/credential_management/delete_credit_card.png" /> <img src="../images/credential_management/delete_credit_card.png" />
**Update a credit card credential:** ### Update a credit card:
<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 API & SDK ## 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:
<CodeBlocks> <CodeBlocks>
```python title="python" ```python title="python"
@@ -64,7 +63,7 @@ curl -X POST https://api.skyvern.com/v1/credentials \
``` ```
</CodeBlocks> </CodeBlocks>
**Delete a password credential:** ### Delete a credit card:
<CodeBlocks> <CodeBlocks>
```python title="python" ```python title="python"

View File

@@ -1,10 +1,10 @@
--- ---
title: Secure Credential Management For AI Agents title: Credential Management
subtitle: Never send your credentials to LLMs. subtitle: Never send your credentials to LLMs.
slug: credentials/introduction slug: credentials/introduction
--- ---
In many scenarios, agents need access to sensitive information to complete tasks. For example, usernames and passwords to login, credit cards for payments, etc. With Skyvern's credential features, you can manage and use credentials to run agents securely without exposing your credentials to LLMs. Agents need access to sensitive information to complete tasks. For example, usernames and passwords to login, credit cards for payments, etc. With Skyvern's credential management tool, you can run agents securely without exposing your credentials to LLMs.
## Credential Support ## Credential Support
<CardGroup cols={2}> <CardGroup cols={2}>

View File

@@ -8,9 +8,10 @@ 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 ## How To Manage Passwords
You can go to [Skyvern's Credentials page](https://app.skyvern.com/credentials) to manage your passwords. This can be done in the [Skyvern's Credentials](https://app.skyvern.com/credentials) page.
**Add a new password credential:**
### Add a new password:
<img src="../images/credential_management/add_password.png" /> <img src="../images/credential_management/add_password.png" />
@@ -18,12 +19,12 @@ Besides the username and password, you can also add the Two Factor Authenticatio
<img src="../images/credential_management/add_password_detail.png" /> <img src="../images/credential_management/add_password_detail.png" />
**Delete a password credential:** ### Delete a password:
Click the trash icon and confirm the deletion. If you do this, the password will be deleted from Skyvern PERMANENTLY. Click the trash icon and confirm the deletion. If you do this, the password will be deleted from Skyvern PERMANENTLY.
<img src="../images/credential_management/delete_password.png" /> <img src="../images/credential_management/delete_password.png" />
**Update a password credential:** ### 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 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 API & SDK ## Manage Passwords with API & SDK

View File

@@ -1,6 +1,6 @@
--- ---
title: 2FA Support (TOTP) title: 2FA Support (TOTP)
subtitle: How to send TOTP codes (2FA/MFA/Verification Code) to Skyvern subtitle: How to send 2FA codes (TOTP) to Skyvern
slug: credentials/totp slug: credentials/totp
--- ---

View File

@@ -98,7 +98,7 @@ navigation:
path: workflows/workflow-parameters.mdx path: workflows/workflow-parameters.mdx
- page: Run Workflows - page: Run Workflows
path: workflows/run-workflows.mdx path: workflows/run-workflows.mdx
- page: Make Workflows Consistent And Reliable - page: Consistency and Reliability
path: workflows/consistent-workflows.mdx path: workflows/consistent-workflows.mdx
- page: Running Workflows - page: Running Workflows
path: workflows/running-workflows.mdx path: workflows/running-workflows.mdx
@@ -120,7 +120,7 @@ navigation:
hidden: true hidden: true
- section: Credentials - section: Credentials
contents: contents:
- page: Introduction - page: Overview
path: credentials/introduction.mdx path: credentials/introduction.mdx
- page: Password Management - page: Password Management
path: credentials/passwords.mdx path: credentials/passwords.mdx

View File

@@ -1,5 +1,5 @@
--- ---
title: Make Workflows Consistent And Reliable title: Consistency and Reliability
slug: workflows/consistent-workflows slug: workflows/consistent-workflows
--- ---