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

doc revamp - complete code samples (#2378)

Browse Source
This commit is contained in:
Shuchang Zheng
2025-05-18 13:45:46 -07:00
committed by GitHub
parent d70c91bca2
commit 3e44a1995d
5 changed files with 477 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
skyvern/forge/sdk/routes/agent_protocol.py
View File

@@ -23,7 +23,15 @@ from skyvern.forge.sdk.core.security import generate_skyvern_signature
from skyvern.forge.sdk.db.enums import OrganizationAuthTokenType
from skyvern.forge.sdk.executor.factory import AsyncExecutorFactory
from skyvern.forge.sdk.models import Step
from skyvern.forge.sdk.routes.code_samples import GET_RUN_CODE_SAMPLE, RUN_TASK_CODE_SAMPLE, RUN_WORKFLOW_CODE_SAMPLE
from skyvern.forge.sdk.routes.code_samples import (
CANCEL_RUN_CODE_SAMPLE,
CREATE_WORKFLOW_CODE_SAMPLE,
DELETE_WORKFLOW_CODE_SAMPLE,
GET_RUN_CODE_SAMPLE,
RUN_TASK_CODE_SAMPLE,
RUN_WORKFLOW_CODE_SAMPLE,
UPDATE_WORKFLOW_CODE_SAMPLE,
)
from skyvern.forge.sdk.routes.routers import base_router, legacy_base_router, legacy_v2_router
from skyvern.forge.sdk.schemas.ai_suggestions import AISuggestionBase, AISuggestionRequest
from skyvern.forge.sdk.schemas.organizations import (
@@ -389,6 +397,7 @@ async def get_run(
openapi_extra={
"x-fern-sdk-group-name": "agent",
"x-fern-sdk-method-name": "cancel_run",
"x-fern-examples": [{"code-samples": [{"sdk": "python", "code": CANCEL_RUN_CODE_SAMPLE}]}],
},
description="Cancel a run (task or workflow)",
summary="Cancel a task or workflow run",
@@ -435,6 +444,7 @@ async def cancel_run(
openapi_extra={
"x-fern-sdk-group-name": "agent",
"x-fern-sdk-method-name": "create_workflow",
"x-fern-examples": [{"code-samples": [{"sdk": "curl", "code": CREATE_WORKFLOW_CODE_SAMPLE}]}],
},
description="Create a new workflow",
summary="Create a new workflow",
@@ -506,6 +516,7 @@ async def create_workflow(
},
"x-fern-sdk-group-name": "agent",
"x-fern-sdk-method-name": "update_workflow",
"x-fern-examples": [{"code-samples": [{"sdk": "curl", "code": UPDATE_WORKFLOW_CODE_SAMPLE}]}],
},
description="Update a workflow definition",
summary="Update a workflow definition",
@@ -573,6 +584,7 @@ async def update_workflow(
openapi_extra={
"x-fern-sdk-group-name": "agent",
"x-fern-sdk-method-name": "delete_workflow",
"x-fern-examples": [{"code-samples": [{"sdk": "python", "code": DELETE_WORKFLOW_CODE_SAMPLE}]}],
},
description="Delete a workflow",
summary="Delete a workflow",

41
skyvern/forge/sdk/routes/browser_sessions.py
View File

@@ -1,8 +1,14 @@
from fastapi import Depends, HTTPException
from fastapi import Depends, HTTPException, Path
from fastapi.responses import ORJSONResponse
from skyvern import analytics
from skyvern.forge import app
from skyvern.forge.sdk.routes.code_samples import (
CLOSE_BROWSER_SESSION_CODE_SAMPLE,
CREATE_BROWSER_SESSION_CODE_SAMPLE,
GET_BROWSER_SESSION_CODE_SAMPLE,
GET_BROWSER_SESSIONS_CODE_SAMPLE,
)
from skyvern.forge.sdk.routes.routers import base_router
from skyvern.forge.sdk.schemas.organizations import Organization
from skyvern.forge.sdk.services import org_auth_service
@@ -17,6 +23,7 @@ from skyvern.webeye.schemas import BrowserSessionResponse
openapi_extra={
"x-fern-sdk-group-name": "browser_session",
"x-fern-sdk-method-name": "create_browser_session",
"x-fern-examples": [{"code-samples": [{"sdk": "python", "code": CREATE_BROWSER_SESSION_CODE_SAMPLE}]}],
},
description="Create a new browser session",
summary="Create a new browser session",
@@ -25,6 +32,11 @@ from skyvern.webeye.schemas import BrowserSessionResponse
403: {"description": "Unauthorized - Invalid or missing authentication"},
},
)
@base_router.post(
"/browser_sessions/",
response_model=BrowserSessionResponse,
include_in_schema=False,
)
async def create_browser_session(
browser_session_request: CreateBrowserSessionRequest,
current_org: Organization = Depends(org_auth_service.get_current_org),
@@ -42,6 +54,7 @@ async def create_browser_session(
openapi_extra={
"x-fern-sdk-group-name": "browser_session",
"x-fern-sdk-method-name": "close_browser_session",
"x-fern-examples": [{"code-samples": [{"sdk": "python", "code": CLOSE_BROWSER_SESSION_CODE_SAMPLE}]}],
},
description="Close a browser session",
summary="Close a browser session",
@@ -50,8 +63,16 @@ async def create_browser_session(
403: {"description": "Unauthorized - Invalid or missing authentication"},
},
)
@base_router.post(
"/browser_sessions/{browser_session_id}/close/",
include_in_schema=False,
)
async def close_browser_session(
browser_session_id: str,
browser_session_id: str = Path(
...,
description="The ID of the browser session to close. completed_at will be set when the browser session is closed. browser_session_id starts with `pbs_`",
examples=["pbs_123456"],
),
current_org: Organization = Depends(org_auth_service.get_current_org),
) -> ORJSONResponse:
await app.PERSISTENT_SESSIONS_MANAGER.close_session(current_org.organization_id, browser_session_id)
@@ -69,6 +90,7 @@ async def close_browser_session(
openapi_extra={
"x-fern-sdk-group-name": "browser_session",
"x-fern-sdk-method-name": "get_browser_session",
"x-fern-examples": [{"code-samples": [{"sdk": "python", "code": GET_BROWSER_SESSION_CODE_SAMPLE}]}],
},
description="Get details about a specific browser session by ID",
summary="Get browser session details",
@@ -78,8 +100,15 @@ async def close_browser_session(
403: {"description": "Unauthorized - Invalid or missing authentication"},
},
)
@base_router.get(
"/browser_sessions/{browser_session_id}/",
response_model=BrowserSessionResponse,
include_in_schema=False,
)
async def get_browser_session(
browser_session_id: str,
browser_session_id: str = Path(
..., description="The ID of the browser session. browser_session_id starts with `pbs_`", examples=["pbs_123456"]
),
current_org: Organization = Depends(org_auth_service.get_current_org),
) -> BrowserSessionResponse:
analytics.capture("skyvern-oss-agent-browser-session-get")
@@ -99,6 +128,7 @@ async def get_browser_session(
openapi_extra={
"x-fern-sdk-group-name": "browser_session",
"x-fern-sdk-method-name": "get_browser_sessions",
"x-fern-examples": [{"code-samples": [{"sdk": "python", "code": GET_BROWSER_SESSIONS_CODE_SAMPLE}]}],
},
description="Get all active browser sessions for the organization",
summary="Get all active browser sessions",
@@ -107,6 +137,11 @@ async def get_browser_session(
403: {"description": "Unauthorized - Invalid or missing authentication"},
},
)
@base_router.get(
"/browser_sessions/",
response_model=list[BrowserSessionResponse],
include_in_schema=False,
)
async def get_browser_sessions(
current_org: Organization = Depends(org_auth_service.get_current_org),
) -> list[BrowserSessionResponse]:

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

@@ -1,18 +1,372 @@
RUN_TASK_CODE_SAMPLE = """from skyvern import Skyvern
client = Skyvern(api_key="your_api_key")
await client.run_task(prompt="What's the top post on hackernews?")
skyvern = Skyvern(api_key="your_api_key")
await skyvern.run_task(prompt="What's the top post on hackernews?")
"""
GET_RUN_CODE_SAMPLE = """from skyvern import Skyvern
client = Skyvern(api_key="your_api_key")
run = await client.get_run(run_id="tsk_123")
print(run)
"""
RUN_WORKFLOW_CODE_SAMPLE = """from skyvern import Skyvern
client = Skyvern(api_key="your_api_key")
await client.agent.run_workflow(workflow_id="wpid_123", parameters={"parameter1": "value1", "parameter2": "value2"})
skyvern = Skyvern(api_key="your_api_key")
await skyvern.agent.run_workflow(workflow_id="wpid_123", parameters={"parameter1": "value1", "parameter2": "value2"})
"""
GET_RUN_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key")
run = await skyvern.get_run(run_id="tsk_v2_123")
print(run)
"""
CANCEL_RUN_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key")
await skyvern.cancel_run(run_id="tsk_v2_123")
"""
CREATE_WORKFLOW_CODE_SAMPLE = """curl -X POST https://api.skyvern.com/v1/workflows \
--header 'x-api-key: {{x-api-key}}' \
--header 'Content-Type: application/x-yaml' \
--data-raw 'title: Invoice Downloading Demo (Jun 13)
description: >-
Login to the website, download all the invoices after a date, email the
invoices
workflow_definition:
parameters:
- key: website_url
parameter_type: workflow
workflow_parameter_type: string
- key: credentials
parameter_type: bitwarden_login_credential
bitwarden_client_id_aws_secret_key: SECRET
bitwarden_client_secret_aws_secret_key: SECRET
bitwarden_master_password_aws_secret_key: SECRET
bitwarden_collection_id: SECRET
url_parameter_key: website_url
- key: invoice_retrieval_start_date
parameter_type: workflow
workflow_parameter_type: string
- key: smtp_host
parameter_type: aws_secret
aws_key: SKYVERN_SMTP_HOST_AWS_SES
- key: smtp_port
parameter_type: aws_secret
aws_key: SKYVERN_SMTP_PORT_AWS_SES
- key: smtp_username
parameter_type: aws_secret
aws_key: SKYVERN_SMTP_USERNAME_SES
- key: smtp_password
parameter_type: aws_secret
aws_key: SKYVERN_SMTP_PASSWORD_SES
- parameter_type: context
key: order_history_url
source_parameter_key: get_order_history_page_url_and_qualifying_order_ids_output
- parameter_type: context
key: order_ids
source_parameter_key: get_order_history_page_url_and_qualifying_order_ids_output
- parameter_type: context
key: order_id
source_parameter_key: order_ids
blocks:
- block_type: task
label: login
parameter_keys:
- credentials
url: website_url
navigation_goal: >-
If you're not on the login page, navigate to login page and login using the credentials given, and then navigate to the personal account page. First, take actions on promotional popups or cookie prompts that could prevent taking other action on the web page. Then, try to login and navigate to the personal account page. If you fail to login to find the login page or can't login after several trials, terminate. If you're on the personal account page, consider the goal is completed.
error_code_mapping:
stuck_with_popups: terminate and return this error if you can't close popups after several tries and can't take the necessary actions on the website because there is a blocking popup on the page
failed_to_login: terminate and return this error if you fail logging in to the page
- block_type: task
label: get_order_history_page_url_and_qualifying_order_ids
parameter_keys:
- invoice_retrieval_start_date
navigation_goal: Find the order history page. If there is no orders after given start date, terminate.
data_extraction_goal: >-
You need to extract the order history page url by looking at the current
page you're on. You need to extract contact emails you see on the page. You also need to extract the order ids for orders that
happened on or after invoice_retrieval_start_date. Make sure to filter
only the orders that happened on or after invoice_retrieval_start_date. You need to compare each order's date with the invoice_download_start_date. You can only include an order in the output if the order's date is after or the same as the invoice_download_start_date.
While comparing dates, first compare year, then month, then day. invoice_retrieval_start_date
is in YYYY-MM-DD format. The dates on the websites may be in different formats, compare accordingly and compare year, date, and month.
error_code_mapping:
failed_to_find_order_history_page: return this error if you can't find the order history page on the website
no_orders_found_after_start_date: return this error if there are no orders after the specified invoice_download_start_date
data_schema:
type: object
properties:
order_history_url:
type: url
description: >-
The exact URL of the order history page. Do not make any
assumptions. Return the URL that's passed along in this context.
contact_emails:
type: array
items:
type: string
description: Contact email for the ecommerce website you're on. If you can't find any return null
date_comparison_scratchpad:
type: string
description: >-
You are supposed to filter the orders that happened on or after the invoice_download_start_date. Think through how you will approach this task step-by-step here. Consider these before starting the comparison:
- What format is the order date in? How can you parse it into a structured format?
- What is the correct way to compare two dates?
- How will you compare the order dates to the invoice_download_start_date?
Write out your thought process before filling out the order_ids field below. Remember, the original date may be in any format, so parse it carefully! The invoice_download_start_date will be an exact date you can directly compare against in the format YYYY-MM-DD.
order_ids:
type: array
items:
type: object
properties:
order_date:
type: iso-8601-date-string
order_id:
type: string
description: >-
Return a list of order id strings. Do not return order ids of
orders that happened before the specified
invoice_retrieval_start_date
- block_type: for_loop
label: iterate_over_order_ids
loop_over_parameter_key: order_ids
continue_on_failure: true
loop_blocks:
- block_type: task
label: download_invoice_for_order
complete_on_download: true
continue_on_failure: true
parameter_keys:
- order_id
url: order_history_url
navigation_goal: Download the invoice of the order with the given order ID. Make sure to download the invoice for the given order id. If the element tree doesn't have a matching order id, check the screenshots. Complete if you have successfully downloaded the invoice according to action history, if you were able to download it, you'll see download_triggered=True for the last step. If you don't see a way to download an invoice, navigate to the order page if possible. If there's no way to download an invoice terminate. If the text suggests printing, you can assume you can download it. Return click action with download=True if you want to trigger a download.
error_code_mapping:
not_possible_to_download_invoice: return this error if the website doesn't allow downloading/viewing invoices
cant_solve_captcha: return this error if captcha isn't solved after multiple retries
- block_type: upload_to_s3
label: upload_downloaded_files_to_s3
path: SKYVERN_DOWNLOAD_DIRECTORY
- block_type: send_email
label: send_email
smtp_host_secret_parameter_key: smtp_host
smtp_port_secret_parameter_key: smtp_port
smtp_username_secret_parameter_key: smtp_username
smtp_password_secret_parameter_key: smtp_password
sender: hello@skyvern.com
recipients:
- founders@skyvern.com
subject: Skyvern - Downloaded Invoices Demo
body: website_url
file_attachments:
- SKYVERN_DOWNLOAD_DIRECTORY
'
"""
UPDATE_WORKFLOW_CODE_SAMPLE = """curl -X POST https://api.skyvern.com/v1/workflows/wpid_123 \
--header 'x-api-key: {{x-api-key}}' \
--header 'Content-Type: application/x-yaml' \
--data-raw 'title: Invoice Downloading Demo (Jun 13)
description: >-
Login to the website, download all the invoices after a date, email the
invoices
workflow_definition:
parameters:
- key: website_url
parameter_type: workflow
workflow_parameter_type: string
- key: credentials
parameter_type: bitwarden_login_credential
bitwarden_client_id_aws_secret_key: SECRET
bitwarden_client_secret_aws_secret_key: SECRET
bitwarden_master_password_aws_secret_key: SECRET
bitwarden_collection_id: SECRET
url_parameter_key: website_url
- key: invoice_retrieval_start_date
parameter_type: workflow
workflow_parameter_type: string
- key: smtp_host
parameter_type: aws_secret
aws_key: SKYVERN_SMTP_HOST_AWS_SES
- key: smtp_port
parameter_type: aws_secret
aws_key: SKYVERN_SMTP_PORT_AWS_SES
- key: smtp_username
parameter_type: aws_secret
aws_key: SKYVERN_SMTP_USERNAME_SES
- key: smtp_password
parameter_type: aws_secret
aws_key: SKYVERN_SMTP_PASSWORD_SES
- parameter_type: context
key: order_history_url
source_parameter_key: get_order_history_page_url_and_qualifying_order_ids_output
- parameter_type: context
key: order_ids
source_parameter_key: get_order_history_page_url_and_qualifying_order_ids_output
- parameter_type: context
key: order_id
source_parameter_key: order_ids
blocks:
- block_type: task
label: login
parameter_keys:
- credentials
url: website_url
navigation_goal: >-
If you're not on the login page, navigate to login page and login using the credentials given, and then navigate to the personal account page. First, take actions on promotional popups or cookie prompts that could prevent taking other action on the web page. Then, try to login and navigate to the personal account page. If you fail to login to find the login page or can't login after several trials, terminate. If you're on the personal account page, consider the goal is completed.
error_code_mapping:
stuck_with_popups: terminate and return this error if you can't close popups after several tries and can't take the necessary actions on the website because there is a blocking popup on the page
failed_to_login: terminate and return this error if you fail logging in to the page
- block_type: task
label: get_order_history_page_url_and_qualifying_order_ids
parameter_keys:
- invoice_retrieval_start_date
navigation_goal: Find the order history page. If there is no orders after given start date, terminate.
data_extraction_goal: >-
You need to extract the order history page url by looking at the current
page you're on. You need to extract contact emails you see on the page. You also need to extract the order ids for orders that
happened on or after invoice_retrieval_start_date. Make sure to filter
only the orders that happened on or after invoice_retrieval_start_date. You need to compare each order's date with the invoice_download_start_date. You can only include an order in the output if the order's date is after or the same as the invoice_download_start_date.
While comparing dates, first compare year, then month, then day. invoice_retrieval_start_date
is in YYYY-MM-DD format. The dates on the websites may be in different formats, compare accordingly and compare year, date, and month.
error_code_mapping:
failed_to_find_order_history_page: return this error if you can't find the order history page on the website
no_orders_found_after_start_date: return this error if there are no orders after the specified invoice_download_start_date
data_schema:
type: object
properties:
order_history_url:
type: url
description: >-
The exact URL of the order history page. Do not make any
assumptions. Return the URL that's passed along in this context.
contact_emails:
type: array
items:
type: string
description: Contact email for the ecommerce website you're on. If you can't find any return null
date_comparison_scratchpad:
type: string
description: >-
You are supposed to filter the orders that happened on or after the invoice_download_start_date. Think through how you will approach this task step-by-step here. Consider these before starting the comparison:
- What format is the order date in? How can you parse it into a structured format?
- What is the correct way to compare two dates?
- How will you compare the order dates to the invoice_download_start_date?
Write out your thought process before filling out the order_ids field below. Remember, the original date may be in any format, so parse it carefully! The invoice_download_start_date will be an exact date you can directly compare against in the format YYYY-MM-DD.
order_ids:
type: array
items:
type: object
properties:
order_date:
type: iso-8601-date-string
order_id:
type: string
description: >-
Return a list of order id strings. Do not return order ids of
orders that happened before the specified
invoice_retrieval_start_date
- block_type: for_loop
label: iterate_over_order_ids
loop_over_parameter_key: order_ids
continue_on_failure: true
loop_blocks:
- block_type: task
label: download_invoice_for_order
complete_on_download: true
continue_on_failure: true
parameter_keys:
- order_id
url: order_history_url
navigation_goal: Download the invoice of the order with the given order ID. Make sure to download the invoice for the given order id. If the element tree doesn't have a matching order id, check the screenshots. Complete if you have successfully downloaded the invoice according to action history, if you were able to download it, you'll see download_triggered=True for the last step. If you don't see a way to download an invoice, navigate to the order page if possible. If there's no way to download an invoice terminate. If the text suggests printing, you can assume you can download it. Return click action with download=True if you want to trigger a download.
error_code_mapping:
not_possible_to_download_invoice: return this error if the website doesn't allow downloading/viewing invoices
cant_solve_captcha: return this error if captcha isn't solved after multiple retries
- block_type: upload_to_s3
label: upload_downloaded_files_to_s3
path: SKYVERN_DOWNLOAD_DIRECTORY
- block_type: send_email
label: send_email
smtp_host_secret_parameter_key: smtp_host
smtp_port_secret_parameter_key: smtp_port
smtp_username_secret_parameter_key: smtp_username
smtp_password_secret_parameter_key: smtp_password
sender: hello@skyvern.com
recipients:
- founders@skyvern.com
subject: Skyvern - Downloaded Invoices Demo
body: website_url
file_attachments:
- SKYVERN_DOWNLOAD_DIRECTORY
'
"""
DELETE_WORKFLOW_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key")
await skyvern.agent.delete_workflow(workflow_id="wpid_123")
"""
SEND_TOTP_CODE_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key")
await skyvern.credentials.send_totp_code(totp_code="123456")
"""
CREATE_CREDENTIAL_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key")
await skyvern.credentials.create_credential(
name="Amazon Login",
credential_type="password",
credential={"username": "user@example.com", "password": "myamazonpassword"},
)
"""
CREATE_CREDENTIAL_CODE_SAMPLE_CREDIT_CARD = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key")
await skyvern.credentials.create_credential(
name="Amazon Login",
credential_type="credit_card",
credential={
"card_number": "4242424242424242",
"card_cvv": "424",
"card_exp_month": "12",
"card_exp_year": "2028",
"card_brand": "visa",
"card_holder_name": "John Doe",
},
)
"""
DELETE_CREDENTIAL_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key")
await skyvern.credentials.delete_credential(credential_id="cred_123")
"""
GET_CREDENTIAL_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key")
credential = await skyvern.credentials.get_credential(credential_id="cred_123")
print(credential)
"""
GET_CREDENTIALS_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key")
credentials = await skyvern.credentials.get_credentials()
print(credentials)
"""
CREATE_BROWSER_SESSION_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key")
browser_session = await skyvern.browser_sessions.create_browser_session(timeout=60)
print(browser_session)
"""
CLOSE_BROWSER_SESSION_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key")
await skyvern.browser_sessions.close_browser_session(browser_session_id="pbs_123")
"""
GET_BROWSER_SESSION_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key")
browser_session = await skyvern.browser_sessions.get_browser_session(browser_session_id="pbs_123")
print(browser_session)
"""
GET_BROWSER_SESSIONS_CODE_SAMPLE = """from skyvern import Skyvern
skyvern = Skyvern(api_key="your_api_key")
browser_sessions = await skyvern.browser_sessions.get_browser_sessions()
print(browser_sessions)
"""

50
skyvern/forge/sdk/routes/credentials.py
View File

@@ -3,6 +3,14 @@ from fastapi import Body, Depends, HTTPException, Path, Query
from skyvern.forge import app
from skyvern.forge.prompts import prompt_engine
from skyvern.forge.sdk.routes.code_samples import (
CREATE_CREDENTIAL_CODE_SAMPLE,
CREATE_CREDENTIAL_CODE_SAMPLE_CREDIT_CARD,
DELETE_CREDENTIAL_CODE_SAMPLE,
GET_CREDENTIAL_CODE_SAMPLE,
GET_CREDENTIALS_CODE_SAMPLE,
SEND_TOTP_CODE_CODE_SAMPLE,
)
from skyvern.forge.sdk.routes.routers import base_router, legacy_base_router
from skyvern.forge.sdk.schemas.credentials import (
CreateCredentialRequest,
@@ -31,20 +39,26 @@ async def parse_totp_code(content: str) -> str | None:
openapi_extra={
"x-fern-sdk-group-name": "agent",
"x-fern-sdk-method-name": "send_totp_code",
"x-fern-examples": [{"code-samples": [{"sdk": "python", "code": SEND_TOTP_CODE_CODE_SAMPLE}]}],
},
)
@legacy_base_router.post("/totp/", include_in_schema=False)
@base_router.post(
"/credentials/totp",
response_model=TOTPCode,
summary="Forward TOTP (2FA, MFA) code to Skyvern",
description="Forward a TOTP (2FA, MFA) code to Skyvern",
summary="Send TOTP (2FA, MFA) code to Skyvern",
description="Forward a TOTP (2FA, MFA) email or sms message containing the code to Skyvern",
tags=["Credentials"],
openapi_extra={
"x-fern-sdk-group-name": "credentials",
"x-fern-sdk-method-name": "send_totp_code",
},
)
@base_router.post(
"/credentials/totp/",
response_model=TOTPCode,
include_in_schema=False,
)
async def send_totp_code(
data: TOTPCodeCreate, curr_org: Organization = Depends(org_auth_service.get_current_org)
) -> TOTPCode:
@@ -83,8 +97,22 @@ async def send_totp_code(
openapi_extra={
"x-fern-sdk-group-name": "credentials",
"x-fern-sdk-method-name": "create_credential",
"x-fern-examples": [
{
"code-samples": [
{"sdk": "python", "code": CREATE_CREDENTIAL_CODE_SAMPLE},
{"sdk": "python", "code": CREATE_CREDENTIAL_CODE_SAMPLE_CREDIT_CARD},
]
}
],
},
)
@base_router.post(
"/credentials/",
response_model=CredentialResponse,
status_code=201,
include_in_schema=False,
)
async def create_credential(
data: CreateCredentialRequest = Body(
...,
@@ -160,8 +188,14 @@ async def create_credential(
openapi_extra={
"x-fern-sdk-group-name": "credentials",
"x-fern-sdk-method-name": "delete_credential",
"x-fern-examples": [{"code-samples": [{"sdk": "python", "code": DELETE_CREDENTIAL_CODE_SAMPLE}]}],
},
)
@base_router.post(
"/credentials/{credential_id}/delete/",
status_code=204,
include_in_schema=False,
)
async def delete_credential(
credential_id: str = Path(
...,
@@ -200,8 +234,14 @@ async def delete_credential(
openapi_extra={
"x-fern-sdk-group-name": "credentials",
"x-fern-sdk-method-name": "get_credential",
"x-fern-examples": [{"code-samples": [{"sdk": "python", "code": GET_CREDENTIAL_CODE_SAMPLE}]}],
},
)
@base_router.get(
"/credentials/{credential_id}/",
response_model=CredentialResponse,
include_in_schema=False,
)
async def get_credential(
credential_id: str = Path(
...,
@@ -262,8 +302,14 @@ async def get_credential(
openapi_extra={
"x-fern-sdk-group-name": "credentials",
"x-fern-sdk-method-name": "get_credentials",
"x-fern-examples": [{"code-samples": [{"sdk": "python", "code": GET_CREDENTIALS_CODE_SAMPLE}]}],
},
)
@base_router.get(
"/credentials/",
response_model=list[CredentialResponse],
include_in_schema=False,
)
async def get_credentials(
current_org: Organization = Depends(org_auth_service.get_current_org),
page: int = Query(

16
skyvern/webeye/schemas.py
View File

@@ -10,15 +10,23 @@ from skyvern.forge.sdk.schemas.persistent_browser_sessions import PersistentBrow
class BrowserSessionResponse(BaseModel):
"""Response model for browser session information."""
browser_session_id: str = Field(description="Unique identifier for the browser session")
browser_session_id: str = Field(
description="Unique identifier for the browser session. browser_session_id starts with `pbs_`.",
examples=["pbs_123456"],
)
organization_id: str = Field(description="ID of the organization that owns this session")
runnable_type: str | None = Field(
None, description="Type of runnable associated with this session (workflow, task etc)"
None,
description="Type of the current runnable associated with this session (workflow, task etc)",
examples=["task", "workflow_run"],
)
runnable_id: str | None = Field(
None, description="ID of the current runnable", examples=["tsk_123456", "wr_123456"]
)
runnable_id: str | None = Field(None, description="ID of the associated runnable")
timeout: int | None = Field(
None,
description="Timeout in minutes for the session. Timeout is applied after the session is started.",
description="Timeout in minutes for the session. Timeout is applied after the session is started. Defaults to 60 minutes.",
examples=[60, 120],
)
started_at: datetime | None = Field(None, description="Timestamp when the session was started")
completed_at: datetime | None = Field(None, description="Timestamp when the session was completed")