{"id":23885093,"url":"https://github.com/elucherini/skyvern-client","last_synced_at":"2025-10-14T04:19:10.682Z","repository":{"id":263309976,"uuid":"889732234","full_name":"elucherini/skyvern-client","owner":"elucherini","description":"A lightweight Python-based Skyvern client","archived":false,"fork":false,"pushed_at":"2024-11-17T18:21:31.000Z","size":90,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-23T02:31:44.102Z","etag":null,"topics":["api","automation","browser","browser-automation","client","llm","skyvern"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/elucherini.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-17T04:34:42.000Z","updated_at":"2025-02-06T20:01:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"238a2828-c454-4eaa-9f2a-d4c9e80bdb3d","html_url":"https://github.com/elucherini/skyvern-client","commit_stats":null,"previous_names":["elucherini/skyvern-client"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/elucherini/skyvern-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elucherini%2Fskyvern-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elucherini%2Fskyvern-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elucherini%2Fskyvern-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elucherini%2Fskyvern-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elucherini","download_url":"https://codeload.github.com/elucherini/skyvern-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elucherini%2Fskyvern-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279017949,"owners_count":26086213,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-14T02:00:06.444Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","automation","browser","browser-automation","client","llm","skyvern"],"created_at":"2025-01-04T04:39:02.437Z","updated_at":"2025-10-14T04:19:10.677Z","avatar_url":"https://github.com/elucherini.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# skyvern-client\nA lightweight Python-based Skyvern client\n\n## Setup\n\nThis library is available as a PyPi package that you can install, for example, with pip:\n```bash\npip install skyvern-client\n```\n\nAlternatively, you can install it directly from this repo.\n\n- Make sure you have installed [poetry](https://python-poetry.org/docs/#installation)\n- Clone the repo and install dependencies:\n```bash\ngit clone git@github.com:elucherini/skyvern-client.git\ncd skyvern-client\npoetry install\n```\n\n## Usage\n- Create a `.env` file in the root with your Skyvern API key. An example is provided in `.env_example`.\n- Use this library!\n\n### Example\n\n```python\nfrom dotenv import load_dotenv\nfrom skyvern_client import SkyvernClient\n\n# Initialize client; use https://api.skyvern.com/ for the cloud-hosted skyvern\nload_dotenv()\nclient = SkyvernClient(\"http://localhost:8000\")\n\n# Retrieve all tasks\nall_tasks = client.list_tasks()\n\n# Get an existing task by ID\nprint(client.get_task(all_tasks[0][\"task_id\"]))\n\n# Create a new task\ntask_payload = {\n    \"title\": \"my title\",\n    \"url\": \"https://www.target.com\",\n    \"webhook_callback_url\": None,\n    \"navigation_goal\": \"Go to target.com and add any item to the cart. COMPLETE when an item has been added to \"\n                       \"the cart and the cart is not empty. Do not add more than one item to the cart.\",\n    \"data_extraction_goal\": None,\n    \"proxy_location\": \"RESIDENTIAL\",\n    \"navigation_payload\": None,\n    \"extracted_information_schema\": None,\n    \"totp_verification_url\": None,\n    \"totp_identifier\": None,\n    \"error_code_mapping\": None\n}\n\nclient.create_task(task_payload)\n```\n\n## FAQ\n\n#### 1. Do I need an LLM to use this library?\n\nNo, but the Skyvern UI uses an LLM to generate the payload for task generation. That functionality will be \navailable soon. For now, I have imported the prompt used by Skyvern in `skyvern-prompts/generate-task.j2`. Feel free to\nprompt your LLM of choice with that prompt and lightly parse the output before calling `create_task`.\n\n#### 2. Where can I find my Skyvern API key?\n\nGo to the Skyvern UI and click on Settings. Locate the \"API Keys\" section and click on Reveal.\n\nAlternatively, you may want to create a task through a customized prompt with the UI. After submitting and next to the \n\"Run\" button, you will find a \"cURL\" button. This will copy the cURL request to your clipboard and will look like this:\n\n```\ncurl 'https://api.skyvern.com/api/v1/tasks' -X POST -H \"Content-Type: application/json\" -H \"x-api-key: abcde321.abcde1234.edabc321\" --data-binary '{\"title\":null,\"url\":\"https://www.target.com\",\"webhook_callback_url\":null,\"navigation_goal\":null,\"data_extraction_goal\":null,\"proxy_location\":\"RESIDENTIAL\",\"navigation_payload\":\"null\",\"extracted_information_schema\":null,\"totp_verification_url\":null,\"totp_identifier\":null,\"error_code_mapping\":null}'\n```\n\nUse a text editor to extract the value of `x-api-key`.\n\n#### 3. Does this library work with Cloud or self-hosted Skyvern?\n\nBoth!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felucherini%2Fskyvern-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felucherini%2Fskyvern-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felucherini%2Fskyvern-client/lists"}