Shortcuts

Run Shortcut

Starts a shortcut run with the provided input data. The shortcut must be published. Key input_data by each field's reference value from the shortcut's input_schema (see Get Shortcut); unknown keys are rejected with a 400 listing the valid references. The run is asynchronous — poll the Get Shortcut Run endpoint for status and results.

post/api/v1/shortcuts/{id}/run

Request

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

Path parameters

idstring required

App ID

Request body

input_dataobject required

Input field values keyed by each field's reference from the shortcut's input_schema

Response

Default Response

statusinteger
messagestring

Changes

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