diff --git a/README.md b/README.md index 83f56de4..402fc093 100644 --- a/README.md +++ b/README.md @@ -119,6 +119,27 @@ curl -X POST -H 'Content-Type: application/json' -H 'x-api-key: {Your local API }' http://0.0.0.0:8000/api/v1/tasks ``` +## Debugging Skyvern +Skyvern's visualizer allows you to debug every interaction Skyvern takes on the web. + +### Tasks, Steps, and Actions +Each API request you sent to Skyvern is called a "task". Each task is made up of "steps" which are the individual actions Skyvern takes to complete the task. Each step is made up of "actions" which are the individual interactions Skyvern takes on a particular website. + +Every time you call the API, you will be given a task_id you can use to find a task within the visualizer. Within each task, you'll be able to interact with each step, and see the specific actions Skyvern took to complete the task. + +In the screenshot below, we're navigating to finditparts.com and searching for a truck part. You'll see each action it took listed there, alongside the reasoning behind each action. +
+
+
+
+