Shortcuts

Get Shortcut Run

Returns details for a single shortcut run, including input data, output data, and current status. For in-progress runs, the status is fetched live from the underlying workflow engine — so this endpoint reflects real-time progress. Poll this endpoint to wait for completion.

get/api/v1/shortcuts/{id}/runs/{runId}

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Path parameters

idstring required

Shortcut ID

runIdstring required

Run ID

Query parameters

include_steps'true' | 'false'

Include read-only step results from the executed global shortcut version.

Response

Default Response

statusinteger

Example response

{
  "data": {
    "id": "f1a2b3c4-d5e6-7f8a-9b0c-1d2e3f4a5b6c",
    "input_schema": [
      {
        "reference": "linkedin_url",
        "name": "LinkedIn URL",
        "description": "Full LinkedIn company profile URL",
        "type": "text",
        "required": true
      }
    ],
    "output_schema": [
      {
        "name": "Company Website",
        "description": "Main website URL of the company",
        "display_column": "Company Website"
      }
    ],
    "status": "pending"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.