ExternalRunRequest

workflowstring

Can be omitted when using path /workflows/{workflowName}/run.

Example: smoke

workflow_idstring

workflowNamestring

workflowIdstring

entrypoint_idstring

Workflow Ingress ID; uses target version default ingress when omitted. Conversation does not accept this field.

inputs object

The incoming structured input is named by the params of the selected Workflow entrypoint(Conversation, executor). multiple: true or The non-file parameters of control: "checkboxes" are serialized as JSON array strings. control: "textarea" affects only Desktop/server form rendering and is still processed as a normal string input. Date-related control also keep strings:date as YYYY-MM-DD, time HH:mm:ss, datetime are local YYYY-MM-DDTHH:mm:ss, date-range is a closed interval YYYY-MM-DD/YYYY-MM-DD, no time zone conversion is performed. The default value of the boolean parameter is "true" and false is explicitly passed in when false is entered.

property name*any

The incoming structured input is named by the params of the selected Workflow entrypoint(Conversation, executor). multiple: true or The non-file parameters of control: "checkboxes" are serialized as JSON array strings. control: "textarea" affects only Desktop/server form rendering and is still processed as a normal string input. Date-related control also keep strings:date as YYYY-MM-DD, time HH:mm:ss, datetime are local YYYY-MM-DDTHH:mm:ss, date-range is a closed interval YYYY-MM-DD/YYYY-MM-DD, no time zone conversion is performed. The default value of the boolean parameter is "true" and false is explicitly passed in when false is entered.

Default value: {}

argsstring[]

files[]

userstringrequired

Example: external-user

conversation_idstring

conversationIdstring

response_modestring

Possible values: [blocking, streaming]

Default value: blocking

targetstring

The latest, draft, or semantic version number.

Example: latest

versionstring

Specifies the alias of the semanized version number; will be the run target if target is not provided.

ExternalRunRequest

{
  "workflow": "smoke",
  "workflow_id": "string",
  "workflowName": "string",
  "workflowId": "string",
  "entrypoint_id": "string",
  "inputs": {},
  "args": [
    "string"
  ],
  "files": [
    null
  ],
  "user": "external-user",
  "conversation_id": "string",
  "conversationId": "string",
  "response_mode": "blocking",
  "target": "latest",
  "version": "string"
}