{"openapi":"3.1.0","info":{"title":"Skyvern (BYOK) API","version":"0.1.0","description":"Skyvern (BYOK) lets an AI assistant read your own Skyvern data through the Skyvern API with a key you supply (API key). Read-only: 6 tools (list_agents, get_agent, list_runs, list_agent_runs, list_folders, list_browser_profiles). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.skyvern.com. Unofficial...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-skyvern.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-skyvern/docs"},"termsOfService":"https://connectorbay.com/byok-skyvern/terms"},"servers":[{"url":"https://byok-skyvern.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-skyvern/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_agents":{"post":{"operationId":"list_agents","summary":"List Skyvern agents (browser automation workflows) with title, version, status, folder and dates; the workflow definitio","description":"List Skyvern agents (browser automation workflows) with title, version, status, folder and dates; the workflow definitions are not returned. Use for \"Which Skyvern agents do I have and which are published\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items per page (default 10).","title":"Page Size"},"only_workflows":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to list only workflows, not saved tasks.","title":"Only Workflows"},"only_saved_tasks":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to list only saved tasks.","title":"Only Saved Tasks"},"only_templates":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to list only templates.","title":"Only Templates"},"title":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only agents whose title contains this text.","title":"Title"},"folder_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only agents in this folder ID.","title":"Folder Id"}},"title":"list_agentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_agent":{"post":{"operationId":"get_agent","summary":"Get one Skyvern agent by its permanent ID (latest version unless a version is given) with title, status, run settings an","description":"Get one Skyvern agent by its permanent ID (latest version unless a version is given) with title, status, run settings and dates; the workflow definition is not returned. Use for \"Show the settings of one Skyvern agent\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workflow_permanent_id":{"description":"Agent permanent ID (starts with 'wpid_'), as returned by list_agents.","maxLength":100,"title":"Workflow Permanent Id","type":"string"},"version":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Specific version number; leave out for the latest.","title":"Version"}},"required":["workflow_permanent_id"],"title":"get_agentArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_runs":{"post":{"operationId":"list_runs","summary":"List runs of all Skyvern agents, newest first, with status, failure reason, credits used and times. Use for \"Which Skyve","description":"List runs of all Skyvern agents, newest first, with status, failure reason, credits used and times. Use for \"Which Skyvern runs failed recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items per page (default 10).","title":"Page Size"},"search_key":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Text to match against run and agent names.","title":"Search Key"},"error_code":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only runs that ended with this error code.","title":"Error Code"}},"title":"list_runsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_agent_runs":{"post":{"operationId":"list_agent_runs","summary":"List runs of one Skyvern agent with status, failure reason, credits used and times. Filter by creation time. Use for \"Sh","description":"List runs of one Skyvern agent with status, failure reason, credits used and times. Filter by creation time. Use for \"Show the runs of one Skyvern agent\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workflow_id":{"description":"Agent workflow ID or permanent ID, as returned by list_agents.","maxLength":100,"title":"Workflow Id","type":"string"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items per page (default 10).","title":"Page Size"},"error_code":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only runs that ended with this error code.","title":"Error Code"},"created_at_start":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only runs created after this ISO 8601 time.","title":"Created At Start"},"created_at_end":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only runs created before this ISO 8601 time.","title":"Created At End"},"include_child_runs":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include runs started by other runs.","title":"Include Child Runs"}},"required":["workflow_id"],"title":"list_agent_runsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_folders":{"post":{"operationId":"list_folders","summary":"List agent folders with title, number of agents and dates. Use for \"Which Skyvern folders organize my agents\".","description":"List agent folders with title, number of agents and dates. Use for \"Which Skyvern folders organize my agents\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many folders per page (1 to 500, default 100).","title":"Page Size"},"search":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only folders whose title contains this text.","title":"Search"}},"title":"list_foldersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_browser_profiles":{"post":{"operationId":"list_browser_profiles","summary":"List saved browser profiles (reusable logged-in browser state) with name, whether managed, last verified login and dates","description":"List saved browser profiles (reusable logged-in browser state) with name, whether managed, last verified login and dates. Use for \"Which browser profiles has Skyvern saved\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items per page (default 10).","title":"Page Size"},"include_deleted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include deleted profiles.","title":"Include Deleted"},"search_key":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Text to match against profile names.","title":"Search Key"}},"title":"list_browser_profilesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}