Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
add fern doc for login sdk (#3014)
Shuchang Zheng7c5a799478a9
diff --git a/skyvern/forge/sdk/routes/browser_sessions.py b/skyvern/forge/sdk/routes/browser_sessions.pyindex 04892f494..d975d6d1b 100644--- a/skyvern/forge/sdk/routes/browser_sessions.py+++ b/skyvern/forge/sdk/routes/browser_sessions.py@@ -24,8 +24,8 @@ from skyvern.webeye.schemas import BrowserSessionResponse"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",+ description="Create a browser session that persists across multiple runs",+ summary="Create a session",responses={200: {"description": "Successfully created browser session"},403: {"description": "Unauthorized - Invalid or missing authentication"},@@ -54,8 +54,8 @@ async def create_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",+ description="Close a session. Once closed, the session cannot be used again.",+ summary="Close a session",responses={200: {"description": "Successfully closed browser session"},403: {"description": "Unauthorized - Invalid or missing authentication"},@@ -89,8 +89,8 @@ async def close_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",+ description="Get details about a specific browser session, including the browser address for cdp connection.",+ summary="Get a session",responses={200: {"description": "Successfully retrieved browser session details"},404: {"description": "Browser session not found"},@@ -127,7 +127,7 @@ async def get_browser_session("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",+ summary="Get active browser sessions",responses={200: {"description": "Successfully retrieved all active browser sessions"},403: {"description": "Unauthorized - Invalid or missing authentication"},diff --git a/skyvern/forge/sdk/routes/code_samples.py b/skyvern/forge/sdk/routes/code_samples.pyindex 2dc5e5d58..7f628a901 100644--- a/skyvern/forge/sdk/routes/code_samples.py+++ b/skyvern/forge/sdk/routes/code_samples.py@@ -25,6 +25,11 @@ RETRY_RUN_WEBHOOK_CODE_SAMPLE = """from skyvern import Skyvernskyvern = Skyvern(api_key="YOUR_API_KEY")await skyvern.retry_run_webhook(run_id="tsk_v2_123")"""+LOGIN_CODE_SAMPLE = """from skyvern import Skyvern++skyvern = Skyvern(api_key="YOUR_API_KEY")+await skyvern.login(workflow_id="wpid_123", parameters={"parameter1": "value1", "parameter2": "value2"})+"""# WorkflowsCREATE_WORKFLOW_CODE_SAMPLE = """curl -X POST https://api.skyvern.com/v1/workflows \diff --git a/skyvern/forge/sdk/routes/run_blocks.py b/skyvern/forge/sdk/routes/run_blocks.pyindex f1723f3d7..1c97b8127 100644--- a/skyvern/forge/sdk/routes/run_blocks.py+++ b/skyvern/forge/sdk/routes/run_blocks.py@@ -7,6 +7,7 @@ from skyvern.config import settingsfrom skyvern.exceptions import MissingBrowserAddressErrorfrom skyvern.forge import appfrom skyvern.forge.sdk.core import skyvern_context+from skyvern.forge.sdk.routes.code_samples import LOGIN_CODE_SAMPLEfrom skyvern.forge.sdk.routes.routers import base_routerfrom skyvern.forge.sdk.schemas.organizations import Organizationfrom skyvern.forge.sdk.services import org_auth_service@@ -34,7 +35,14 @@ If login is completed, you're successful."""@base_router.post("/run/tasks/login",+ tags=["Agent"],response_model=WorkflowRunResponse,+ openapi_extra={+ "x-fern-sdk-method-name": "login",+ "x-fern-examples": [{"code-samples": [{"sdk": "python", "code": LOGIN_CODE_SAMPLE}]}],+ },+ description="Log in to a website using either credential stored in Skyvern, Bitwarden or 1Password",+ summary="Login Task",)async def login(request: Request,