Skip to main content

WorkflowRunRecord

runIdstringrequired
workflowNamestringrequired
conversationIdstring
targetstringrequired
resolvedTargetstringrequired
entrypointIdstring

Workflow actual running entry ID;Conversation and old records can be omitted.

entrypointTitlestring

The entry title of the run-time creation snapshot.

sourcestring

Only timed runs exist.

Possible values: [schedule]

scheduleIdstring<uuid>
scheduleNamestring
fireIdstring<uuid>
scheduledForstring<date-time>
triggerKindstring

Possible values: [window-interval, cron]

argsstring[]required
external object

Records the client or external ingress source of the run. Desktop, External Run API, Embed, and Webhook write source, allowing execution logs, KV associations, and replay to distinguish origins. OpenAI Responses calls also retain the complete normalized request and terminal Response. Full authentication Keys are excluded; apiKeyId and apiKeyName identify only the Key ID and prefix.

sourcestring

Possible values: [desktop, embed, external, mcp, schedule, webhook]

principalKindstring
actorTypestring
actorUserIdstring
actorProfileIdstring
actorDisplayNamestring
actorProfile object
userIdstringrequired
displayNamestringrequired
emailstring

Optional email address for the profile summary.

avatarUrlstring

Optional avatar image URL or data URL for the uploader profile.

apiKeyIdstring
apiKeyNamestring
protocolstring
Constant value: openai.responses
userstring
conversationIdstring
inputs object
property name*any
filesarray
responseModestring

Possible values: [blocking, streaming]

openai object
request objectrequired
modelstringrequired

Possible values: non-empty

input objectrequired
oneOf
string

Possible values: non-empty

instructionsstring

Possible values: non-empty

temperaturenumber

Possible values: >= 0 and <= 2

top_pnumber

Possible values: >= 0 and <= 1

max_output_tokensinteger

Possible values: >= 1

text object
format object
typestringrequired
Constant value: text
verbositystring

Possible values: [high, low, medium]

includestring[]

Possible values: [reasoning.encrypted_content]

storeboolean
Default value: true
streamboolean
Default value: false
backgroundboolean
Default value: false
previous_response_idstring

Continue a retained Response whose status is completed or incomplete.

Possible values: Value must match regular expression (?=^resp_)(?=^resp_)

conversation object
oneOf
string

Possible values: Value must match regular expression (?=^conv_)(?=^conv_)

metadata object
property name*string

Possible values: <= 512 characters

response objectrequired
idstringrequired

Possible values: Value must match regular expression (?=^resp_)(?=^resp_)

objectstringrequired
Constant value: response
created_atintegerrequired
completed_atinteger | nullnullablerequired

Unix timestamp in seconds only when status is completed; null for every other status.

statusstringrequired

Possible values: [cancelled, completed, failed, in_progress, incomplete, queued]

backgroundbooleanrequired
error objectrequired
oneOf
null
incomplete_details objectrequired
oneOf
null
instructionsstring | nullnullablerequired
max_output_tokensinteger | nullnullablerequired
max_tool_callsnullrequired
modelstringrequired
output object[]required
  • Array [
    • idstring

    Possible values: Value must match regular expression (?=^msg_)(?=^msg_)

    typestringrequired
    Constant value: message
    rolestringrequired

    Possible values: [assistant, developer, system, user]

    content objectrequired
    oneOf
    string

    Possible values: non-empty

    statusstring

    Possible values: [completed, in_progress, incomplete]

  • ]
    • parallel_tool_callsbooleanrequired
    Constant value: false
    previous_response_idstring | nullnullablerequired
    conversation objectrequired
    oneOf
    null
    metadata objectrequired
    property name*string

    Possible values: <= 512 characters

    storebooleanrequired
    temperaturenumber | nullnullablerequired
    top_pnumber | nullnullablerequired
    toolsarrayrequired
    tool_choicestringrequired
    Constant value: auto
    reasoning objectrequired
    property name*any
    text objectrequired
    format objectrequired
    typestringrequired
    Constant value: text
    verbositystring

    Possible values: [high, low, medium]

    truncationstringrequired
    Constant value: disabled
    usernullrequired
    usage objectrequired
    oneOf
    null
    webhook object
    workflowNamestringrequired
    requestIdstringrequired
    targetstringrequired
    resolvedTargetstring
    headers object
    property name*string
    debugNodestring
    statusWorkflowRunStatusrequired

    Possible values: [waiting, running, waiting_for_input, success, failed, aborted, timed_out]

    createdAtstring<date-time>required
    durationMsnumberrequired
    exitCodeintegerrequired
    stdoutstringrequired
    stderrstringrequired
    pendingUserInput object
    requestIdstringrequired
    nodeNamestringrequired
    titlestringrequired
    descriptionstring
    paramsobject[]required

    The same array of WorkflowParamDefinition as the params of the selected Workflow entrypoint(executor for Conversation).

    defaultValues object
    property name*any
    metadata object
    property name*any
    createdAtstring<date-time>required
    resolvedUserInputs object[]
  • Array [
    • requestIdstringrequired
    nodeNamestringrequired
    values objectrequired
    property name*any
    submittedAtstring<date-time>required
  • ]
    • report objectrequired

    Execute the report; business timing records are located at report.timers, and each item conforms to WorkflowTimerRecord.

    property name*any

    Execute the report; business timing records are located at report.timers, and each item conforms to WorkflowTimerRecord.

    WorkflowRunRecord
    {
      "runId": "string",
      "workflowName": "string",
      "conversationId": "string",
      "target": "string",
      "resolvedTarget": "string",
      "entrypointId": "string",
      "entrypointTitle": "string",
      "source": "schedule",
      "scheduleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "scheduleName": "string",
      "fireId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "scheduledFor": "2024-07-29T15:51:28.071Z",
      "triggerKind": "window-interval",
      "args": [
        "string"
      ],
      "external": {
        "source": "desktop",
        "principalKind": "string",
        "actorType": "string",
        "actorUserId": "string",
        "actorProfileId": "string",
        "actorDisplayName": "string",
        "actorProfile": {
          "userId": "string",
          "displayName": "string",
          "email": "string",
          "avatarUrl": "string"
        },
        "apiKeyId": "string",
        "apiKeyName": "string",
        "protocol": "openai.responses",
        "user": "string",
        "conversationId": "string",
        "inputs": {},
        "files": [
          null
        ],
        "responseMode": "blocking",
        "openai": {
          "request": {
            "model": "string",
            "input": "string",
            "instructions": "string",
            "temperature": 0,
            "top_p": 0,
            "max_output_tokens": 0,
            "text": {
              "format": {
                "type": "text"
              },
              "verbosity": "high"
            },
            "include": [
              "reasoning.encrypted_content"
            ],
            "store": true,
            "stream": false,
            "background": false,
            "previous_response_id": "string",
            "conversation": "string",
            "metadata": {}
          },
          "response": {
            "id": "string",
            "object": "response",
            "created_at": 0,
            "completed_at": 0,
            "status": "cancelled",
            "background": true,
            "error": "null",
            "incomplete_details": "null",
            "instructions": "string",
            "max_output_tokens": 0,
            "max_tool_calls": "null",
            "model": "string",
            "output": [
              {
                "id": "string",
                "type": "message",
                "role": "assistant",
                "content": "string",
                "status": "completed"
              }
            ],
            "parallel_tool_calls": true,
            "previous_response_id": "string",
            "conversation": "null",
            "metadata": {},
            "store": true,
            "temperature": 0,
            "top_p": 0,
            "tools": [
              null
            ],
            "tool_choice": "auto",
            "reasoning": {},
            "text": {
              "format": {
                "type": "text"
              },
              "verbosity": "high"
            },
            "truncation": "disabled",
            "user": "null",
            "usage": "null"
          }
        },
        "webhook": {
          "workflowName": "string",
          "requestId": "string",
          "target": "string",
          "resolvedTarget": "string",
          "headers": {}
        }
      },
      "debugNode": "string",
      "status": "waiting",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "durationMs": 0,
      "exitCode": 0,
      "stdout": "string",
      "stderr": "string",
      "pendingUserInput": {
        "requestId": "string",
        "nodeName": "string",
        "title": "string",
        "description": "string",
        "params": [
          {}
        ],
        "defaultValues": {},
        "metadata": {},
        "createdAt": "2024-07-29T15:51:28.071Z"
      },
      "resolvedUserInputs": [
        {
          "requestId": "string",
          "nodeName": "string",
          "values": {},
          "submittedAt": "2024-07-29T15:51:28.071Z"
        }
      ],
      "report": {}
    }