Skip to main content
GET
/
v1
/
runs
/
{run_id}
Get a run by id
curl --request GET \
  --url https://api.skyvern.com/v1/runs/{run_id}
{
  "run_id": "tsk_123",
  "status": "created",
  "created_at": "2025-01-01T00:00:00Z",
  "modified_at": "2025-01-01T00:05:00Z",
  "run_type": "task_v1",
  "output": {},
  "downloaded_files": [
    {
      "url": "<string>",
      "checksum": "<string>",
      "filename": "<string>",
      "modified_at": "2023-11-07T05:31:56Z"
    }
  ],
  "recording_url": "<string>",
  "screenshot_urls": [
    "<string>"
  ],
  "failure_reason": "<string>",
  "queued_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "app_url": "https://app.skyvern.com/tasks/tsk_123",
  "browser_session_id": "pbs_123",
  "browser_profile_id": "bp_123",
  "max_screenshot_scrolls": 123,
  "script_run": {
    "ai_fallback_triggered": false
  },
  "errors": [
    {}
  ],
  "step_count": 123,
  "run_request": {
    "prompt": "Find the top 3 posts on Hacker News.",
    "url": "https://www.hackernews.com",
    "engine": "skyvern-2.0",
    "title": "The title of my first skyvern task",
    "proxy_location": "RESIDENTIAL",
    "data_extraction_schema": {},
    "error_code_mapping": {
      "login_failed": "The login credentials are incorrect or the account is locked"
    },
    "max_steps": 10,
    "webhook_url": "https://my-site.com/webhook",
    "totp_identifier": "john.doe@example.com",
    "totp_url": "https://my-totp-service.com/totp",
    "browser_session_id": "pbs_123",
    "model": {},
    "extra_http_headers": {},
    "publish_workflow": false,
    "include_action_history_in_verification": false,
    "max_screenshot_scrolls": 123,
    "browser_address": "http://127.0.0.1:9222",
    "run_with": "agent"
  }
}

Headers

​
x-api-key
string | null

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Path Parameters

​
run_id
string
required

The id of the task run or the workflow run.

Example:

"tsk_123"

Response

Successfully got run

​
run_id
string
required

Unique identifier for this run. Run ID starts with tsk_ for task runs and wr_ for workflow runs.

Example:

"tsk_123"

​
status
enum<string>
required

Current status of the run

Available options:
created,
queued,
running,
timed_out,
failed,
terminated,
completed,
canceled
Example:

"created"

​
created_at
string<date-time>
required

Timestamp when this run was created

Example:

"2025-01-01T00:00:00Z"

​
modified_at
string<date-time>
required

Timestamp when this run was last modified

Example:

"2025-01-01T00:05:00Z"

​
run_type
enum<string>
required

Types of a task run - task_v1, task_v2, openai_cua, anthropic_cua, ui_tars

Available options:
task_v1,
task_v2,
openai_cua,
anthropic_cua,
ui_tars
​
output

Output data from the run, if any. Format/schema depends on the data extracted by the run.

​
downloaded_files
FileInfo · object[] | null

List of files downloaded during the run

​
recording_url
string | null

URL to the recording of the run

​
screenshot_urls
string[] | null

List of last n screenshot URLs in reverse chronological order - the first one the list is the latest screenshot.

​
failure_reason
string | null

Reason for failure if the run failed or terminated

​
queued_at
string<date-time> | null

Timestamp when this run was queued

​
started_at
string<date-time> | null

Timestamp when this run started execution

​
finished_at
string<date-time> | null

Timestamp when this run finished

​
app_url
string | null

URL to the application UI where the run can be viewed

Example:

"https://app.skyvern.com/tasks/tsk_123"

​
browser_session_id
string | null

ID of the Skyvern persistent browser session used for this run

Example:

"pbs_123"

​
browser_profile_id
string | null

ID of the browser profile used for this run

Example:

"bp_123"

​
max_screenshot_scrolls
integer | null

The maximum number of scrolls for the post action screenshot. When it's None or 0, it takes the current viewpoint screenshot

​
script_run
ScriptRunResponse · object

The script run result

​
errors
Errors · object[] | null

The errors for the run

​
step_count
integer | null

Total number of steps executed in this run

​
run_request
TaskRunRequest · object

The original request parameters used to start this task run