WorkflowRunExternalMetadata

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: [external, embed, webhook, desktop, schedule, mcp]

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

files[]

responseModestring

Possible values: [blocking, streaming]

openai object

request objectrequired

modelstringrequired

Possible values: non-empty

input objectrequired

oneOf

string

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: [low, medium, high]

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_

conversation object

oneOf

string

string

Possible values: Value must match regular expression ^conv_

metadata object

property name*string

Possible values: <= 512 characters

response objectrequired

idstringrequired

Possible values: Value must match regular expression ^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: [queued, in_progress, completed, failed, cancelled, incomplete]

backgroundbooleanrequired

error objectrequired

oneOf

null

null

incomplete_details objectrequired

oneOf

null

null

instructionsstring | nullnullablerequired

max_output_tokensinteger | nullnullablerequired

max_tool_callsnullrequired

modelstringrequired

output object[]required

Array [

idstring

Possible values: Value must match regular expression ^msg_

typestringrequired

Constant value: message

rolestringrequired

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

content objectrequired

oneOf

string

string

Possible values: non-empty

statusstring

Possible values: [in_progress, completed, incomplete]

]

parallel_tool_callsbooleanrequired

Constant value: false

previous_response_idstring | nullnullablerequired

conversation objectrequired

oneOf

null

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: [low, medium, high]

truncationstringrequired

Constant value: disabled

usernullrequired

usage objectrequired

oneOf

null

null

webhook object

workflowNamestringrequired

requestIdstringrequired

targetstringrequired

resolvedTargetstring

headers object

property name*string

WorkflowRunExternalMetadata

{
  "source": "external",
  "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": "low"
      },
      "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": "queued",
      "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": "user",
          "content": "string",
          "status": "in_progress"
        }
      ],
      "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": "low"
      },
      "truncation": "disabled",
      "user": "null",
      "usage": "null"
    }
  },
  "webhook": {
    "workflowName": "string",
    "requestId": "string",
    "target": "string",
    "resolvedTarget": "string",
    "headers": {}
  }
}