Sign in
Runs

Get run info by id

Get run information (task run, workflow run)

get/v1/runs/{run_id}

Path parameters

run_idstring required

The id of the task run or the workflow run.

Example:tsk_123

The id of the task run or the workflow run.

Headers

x-api-keystring nullable

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

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

Response

Successfully got run

OR

Example response

{
  "run_id": "tsk_123",
  "created_at": "2025-01-01T00:00:00Z",
  "modified_at": "2025-01-01T00:05:00Z",
  "app_url": "https://app.skyvern.com/tasks/tsk_123",
  "browser_session_id": "pbs_123",
  "browser_profile_id": "bp_123",
  "run_request": {
    "prompt": "Find the top 3 posts on Hacker News.",
    "url": "https://www.hackernews.com",
    "title": "The title of my first skyvern task",
    "proxy_location": {
      "country": "US",
      "subdivision": "CA",
      "city": "New York"
    },
    "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",
    "browser_address": "http://127.0.0.1:9222",
    "run_with": "agent",
    "file_ids": [
      "file_123456789"
    ]
  }
}

Changes

Changed in 20 of the 101 revisions of this API.364248

  • 66f8cba9377d2See the full diff
    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

  • 272ef19d10174See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • f6a594c586781See the full diff
    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

  • 89037b86e0042See the full diff
    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

  • 830020b643cd1See the full diff
    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

  • 0c5e6f1a3df921See the full diff
    • ●

      added the new skyvern-3.0 enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new task_v3 enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added task_v3 mapping keys to the response discriminator for the response status

      response-body-discriminator-mapping-added

  • bd64e0480f0a4See the full diff
    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

  • b7fa64d357692See the full diff
    • ●

      added the new paused enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new paused enum value to the / response property for the response status

      response-property-enum-value-added

  • cd89b4c6f0041See the full diff
    • ▲

      the //// response property's max was increased from 240.00 to 480.00 for the response status

      response-property-max-increased

  • e5a0a7c3a5c62See the full diff
    • ○

      api tag Runs added

      api-tag-added

    • ○

      api tag Agents removed

      api-tag-removed