Agent

AI Task

client.Agent.Automate(ctx, body) (*AutomateEventUnion, error)

POST/automate

Submit Input Response

client.Agent.AutomateInput(ctx, requestID, body) (*AgentAutomateInputResponse, error)

POST/automate/{requestID}/input

Research

client.Agent.Research(ctx, body) (*ResearchEventUnion, error)

POST/research

ModelsExpand Collapse

type AutomateEventUnion interface{…}

A Server-Sent Event from /v1/automate. Typed discriminated union keyed on event.

One of the following:

type AutomateEventAgentAction struct{…}

Envelope for the “agent:action” event from /v1/automate.

Data AutomateEventAgentActionData

Event data for action execution

Action string

IterationID string

Timestamp float64

Ref stringOptional

Value stringOptional

Event AgentAction

type AutomateEventAgentExtracted struct{…}

Envelope for the “agent:extracted” event from /v1/automate.

Data AutomateEventAgentExtractedData

Event data for extracted data

ExtractedData string

IterationID string

Timestamp float64

Event AgentExtracted

type AutomateEventAgentProcessing struct{…}

Envelope for the “agent:processing” event from /v1/automate.

Data AutomateEventAgentProcessingData

Event data for when the agent is waiting for model generation

HasScreenshot bool

IterationID string

Operation string

Timestamp float64

Event AgentProcessing

type AutomateEventAgentReasoned struct{…}

Envelope for the “agent:reasoned” event from /v1/automate.

Data AutomateEventAgentReasonedData

Event data for agent reasoning

IterationID string

Reasoning string

Timestamp float64

Event AgentReasoned

type AutomateEventAgentStatus struct{…}

Envelope for the “agent:status” event from /v1/automate.

Data AutomateEventAgentStatusData

Event data for status messages

IterationID string

Message string

Timestamp float64

Event AgentStatus

type AutomateEventAgentStep struct{…}

Envelope for the “agent:step” event from /v1/automate.

Data AutomateEventAgentStepData

Event data for agent step tracking (each loop iteration)

CurrentIteration float64

IterationID string

Timestamp float64

Event AgentStep

type AutomateEventAgentWaiting struct{…}

Envelope for the “agent:waiting” event from /v1/automate.

Data AutomateEventAgentWaitingData

Event data for waiting notifications

IterationID string

Seconds float64

Timestamp float64

Event AgentWaiting

type AutomateEventAIGeneration struct{…}

Envelope for the “ai:generation” event from /v1/automate.

Data AutomateEventAIGenerationData

Event data when AI generation occurs

FinishReason string

One of the following:

const AutomateEventAIGenerationDataFinishReasonStop AutomateEventAIGenerationDataFinishReason = "stop"

const AutomateEventAIGenerationDataFinishReasonLength AutomateEventAIGenerationDataFinishReason = "length"

const AutomateEventAIGenerationDataFinishReasonContentFilter AutomateEventAIGenerationDataFinishReason = "content-filter"

const AutomateEventAIGenerationDataFinishReasonToolCalls AutomateEventAIGenerationDataFinishReason = "tool-calls"

const AutomateEventAIGenerationDataFinishReasonError AutomateEventAIGenerationDataFinishReason = "error"

const AutomateEventAIGenerationDataFinishReasonOther AutomateEventAIGenerationDataFinishReason = "other"

IterationID string

Prompt string

Schema any

Timestamp float64

Usage AutomateEventAIGenerationDataUsage

InputTokens float64Optional

OutputTokens float64Optional

TotalTokens float64Optional

Messages []AutomateEventAIGenerationDataMessageUnionOptional

One of the following:

type AutomateEventAIGenerationDataMessageSystem struct{…}

A system message. It can contain system information.

Note: using the “system” part of the prompt is strongly preferred to increase the resilience against prompt injection attacks, and because not all providers support several system messages.

Content string

Role System

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageSystemProviderOptionUnion]]Optional

Additional provider-specific metadata. They are passed through to the provider from the AI SDK and enable provider-specific functionality that can be fully encapsulated in the provider.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageSystemProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageSystemProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageSystemProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageSystemProviderOptionArray []AutomateEventAIGenerationDataMessageSystemProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageSystemProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageUser struct{…}

A user message. It can contain text or a combination of text and images.

Content AutomateEventAIGenerationDataMessageUserContentUnion

Content of a user message. It can be a string or an array of text and image parts.

One of the following:

string

type AutomateEventAIGenerationDataMessageUserContentArray []AutomateEventAIGenerationDataMessageUserContentArrayItemUnion

One of the following:

type AutomateEventAIGenerationDataMessageUserContentArrayItemText struct{…}

Text content part of a prompt. It contains a string of text.

Text string

The text content.

Type Text

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageUserContentArrayItemTextProviderOptionUnion]]Optional

Additional provider-specific metadata. They are passed through to the provider from the AI SDK and enable provider-specific functionality that can be fully encapsulated in the provider.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageUserContentArrayItemTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageUserContentArrayItemTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageUserContentArrayItemTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageUserContentArrayItemTextProviderOptionArray []AutomateEventAIGenerationDataMessageUserContentArrayItemTextProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageUserContentArrayItemTextProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageUserContentArrayItemImage struct{…}

Image content part of a prompt. It contains an image.

Image AutomateEventAIGenerationDataMessageUserContentArrayItemImageImageUnion

Image data. Can either be:

data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
URL: a URL that points to the image

One of the following:

string

type AutomateEventAIGenerationDataMessageUserContentArrayItemImageImageObject struct{…}

Buffer AutomateEventAIGenerationDataMessageUserContentArrayItemImageImageObjectBuffer

ByteLength float64

ByteOffset float64

BytesPerElement float64

Length float64

type AutomateEventAIGenerationDataMessageUserContentArrayItemImageImageByteLength struct{…}

ByteLength float64

type AutomateEventAIGenerationDataMessageUserContentArrayItemImageImageV1GlobalBuffer struct{…}

Buffer AutomateEventAIGenerationDataMessageUserContentArrayItemImageImageV1GlobalBufferBuffer

ByteLength float64

ByteOffset float64

BytesPerElement float64

Length float64

Type Image

MediaType stringOptional

Optional IANA media type of the image.

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageUserContentArrayItemImageProviderOptionUnion]]Optional

Additional provider-specific metadata. They are passed through to the provider from the AI SDK and enable provider-specific functionality that can be fully encapsulated in the provider.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageUserContentArrayItemImageProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageUserContentArrayItemImageProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageUserContentArrayItemImageProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageUserContentArrayItemImageProviderOptionArray []AutomateEventAIGenerationDataMessageUserContentArrayItemImageProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageUserContentArrayItemImageProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageUserContentArrayItemFile struct{…}

File content part of a prompt. It contains a file.

Data AutomateEventAIGenerationDataMessageUserContentArrayItemFileDataUnion

File data. Can either be:

data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
URL: a URL that points to the image

One of the following:

string

type AutomateEventAIGenerationDataMessageUserContentArrayItemFileDataObject struct{…}

Buffer AutomateEventAIGenerationDataMessageUserContentArrayItemFileDataObjectBuffer

ByteLength float64

ByteOffset float64

BytesPerElement float64

Length float64

type AutomateEventAIGenerationDataMessageUserContentArrayItemFileDataByteLength struct{…}

ByteLength float64

type AutomateEventAIGenerationDataMessageUserContentArrayItemFileDataV1GlobalBuffer struct{…}

Buffer AutomateEventAIGenerationDataMessageUserContentArrayItemFileDataV1GlobalBufferBuffer

ByteLength float64

ByteOffset float64

BytesPerElement float64

Length float64

MediaType string

IANA media type of the file.

Type File

Filename stringOptional

Optional filename of the file.

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageUserContentArrayItemFileProviderOptionUnion]]Optional

Additional provider-specific metadata. They are passed through to the provider from the AI SDK and enable provider-specific functionality that can be fully encapsulated in the provider.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageUserContentArrayItemFileProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageUserContentArrayItemFileProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageUserContentArrayItemFileProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageUserContentArrayItemFileProviderOptionArray []AutomateEventAIGenerationDataMessageUserContentArrayItemFileProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageUserContentArrayItemFileProviderOptionArrayItemArray []any

Role User

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageUserProviderOptionUnion]]Optional

Additional provider-specific metadata. They are passed through to the provider from the AI SDK and enable provider-specific functionality that can be fully encapsulated in the provider.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageUserProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageUserProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageUserProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageUserProviderOptionArray []AutomateEventAIGenerationDataMessageUserProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageUserProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageAssistant struct{…}

An assistant message. It can contain text, tool calls, or a combination of text and tool calls.

Content AutomateEventAIGenerationDataMessageAssistantContentUnion

Content of an assistant message. It can be a string or an array of text, image, reasoning, redacted reasoning, and tool call parts.

One of the following:

string

type AutomateEventAIGenerationDataMessageAssistantContentArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemUnion

One of the following:

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemText struct{…}

Text content part of a prompt. It contains a string of text.

Text string

The text content.

Type Text

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemTextProviderOptionUnion]]Optional

Additional provider-specific metadata. They are passed through to the provider from the AI SDK and enable provider-specific functionality that can be fully encapsulated in the provider.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemTextProviderOptionArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemTextProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemTextProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemFile struct{…}

File content part of a prompt. It contains a file.

Data AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileDataUnion

File data. Can either be:

data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
URL: a URL that points to the image

One of the following:

string

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileDataObject struct{…}

Buffer AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileDataObjectBuffer

ByteLength float64

ByteOffset float64

BytesPerElement float64

Length float64

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileDataByteLength struct{…}

ByteLength float64

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileDataV1GlobalBuffer struct{…}

Buffer AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileDataV1GlobalBufferBuffer

ByteLength float64

ByteOffset float64

BytesPerElement float64

Length float64

MediaType string

IANA media type of the file.

Type File

Filename stringOptional

Optional filename of the file.

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileProviderOptionUnion]]Optional

Additional provider-specific metadata. They are passed through to the provider from the AI SDK and enable provider-specific functionality that can be fully encapsulated in the provider.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileProviderOptionArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemReasoning struct{…}

Reasoning content part of a prompt. It contains a reasoning.

Text string

The reasoning text.

Type Reasoning

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemReasoningProviderOptionUnion]]Optional

Additional provider-specific metadata. They are passed through to the provider from the AI SDK and enable provider-specific functionality that can be fully encapsulated in the provider.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemReasoningProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemReasoningProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemReasoningProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemReasoningProviderOptionArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemReasoningProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemReasoningProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolCall struct{…}

Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).

Input any

Arguments of the tool call. This is a JSON-serializable object that matches the tool’s input schema.

ToolCallID string

ID of the tool call. This ID is used to match the tool call with the tool result.

ToolName string

Name of the tool that is being called.

Type ToolCall

ProviderExecuted boolOptional

Whether the tool call was executed by the provider.

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolCallProviderOptionUnion]]Optional

Additional provider-specific metadata. They are passed through to the provider from the AI SDK and enable provider-specific functionality that can be fully encapsulated in the provider.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolCallProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolCallProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolCallProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolCallProviderOptionArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolCallProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolCallProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResult struct{…}

Tool result content part of a prompt. It contains the result of the tool call with the matching ID.

Output AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputUnion

Result of the tool call. This is a JSON-serializable object.

One of the following:

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputText struct{…}

Type Text

Text tool output that should be directly sent to the API.

Value string

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputTextProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputTextProviderOptionArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputTextProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputTextProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJson struct{…}

Type Json

Value AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueUnion

A JSON value can be a string, number, boolean, object, array, or null. JSON values can be serialized and deserialized by the JSON.stringify and JSON.parse methods.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueMap map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueMapItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueMapItemArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueMapItemArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueMapItemArrayItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueArrayItemArray []any

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonProviderOptionArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputExecutionDenied struct{…}

Type ExecutionDenied

Type when the user has denied the execution of the tool call.

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputExecutionDeniedProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputExecutionDeniedProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputExecutionDeniedProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputExecutionDeniedProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputExecutionDeniedProviderOptionArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputExecutionDeniedProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputExecutionDeniedProviderOptionArrayItemArray []any

Reason stringOptional

Optional reason for the execution denial.

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorText struct{…}

Type ErrorText

Value string

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorTextProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorTextProviderOptionArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorTextProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorTextProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJson struct{…}

Type ErrorJson

Value AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueUnion

A JSON value can be a string, number, boolean, object, array, or null. JSON values can be serialized and deserialized by the JSON.stringify and JSON.parse methods.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueMap map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueMapItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueMapItemArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueMapItemArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueMapItemArrayItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueArrayItemArray []any

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonProviderOptionArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContent struct{…}

Type Content

Value []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueUnion

One of the following:

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueText struct{…}

Text string

Text content.

Type Text

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueTextProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueTextProviderOptionArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueTextProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueTextProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueMedia struct{…}

Data string

MediaType string

DeprecatedType Media

Deprecated by the upstream schema.

Deprecated. Use image-data or file-data instead.

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileData struct{…}

Data string

Base-64 encoded media data.

MediaType string

IANA media type.

Type FileData

Filename stringOptional

Optional filename of the file.

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileDataProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileDataProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileDataProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileDataProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileDataProviderOptionArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileDataProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileDataProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileURL struct{…}

Type FileURL

URL string

URL of the file.

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileURLProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileURLProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileURLProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileURLProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileURLProviderOptionArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileURLProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileURLProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileID struct{…}

FileID AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileIDFileIDUnion

ID of the file.

If you use multiple providers, you need to specify the provider specific ids using the Record option. The key is the provider name, e.g. ‘openai’ or ‘anthropic’.

One of the following:

string

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileIDFileIDMap map[string, string]

Type FileID

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileIDProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileIDProviderOptionArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileIDProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileIDProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageData struct{…}

Data string

Base-64 encoded image data.

MediaType string

IANA media type.

Type ImageData

Images that are referenced using base64 encoded data.

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageDataProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageDataProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageDataProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageDataProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageDataProviderOptionArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageDataProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageDataProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageURL struct{…}

Type ImageURL

Images that are referenced using a URL.

URL string

URL of the image.

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageURLProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageURLProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageURLProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageURLProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageURLProviderOptionArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageURLProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageURLProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileID struct{…}

FileID AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileIDFileIDUnion

Image that is referenced using a provider file id.

If you use multiple providers, you need to specify the provider specific ids using the Record option. The key is the provider name, e.g. ‘openai’ or ‘anthropic’.

One of the following:

string

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileIDFileIDMap map[string, string]

Type ImageFileID

Images that are referenced using a provider file id.

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileIDProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileIDProviderOptionArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileIDProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileIDProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueCustom struct{…}

Type Custom

Custom content part. This can be used to implement provider-specific content parts.

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueCustomProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueCustomProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueCustomProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueCustomProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueCustomProviderOptionArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueCustomProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueCustomProviderOptionArrayItemArray []any

ToolCallID string

ID of the tool call that this result is associated with.

ToolName string

Name of the tool that generated this result.

Type ToolResult

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultProviderOptionUnion]]Optional

Additional provider-specific metadata. They are passed through to the provider from the AI SDK and enable provider-specific functionality that can be fully encapsulated in the provider.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultProviderOptionArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolApprovalRequest struct{…}

Tool approval request prompt part.

ApprovalID string

ID of the tool approval.

ToolCallID string

ID of the tool call that the approval request is for.

Type ToolApprovalRequest

Role Assistant

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantProviderOptionUnion]]Optional

Additional provider-specific metadata. They are passed through to the provider from the AI SDK and enable provider-specific functionality that can be fully encapsulated in the provider.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageAssistantProviderOptionArray []AutomateEventAIGenerationDataMessageAssistantProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageAssistantProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageTool struct{…}

A tool message. It contains the result of one or more tool calls.

Content []AutomateEventAIGenerationDataMessageToolContentUnion

Content of a tool message. It is an array of tool result parts.

One of the following:

type AutomateEventAIGenerationDataMessageToolContentToolResult struct{…}

Tool result content part of a prompt. It contains the result of the tool call with the matching ID.

Output AutomateEventAIGenerationDataMessageToolContentToolResultOutputUnion

Result of the tool call. This is a JSON-serializable object.

One of the following:

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputText struct{…}

Type Text

Text tool output that should be directly sent to the API.

Value string

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputTextProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputTextProviderOptionArray []AutomateEventAIGenerationDataMessageToolContentToolResultOutputTextProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputTextProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJson struct{…}

Type Json

Value AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueUnion

A JSON value can be a string, number, boolean, object, array, or null. JSON values can be serialized and deserialized by the JSON.stringify and JSON.parse methods.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueMap map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueMapItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueMapItemArray []AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueMapItemArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueMapItemArrayItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueArray []AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueArrayItemArray []any

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonProviderOptionArray []AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputExecutionDenied struct{…}

Type ExecutionDenied

Type when the user has denied the execution of the tool call.

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputExecutionDeniedProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputExecutionDeniedProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputExecutionDeniedProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputExecutionDeniedProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputExecutionDeniedProviderOptionArray []AutomateEventAIGenerationDataMessageToolContentToolResultOutputExecutionDeniedProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputExecutionDeniedProviderOptionArrayItemArray []any

Reason stringOptional

Optional reason for the execution denial.

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorText struct{…}

Type ErrorText

Value string

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorTextProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorTextProviderOptionArray []AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorTextProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorTextProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJson struct{…}

Type ErrorJson

Value AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueUnion

A JSON value can be a string, number, boolean, object, array, or null. JSON values can be serialized and deserialized by the JSON.stringify and JSON.parse methods.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueMap map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueMapItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueMapItemArray []AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueMapItemArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueMapItemArrayItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueArray []AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueArrayItemArray []any

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonProviderOptionArray []AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContent struct{…}

Type Content

Value []AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueUnion

One of the following:

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueText struct{…}

Text string

Text content.

Type Text

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueTextProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueTextProviderOptionArray []AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueTextProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueTextProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueMedia struct{…}

Data string

MediaType string

DeprecatedType Media

Deprecated by the upstream schema.

Deprecated. Use image-data or file-data instead.

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileData struct{…}

Data string

Base-64 encoded media data.

MediaType string

IANA media type.

Type FileData

Filename stringOptional

Optional filename of the file.

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileDataProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileDataProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileDataProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileDataProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileDataProviderOptionArray []AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileDataProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileDataProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileURL struct{…}

Type FileURL

URL string

URL of the file.

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileURLProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileURLProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileURLProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileURLProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileURLProviderOptionArray []AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileURLProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileURLProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileID struct{…}

FileID AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileIDFileIDUnion

ID of the file.

If you use multiple providers, you need to specify the provider specific ids using the Record option. The key is the provider name, e.g. ‘openai’ or ‘anthropic’.

One of the following:

string

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileIDFileIDMap map[string, string]

Type FileID

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileIDProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileIDProviderOptionArray []AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileIDProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileIDProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageData struct{…}

Data string

Base-64 encoded image data.

MediaType string

IANA media type.

Type ImageData

Images that are referenced using base64 encoded data.

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageDataProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageDataProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageDataProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageDataProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageDataProviderOptionArray []AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageDataProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageDataProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageURL struct{…}

Type ImageURL

Images that are referenced using a URL.

URL string

URL of the image.

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageURLProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageURLProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageURLProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageURLProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageURLProviderOptionArray []AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageURLProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageURLProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileID struct{…}

FileID AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileIDFileIDUnion

Image that is referenced using a provider file id.

If you use multiple providers, you need to specify the provider specific ids using the Record option. The key is the provider name, e.g. ‘openai’ or ‘anthropic’.

One of the following:

string

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileIDFileIDMap map[string, string]

Type ImageFileID

Images that are referenced using a provider file id.

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileIDProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileIDProviderOptionArray []AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileIDProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileIDProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueCustom struct{…}

Type Custom

Custom content part. This can be used to implement provider-specific content parts.

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueCustomProviderOptionUnion]]Optional

Provider-specific options.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueCustomProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueCustomProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueCustomProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueCustomProviderOptionArray []AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueCustomProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueCustomProviderOptionArrayItemArray []any

ToolCallID string

ID of the tool call that this result is associated with.

ToolName string

Name of the tool that generated this result.

Type ToolResult

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultProviderOptionUnion]]Optional

Additional provider-specific metadata. They are passed through to the provider from the AI SDK and enable provider-specific functionality that can be fully encapsulated in the provider.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolResultProviderOptionArray []AutomateEventAIGenerationDataMessageToolContentToolResultProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolContentToolResultProviderOptionArrayItemArray []any

type AutomateEventAIGenerationDataMessageToolContentToolApprovalResponse struct{…}

Tool approval response prompt part.

ApprovalID string

ID of the tool approval.

Approved bool

Flag indicating whether the approval was granted or denied.

Type ToolApprovalResponse

ProviderExecuted boolOptional

Flag indicating whether the tool call is provider-executed. Only provider-executed tool approval responses should be sent to the model.

Reason stringOptional

Optional reason for the approval or denial.

Role Tool

ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolProviderOptionUnion]]Optional

Additional provider-specific metadata. They are passed through to the provider from the AI SDK and enable provider-specific functionality that can be fully encapsulated in the provider.

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemArray []any

type AutomateEventAIGenerationDataMessageToolProviderOptionArray []AutomateEventAIGenerationDataMessageToolProviderOptionArrayItemUnion

One of the following:

string

float64

bool

type AutomateEventAIGenerationDataMessageToolProviderOptionArrayItemArray []any

Object anyOptional

ProviderMetadata map[string, any]Optional

Temperature float64Optional

Warnings []anyOptional

Event AIGeneration

type AutomateEventAIGenerationError struct{…}

Envelope for the “ai:generation:error” event from /v1/automate.

Data AutomateEventAIGenerationErrorData

Event data when AI generation error occurs

Error string

IterationID string

Prompt string

Schema any

Timestamp float64

Messages []anyOptional

Event AIGenerationError

type AutomateEventBrowserActionCompleted struct{…}

Envelope for the “browser:action_completed” event from /v1/automate.

Data AutomateEventBrowserActionCompletedData

Event data for action results

IterationID string

Success bool

Timestamp float64

Error stringOptional

Event BrowserActionCompleted

type AutomateEventBrowserActionStarted struct{…}

Envelope for the “browser:action_started” event from /v1/automate.

Data AutomateEventBrowserActionStartedData

Event data for action execution

Action string

IterationID string

Timestamp float64

Ref stringOptional

Value stringOptional

Event BrowserActionStarted

type AutomateEventBrowserNavigated struct{…}

Envelope for the “browser:navigated” event from /v1/automate.

Data AutomateEventBrowserNavigatedData

Event data when navigating to a page

IterationID string

Timestamp float64

Title string

URL string

Event BrowserNavigated

type AutomateEventBrowserReconnected struct{…}

Envelope for the “browser:reconnected” event from /v1/automate.

Data AutomateEventBrowserReconnectedData

Event data when the browser reconnects after a mid-task disconnect

EndpointIndex float64

1-based index of the CDP endpoint now in use

IterationID string

StartingURL string

The original starting URL the agent is restarting execution from

Timestamp float64

Total float64

Total number of configured CDP endpoints

Event BrowserReconnected

type AutomateEventBrowserScreenshotCaptured struct{…}

Envelope for the “browser:screenshot_captured” event from /v1/automate.

Data AutomateEventBrowserScreenshotCapturedData

Event data for screenshot capture

Format string

One of the following:

const AutomateEventBrowserScreenshotCapturedDataFormatJpeg AutomateEventBrowserScreenshotCapturedDataFormat = "jpeg"

const AutomateEventBrowserScreenshotCapturedDataFormatPng AutomateEventBrowserScreenshotCapturedDataFormat = "png"

IterationID string

Size float64

Timestamp float64

Event BrowserScreenshotCaptured

type AutomateEventBrowserScreenshotCapturedImage struct{…}

Envelope for the “browser:screenshot_captured_image” event from /v1/automate.

Data AutomateEventBrowserScreenshotCapturedImageData

Event data for screenshot image capture with full image data This event contains the complete screenshot and can be very large

Image string

IterationID string

MediaType string

One of the following:

const AutomateEventBrowserScreenshotCapturedImageDataMediaTypeImageJpeg AutomateEventBrowserScreenshotCapturedImageDataMediaType = "image/jpeg"

const AutomateEventBrowserScreenshotCapturedImageDataMediaTypeImagePng AutomateEventBrowserScreenshotCapturedImageDataMediaType = "image/png"

Timestamp float64

Event BrowserScreenshotCapturedImage

type AutomateEventCdpEndpointConnected struct{…}

Envelope for the “cdp:endpoint_connected” event from /v1/automate.

Data AutomateEventCdpEndpointConnectedData

Event data when a CDP endpoint is successfully connected to

EndpointIndex float64

1-based index of the endpoint that connected

IterationID string

Timestamp float64

Total float64

Total number of configured CDP endpoints

Event CdpEndpointConnected

type AutomateEventCdpEndpointCycle struct{…}

Envelope for the “cdp:endpoint_cycle” event from /v1/automate.

Data AutomateEventCdpEndpointCycleData

Event data when a CDP endpoint fails and the next one is being tried

Attempt float64

1-based index of the endpoint attempt that failed

Error string

Sanitized error identifier from the failed connection attempt (error.name, not error.message — full messages may contain endpoint URLs)

IterationID string

Timestamp float64

Total float64

Total number of configured CDP endpoints

Event CdpEndpointCycle

type AutomateEventComplete struct{…}

Envelope for the “complete” event from /v1/automate.

Data AutomateEventCompleteData

Payload for the complete stream event. Structurally identical to TaskExecutionResult from webAgent.ts — the complete event’s data is the agent’s final TaskExecutionResult, stringified onto the SSE stream.

FinalAnswer string

Final answer or result from the agent

Stats AutomateEventCompleteDataStats

Execution statistics

Actions float64

DurationMs float64

EndTime float64

Iterations float64

StartTime float64

Success bool

Whether the task completed successfully

Error AutomateEventCompleteDataErrorOptional

Structured error information for failed tasks

Code string

Error codes for task failures

One of the following:

const AutomateEventCompleteDataErrorCodeTaskAborted AutomateEventCompleteDataErrorCode = "TASK_ABORTED"

const AutomateEventCompleteDataErrorCodeMaxIterations AutomateEventCompleteDataErrorCode = "MAX_ITERATIONS"

const AutomateEventCompleteDataErrorCodeMaxErrors AutomateEventCompleteDataErrorCode = "MAX_ERRORS"

const AutomateEventCompleteDataErrorCodeTaskFailed AutomateEventCompleteDataErrorCode = "TASK_FAILED"

Message string

Human-readable error message

Event Complete

type AutomateEventDone struct{…}

Envelope for the “done” event from /v1/automate.

Data map[string, any]

Payload for the done stream terminator event. Empty today; reserved for future metadata.

Event Done

type AutomateEventError struct{…}

Envelope for the “error” event from /v1/automate.

Data AutomateEventErrorData

Payload for the top-level error stream event. Emitted when an uncaught error escapes the task runner. Mirrors ErrorResponse from the server package’s taskRunner.ts — kept structurally aligned so schema and runtime stay consistent. Distinct from agent-level error events like ai:generation:error and task:validation_error, which are emitted through the normal event emitter during the agent loop.

Error AutomateEventErrorDataError

Code string

Message string

Timestamp string

ISO-8601 timestamp

Success bool

Event Error

type AutomateEventInteractiveFormDataError struct{…}

Envelope for the “interactive:form_data:error” event from /v1/automate.

Data AutomateEventInteractiveFormDataErrorData

Event data when form validation fails and the agent re-requests data. Carries both the error context and the fields that need new values. Callers respond to this the same way as a request event.

FieldErrors map[string, string]

Per-field error messages from validation (field ref -> error text)

Fields []AutomateEventInteractiveFormDataErrorDataField

FieldType string

Semantic field type

One of the following:

const AutomateEventInteractiveFormDataErrorDataFieldFieldTypeText AutomateEventInteractiveFormDataErrorDataFieldFieldType = "text"

const AutomateEventInteractiveFormDataErrorDataFieldFieldTypeEmail AutomateEventInteractiveFormDataErrorDataFieldFieldType = "email"

const AutomateEventInteractiveFormDataErrorDataFieldFieldTypePhone AutomateEventInteractiveFormDataErrorDataFieldFieldType = "phone"

const AutomateEventInteractiveFormDataErrorDataFieldFieldTypeDate AutomateEventInteractiveFormDataErrorDataFieldFieldType = "date"

const AutomateEventInteractiveFormDataErrorDataFieldFieldTypeNumber AutomateEventInteractiveFormDataErrorDataFieldFieldType = "number"

const AutomateEventInteractiveFormDataErrorDataFieldFieldTypeSelect AutomateEventInteractiveFormDataErrorDataFieldFieldType = "select"

const AutomateEventInteractiveFormDataErrorDataFieldFieldTypeCheckbox AutomateEventInteractiveFormDataErrorDataFieldFieldType = "checkbox"

const AutomateEventInteractiveFormDataErrorDataFieldFieldTypeRadio AutomateEventInteractiveFormDataErrorDataFieldFieldType = "radio"

const AutomateEventInteractiveFormDataErrorDataFieldFieldTypeTextarea AutomateEventInteractiveFormDataErrorDataFieldFieldType = "textarea"

const AutomateEventInteractiveFormDataErrorDataFieldFieldTypePassword AutomateEventInteractiveFormDataErrorDataFieldFieldType = "password"

const AutomateEventInteractiveFormDataErrorDataFieldFieldTypeOther AutomateEventInteractiveFormDataErrorDataFieldFieldType = "other"

Label string

The field’s visible label

Ref string

Element ref from the accessibility tree (e.g., “E42”)

Required bool

Whether this field must be filled

CurrentValue stringOptional

Current value if already partially filled

Description stringOptional

Additional context (e.g., validation error message on re-request)

Options []stringOptional

Available options for select/radio fields

FormDescription string

IterationID string

PageTitle string

PageURL string

RequestID string

Timestamp float64

Event InteractiveFormDataError

type AutomateEventInteractiveFormDataRequest struct{…}

Envelope for the “interactive:form_data:request” event from /v1/automate.

Data AutomateEventInteractiveFormDataRequestData

Event data when the agent requests user data for form fields

Fields []AutomateEventInteractiveFormDataRequestDataField

FieldType string

Semantic field type

One of the following:

const AutomateEventInteractiveFormDataRequestDataFieldFieldTypeText AutomateEventInteractiveFormDataRequestDataFieldFieldType = "text"

const AutomateEventInteractiveFormDataRequestDataFieldFieldTypeEmail AutomateEventInteractiveFormDataRequestDataFieldFieldType = "email"

const AutomateEventInteractiveFormDataRequestDataFieldFieldTypePhone AutomateEventInteractiveFormDataRequestDataFieldFieldType = "phone"

const AutomateEventInteractiveFormDataRequestDataFieldFieldTypeDate AutomateEventInteractiveFormDataRequestDataFieldFieldType = "date"

const AutomateEventInteractiveFormDataRequestDataFieldFieldTypeNumber AutomateEventInteractiveFormDataRequestDataFieldFieldType = "number"

const AutomateEventInteractiveFormDataRequestDataFieldFieldTypeSelect AutomateEventInteractiveFormDataRequestDataFieldFieldType = "select"

const AutomateEventInteractiveFormDataRequestDataFieldFieldTypeCheckbox AutomateEventInteractiveFormDataRequestDataFieldFieldType = "checkbox"

const AutomateEventInteractiveFormDataRequestDataFieldFieldTypeRadio AutomateEventInteractiveFormDataRequestDataFieldFieldType = "radio"

const AutomateEventInteractiveFormDataRequestDataFieldFieldTypeTextarea AutomateEventInteractiveFormDataRequestDataFieldFieldType = "textarea"

const AutomateEventInteractiveFormDataRequestDataFieldFieldTypePassword AutomateEventInteractiveFormDataRequestDataFieldFieldType = "password"

const AutomateEventInteractiveFormDataRequestDataFieldFieldTypeOther AutomateEventInteractiveFormDataRequestDataFieldFieldType = "other"

Label string

The field’s visible label

Ref string

Element ref from the accessibility tree (e.g., “E42”)

Required bool

Whether this field must be filled

CurrentValue stringOptional

Current value if already partially filled

Description stringOptional

Additional context (e.g., validation error message on re-request)

Options []stringOptional

Available options for select/radio fields

FormDescription string

IterationID string

PageTitle string

PageURL string

RequestID string

Timestamp float64

Event InteractiveFormDataRequest

type AutomateEventSystemDebugCompression struct{…}

Envelope for the “system:debug_compression” event from /v1/automate.

Data AutomateEventSystemDebugCompressionData

Event data for compression debug info

CompressedSize float64

CompressionPercent float64

IterationID string

OriginalSize float64

Timestamp float64

Event SystemDebugCompression

type AutomateEventSystemDebugMessage struct{…}

Envelope for the “system:debug_message” event from /v1/automate.

Data AutomateEventSystemDebugMessageData

Event data for message debug info

IterationID string

Messages []any

Timestamp float64

Event SystemDebugMessage

type AutomateEventTaskAborted struct{…}

Envelope for the “task:aborted” event from /v1/automate.

Data AutomateEventTaskAbortedData

Event data when a task is aborted

FinalAnswer string

IterationID string

Reason string

Timestamp float64

Event TaskAborted

type AutomateEventTaskCompleted struct{…}

Envelope for the “task:completed” event from /v1/automate.

Data AutomateEventTaskCompletedData

Event data when a task is completed

FinalAnswer string

IterationID string

Timestamp float64

Success boolOptional

Event TaskCompleted

type AutomateEventTaskMetrics struct{…}

Envelope for the “task:metrics” event from /v1/automate.

Data AutomateEventTaskMetricsData

AIGenerationCount float64

AIGenerationErrorCount float64

EventCounts map[string, float64]

IterationID string

StepCount float64

Timestamp float64

TotalInputTokens float64

TotalOutputTokens float64

Event TaskMetrics

type AutomateEventTaskMetricsIncremental struct{…}

Envelope for the “task:metrics_incremental” event from /v1/automate.

Data AutomateEventTaskMetricsIncrementalData

AIGenerationCount float64

AIGenerationErrorCount float64

EventCounts map[string, float64]

IterationID string

StepCount float64

Timestamp float64

TotalInputTokens float64

TotalOutputTokens float64

Event TaskMetricsIncremental

type AutomateEventTaskSetup struct{…}

Envelope for the “task:setup” event from /v1/automate.

Data AutomateEventTaskSetupData

Event data when a task is setup

BrowserName string

IterationID string

Task string

Timestamp float64

Data anyOptional

Guardrails stringOptional

HasAPIKey boolOptional

KeySource stringOptional

One of the following:

const AutomateEventTaskSetupDataKeySourceGlobal AutomateEventTaskSetupDataKeySource = "global"

const AutomateEventTaskSetupDataKeySourceEnv AutomateEventTaskSetupDataKeySource = "env"

const AutomateEventTaskSetupDataKeySourceNotSet AutomateEventTaskSetupDataKeySource = "not_set"

Model stringOptional

Provider stringOptional

Proxy stringOptional

PwCdpEndpoint stringOptional

PwCdpEndpointCount float64Optional

Total number of CDP endpoints configured (index, not URLs)

PwCdpEndpoints []stringOptional

PwEndpoint stringOptional

URL stringOptional

Vision boolOptional

Event TaskSetup

type AutomateEventTaskStarted struct{…}

Envelope for the “task:started” event from /v1/automate.

Data AutomateEventTaskStartedData

Event data when a task is started

IterationID string

Plan string

SuccessCriteria string

Task string

Timestamp float64

URL string

ActionItems []stringOptional

Event TaskStarted

type AutomateEventTaskTraceContext struct{…}

Envelope for the “task:trace_context” event from /v1/automate.

Data AutomateEventTaskTraceContextData

Payload for the task:trace_context event. Carries the OpenTelemetry trace ID for this /v1/automate request so consumers can deep-link to distributed-tracing UIs (e.g. Cloud Trace, Cloud Logging) for the run.

TraceID string

W3C trace ID — 32-character lowercase hexadecimal string.

Event TaskTraceContext

type AutomateEventTaskValidated struct{…}

Envelope for the “task:validated” event from /v1/automate.

Data AutomateEventTaskValidatedData

Event data for task validation

CompletionQuality string

One of the following:

const AutomateEventTaskValidatedDataCompletionQualityFailed AutomateEventTaskValidatedDataCompletionQuality = "failed"

const AutomateEventTaskValidatedDataCompletionQualityPartial AutomateEventTaskValidatedDataCompletionQuality = "partial"

const AutomateEventTaskValidatedDataCompletionQualityComplete AutomateEventTaskValidatedDataCompletionQuality = "complete"

const AutomateEventTaskValidatedDataCompletionQualityExcellent AutomateEventTaskValidatedDataCompletionQuality = "excellent"

FinalAnswer string

IterationID string

Observation string

Timestamp float64

Feedback stringOptional

Event TaskValidated

type AutomateEventTaskValidationError struct{…}

Envelope for the “task:validation_error” event from /v1/automate.

Data AutomateEventTaskValidationErrorData

Event data for validation errors during action response processing

Errors []string

IterationID string

RawResponse any

RetryCount float64

Timestamp float64

Event TaskValidationError

type ResearchEventUnion interface{…}

A Server-Sent Event from /v1/research. Typed discriminated union keyed on event.

One of the following:

type ResearchEventAnalyzingEnd struct{…}

Envelope for the “analyzing:end” event from /v1/research.

Data ResearchEventAnalyzingEndData

Analyzed float64

Failed float64

Iteration float64

Message string

Samples []ResearchEventAnalyzingEndDataSample

Domain string

Title string

URL string

URLSource string

URL source tracking - where a URL came from

One of the following:

const ResearchEventAnalyzingEndDataSampleURLSourceUserInput ResearchEventAnalyzingEndDataSampleURLSource = "user-input"

const ResearchEventAnalyzingEndDataSampleURLSourceSearchResult ResearchEventAnalyzingEndDataSampleURLSource = "search-result"

const ResearchEventAnalyzingEndDataSampleURLSourceExtractedLink ResearchEventAnalyzingEndDataSampleURLSource = "extracted-link"

Relevance stringOptional

One of the following:

const ResearchEventAnalyzingEndDataSampleRelevanceLow ResearchEventAnalyzingEndDataSampleRelevance = "low"

const ResearchEventAnalyzingEndDataSampleRelevanceMedium ResearchEventAnalyzingEndDataSampleRelevance = "medium"

const ResearchEventAnalyzingEndDataSampleRelevanceHigh ResearchEventAnalyzingEndDataSampleRelevance = "high"

Reliability stringOptional

One of the following:

const ResearchEventAnalyzingEndDataSampleReliabilityLow ResearchEventAnalyzingEndDataSampleReliability = "low"

const ResearchEventAnalyzingEndDataSampleReliabilityMedium ResearchEventAnalyzingEndDataSampleReliability = "medium"

const ResearchEventAnalyzingEndDataSampleReliabilityHigh ResearchEventAnalyzingEndDataSampleReliability = "high"

Summary stringOptional

Timestamp float64

Event AnalyzingEnd

type ResearchEventAnalyzingStart struct{…}

Envelope for the “analyzing:start” event from /v1/research.

Data ResearchEventAnalyzingStartData

Iteration float64

Message string

PageCount float64

Timestamp float64

Event AnalyzingStart

type ResearchEventComplete struct{…}

Envelope for the “complete” event from /v1/research.

Data ResearchEventCompleteData

complete - Research finished successfully

Message string

Metadata ResearchEventCompleteDataMetadata

Research metadata

Note: citedPages, gapEvaluations, outline, and judgments are optional to support fast mode, which skips these phases for maximum speed.

ExecutedQueries [][]string

Mode string

Research mode determines depth, thinking budget, and quality controls

Modes (in order of cost/thoroughness):

fast: Quick answers with minimal validation (~$2, 1 iteration, no judge)
balanced: Standard research with moderate depth (~$8, 3 iterations, Flash models, no judge)
deep: Thorough research with judge review (~$15, 5 iterations, Flash models, with judge)
max: Maximum quality with Pro models (~$40, 5 iterations, Pro models, with judge)
ultra: Ultimate tier - all Pro models, 10 iterations (expensive, for when accuracy is paramount)

One of the following:

const ResearchEventCompleteDataMetadataModeFast ResearchEventCompleteDataMetadataMode = "fast"

const ResearchEventCompleteDataMetadataModeBalanced ResearchEventCompleteDataMetadataMode = "balanced"

const ResearchEventCompleteDataMetadataModeDeep ResearchEventCompleteDataMetadataMode = "deep"

const ResearchEventCompleteDataMetadataModeMax ResearchEventCompleteDataMetadataMode = "max"

const ResearchEventCompleteDataMetadataModeUltra ResearchEventCompleteDataMetadataMode = "ultra"

Prompt string

QueryComplexity string

One of the following:

const ResearchEventCompleteDataMetadataQueryComplexitySimple ResearchEventCompleteDataMetadataQueryComplexity = "simple"

const ResearchEventCompleteDataMetadataQueryComplexityModerate ResearchEventCompleteDataMetadataQueryComplexity = "moderate"

const ResearchEventCompleteDataMetadataQueryComplexityComplex ResearchEventCompleteDataMetadataQueryComplexity = "complex"

ResearchObjective string

ResearchPlan string

ResearchQuestions []string

TotalPagesAnalyzed float64

Total pages analyzed across all iterations

CitedPages []ResearchEventCompleteDataMetadataCitedPageOptional

Pages cited in the report, ordered by first citation appearance

ID string

Claims []string

SourceQueries []string

URL string

Depth float64Optional

FullText stringOptional

Full page text (fetched markdown or search excerpts). Only populated when includeFullText: true in ResearchOptions.

Fast mode: Parallel API excerpts (~5000 chars)
Other modes: Fetched page markdown

ParentURL stringOptional

Relevance stringOptional

One of the following:

const ResearchEventCompleteDataMetadataCitedPageRelevanceLow ResearchEventCompleteDataMetadataCitedPageRelevance = "low"

const ResearchEventCompleteDataMetadataCitedPageRelevanceMedium ResearchEventCompleteDataMetadataCitedPageRelevance = "medium"

const ResearchEventCompleteDataMetadataCitedPageRelevanceHigh ResearchEventCompleteDataMetadataCitedPageRelevance = "high"

Reliability stringOptional

One of the following:

const ResearchEventCompleteDataMetadataCitedPageReliabilityLow ResearchEventCompleteDataMetadataCitedPageReliability = "low"

const ResearchEventCompleteDataMetadataCitedPageReliabilityMedium ResearchEventCompleteDataMetadataCitedPageReliability = "medium"

const ResearchEventCompleteDataMetadataCitedPageReliabilityHigh ResearchEventCompleteDataMetadataCitedPageReliability = "high"

Summary stringOptional

LLM-generated summary. Undefined in fast mode (no content analysis).

Title stringOptional

URLSource stringOptional

URL source tracking - where a URL came from

One of the following:

const ResearchEventCompleteDataMetadataCitedPageURLSourceUserInput ResearchEventCompleteDataMetadataCitedPageURLSource = "user-input"

const ResearchEventCompleteDataMetadataCitedPageURLSourceSearchResult ResearchEventCompleteDataMetadataCitedPageURLSource = "search-result"

const ResearchEventCompleteDataMetadataCitedPageURLSourceExtractedLink ResearchEventCompleteDataMetadataCitedPageURLSource = "extracted-link"

GapEvaluations []ResearchEventCompleteDataMetadataGapEvaluationOptional

GapDescription string

Based on unanswered/partial questions, what specific information is still needed?

QuestionAssessments []ResearchEventCompleteDataMetadataGapEvaluationQuestionAssessment

Assessment of each research question’s status and findings

Findings string

What we learned (if answered/partial) or what’s missing (if unanswered)

Question string

The research question being assessed

Status string

Status: answered (clear info), partial (some info, gaps remain), unanswered (no relevant info)

One of the following:

const ResearchEventCompleteDataMetadataGapEvaluationQuestionAssessmentStatusAnswered ResearchEventCompleteDataMetadataGapEvaluationQuestionAssessmentStatus = "answered"

const ResearchEventCompleteDataMetadataGapEvaluationQuestionAssessmentStatusPartial ResearchEventCompleteDataMetadataGapEvaluationQuestionAssessmentStatus = "partial"

const ResearchEventCompleteDataMetadataGapEvaluationQuestionAssessmentStatusUnanswered ResearchEventCompleteDataMetadataGapEvaluationQuestionAssessmentStatus = "unanswered"

ResearchCoverage string

Research coverage level - assesses quality across all questions.

Hierarchy: Light < Moderate < Solid < Comprehensive

Light: Basic info on some questions, most need more depth → Continue
Moderate: Multiple questions answered, some remain partial → Continue
Solid: Most questions well-answered with validated sources → Sufficient to stop
Comprehensive: All questions thoroughly answered, exceptional depth → Definitely stop

One of the following:

const ResearchEventCompleteDataMetadataGapEvaluationResearchCoverageLight ResearchEventCompleteDataMetadataGapEvaluationResearchCoverage = "Light"

const ResearchEventCompleteDataMetadataGapEvaluationResearchCoverageModerate ResearchEventCompleteDataMetadataGapEvaluationResearchCoverage = "Moderate"

const ResearchEventCompleteDataMetadataGapEvaluationResearchCoverageSolid ResearchEventCompleteDataMetadataGapEvaluationResearchCoverage = "Solid"

const ResearchEventCompleteDataMetadataGapEvaluationResearchCoverageComprehensive ResearchEventCompleteDataMetadataGapEvaluationResearchCoverage = "Comprehensive"

ShouldContinueResearch bool

Explicit decision: should research continue with another iteration?

Considers: how many questions unanswered/partial, coverage for mode, remaining iterations
Drives query generation: true → generate queries, false → stop researching

NewResearchQuestions []stringOptional

New research questions to add (optional, use sparingly)

Only if original decomposition missed something critical
Maximum 2-3 new questions total across all iterations
Most iterations should return empty array or omit this field

SearchQueries []stringOptional

Search queries to address identified gaps (only when shouldContinueResearch is true)

Target unanswered questions first, then partial questions
3-10 targeted queries if shouldContinueResearch is true
Omit or provide empty array if shouldContinueResearch is false

Judgments []ResearchEventCompleteDataMetadataJudgmentOptional

Approved bool

Observation string

Score float64

Feedback stringOptional

Metrics ResearchEventCompleteDataMetadataMetricsOptional

Complete research metrics

CachedFetches float64

Cached fetch count (subset of fetches)

CachedSearches map[string, float64]

Cached search count by provider name (subset of searches)

Fetches float64

Fetch count (number of pages fetched)

Iterations float64

Number of research iterations performed

Phases map[string, ResearchEventCompleteDataMetadataMetricsPhase]

Phase timings with duration in milliseconds

Duration float64

RobotsBlocked float64

Number of URLs blocked by robots.txt

Searches map[string, float64]

Search count by provider name (e.g., “bright-data”, “parallel”)

SuccessRates ResearchEventCompleteDataMetadataMetricsSuccessRates

Success rate metrics

Analyzes float64

Fetches float64

Searches float64

Tokens map[string, ResearchEventCompleteDataMetadataMetricsToken]

Token usage by model ID (e.g., “gemini-2.5-flash”)

Input float64

Output float64

TotalDuration float64

Total duration in milliseconds

Outline ResearchEventCompleteDataMetadataOutlineOptional

Report outline from research writer

DirectAnswer string

KeyTakeaways []string

Outline string

RelevantSourceIDs []string

URLSources ResearchEventCompleteDataMetadataURLSourcesOptional

ExtractedLinks float64

SearchResults float64

UserProvided float64

Report string

Timestamp float64

Event Complete

type ResearchEventError struct{…}

Envelope for the “error” event from /v1/research.

Data ResearchEventErrorData

error - Research failed

Error ResearchEventErrorDataError

Message string

Name string

Stack stringOptional

Message string

Timestamp float64

Activity stringOptional

Activity types for research workflow

One of the following:

const ResearchEventErrorDataActivityPrefetching ResearchEventErrorDataActivity = "prefetching"

const ResearchEventErrorDataActivityPlanning ResearchEventErrorDataActivity = "planning"

const ResearchEventErrorDataActivityIteration ResearchEventErrorDataActivity = "iteration"

const ResearchEventErrorDataActivitySearching ResearchEventErrorDataActivity = "searching"

const ResearchEventErrorDataActivityAnalyzing ResearchEventErrorDataActivity = "analyzing"

const ResearchEventErrorDataActivityFollowing ResearchEventErrorDataActivity = "following"

const ResearchEventErrorDataActivityEvaluating ResearchEventErrorDataActivity = "evaluating"

const ResearchEventErrorDataActivityOutlining ResearchEventErrorDataActivity = "outlining"

const ResearchEventErrorDataActivityWriting ResearchEventErrorDataActivity = "writing"

const ResearchEventErrorDataActivityJudging ResearchEventErrorDataActivity = "judging"

Iteration float64Optional

Event Error

type ResearchEventEvaluatingEnd struct{…}

Envelope for the “evaluating:end” event from /v1/research.

Data ResearchEventEvaluatingEndData

Coverage string

One of the following:

const ResearchEventEvaluatingEndDataCoverageLight ResearchEventEvaluatingEndDataCoverage = "Light"

const ResearchEventEvaluatingEndDataCoverageModerate ResearchEventEvaluatingEndDataCoverage = "Moderate"

const ResearchEventEvaluatingEndDataCoverageSolid ResearchEventEvaluatingEndDataCoverage = "Solid"

const ResearchEventEvaluatingEndDataCoverageComprehensive ResearchEventEvaluatingEndDataCoverage = "Comprehensive"

Gaps string

Iteration float64

Message string

NextQueries []string

QuestionAssessments []ResearchEventEvaluatingEndDataQuestionAssessment

Findings string

What we learned (if answered/partial) or what’s missing (if unanswered)

Question string

The research question being assessed

Status string

Status: answered (clear info), partial (some info, gaps remain), unanswered (no relevant info)

One of the following:

const ResearchEventEvaluatingEndDataQuestionAssessmentStatusAnswered ResearchEventEvaluatingEndDataQuestionAssessmentStatus = "answered"

const ResearchEventEvaluatingEndDataQuestionAssessmentStatusPartial ResearchEventEvaluatingEndDataQuestionAssessmentStatus = "partial"

const ResearchEventEvaluatingEndDataQuestionAssessmentStatusUnanswered ResearchEventEvaluatingEndDataQuestionAssessmentStatus = "unanswered"

ShouldContinue bool

Timestamp float64

Event EvaluatingEnd

type ResearchEventEvaluatingStart struct{…}

Envelope for the “evaluating:start” event from /v1/research.

Data ResearchEventEvaluatingStartData

Iteration float64

Message string

PagesAnalyzed float64

Total pages analyzed so far (including this iteration)

QuestionCount float64

Number of research questions being assessed

Timestamp float64

Event EvaluatingStart

type ResearchEventFollowingEnd struct{…}

Envelope for the “following:end” event from /v1/research.

Data ResearchEventFollowingEndData

Failed float64

Followed float64

Iteration float64

Message string

Samples []ResearchEventFollowingEndDataSample

Domain string

Title string

URL string

URLSource string

URL source tracking - where a URL came from

One of the following:

const ResearchEventFollowingEndDataSampleURLSourceUserInput ResearchEventFollowingEndDataSampleURLSource = "user-input"

const ResearchEventFollowingEndDataSampleURLSourceSearchResult ResearchEventFollowingEndDataSampleURLSource = "search-result"

const ResearchEventFollowingEndDataSampleURLSourceExtractedLink ResearchEventFollowingEndDataSampleURLSource = "extracted-link"

Relevance stringOptional

One of the following:

const ResearchEventFollowingEndDataSampleRelevanceLow ResearchEventFollowingEndDataSampleRelevance = "low"

const ResearchEventFollowingEndDataSampleRelevanceMedium ResearchEventFollowingEndDataSampleRelevance = "medium"

const ResearchEventFollowingEndDataSampleRelevanceHigh ResearchEventFollowingEndDataSampleRelevance = "high"

Reliability stringOptional

One of the following:

const ResearchEventFollowingEndDataSampleReliabilityLow ResearchEventFollowingEndDataSampleReliability = "low"

const ResearchEventFollowingEndDataSampleReliabilityMedium ResearchEventFollowingEndDataSampleReliability = "medium"

const ResearchEventFollowingEndDataSampleReliabilityHigh ResearchEventFollowingEndDataSampleReliability = "high"

Summary stringOptional

Timestamp float64

Event FollowingEnd

type ResearchEventFollowingStart struct{…}

Envelope for the “following:start” event from /v1/research.

Data ResearchEventFollowingStartData

Iteration float64

LinkCount float64

Message string

Timestamp float64

Event FollowingStart

type ResearchEventIterationEnd struct{…}

Envelope for the “iteration:end” event from /v1/research.

Data ResearchEventIterationEndData

IsLast bool

Whether this is the final iteration

Iteration float64

Message string

Timestamp float64

StopReason stringOptional

Why research iterations stopped (only present when isLast is true)

One of the following:

const ResearchEventIterationEndDataStopReasonMaxIterations ResearchEventIterationEndDataStopReason = "max_iterations"

const ResearchEventIterationEndDataStopReasonCoverageSufficient ResearchEventIterationEndDataStopReason = "coverage_sufficient"

Event IterationEnd

type ResearchEventIterationStart struct{…}

Envelope for the “iteration:start” event from /v1/research.

Data ResearchEventIterationStartData

Iteration float64

MaxIterations float64

Maximum iterations for this research mode

Message string

Queries []string

Search queries to execute in this iteration

Timestamp float64

Event IterationStart

type ResearchEventJudgingEnd struct{…}

Envelope for the “judging:end” event from /v1/research.

Data ResearchEventJudgingEndData

Approved bool

Attempt float64

Message string

Score float64

Timestamp float64

Feedback stringOptional

Event JudgingEnd

type ResearchEventJudgingStart struct{…}

Envelope for the “judging:start” event from /v1/research.

Data ResearchEventJudgingStartData

Attempt float64

MaxAttempts float64

Maximum attempts allowed (1 + maxRevisions)

Message string

Timestamp float64

Event JudgingStart

type ResearchEventOutliningEnd struct{…}

Envelope for the “outlining:end” event from /v1/research.

Data ResearchEventOutliningEndData

Message string

SourcesSelected float64

Timestamp float64

Event OutliningEnd

type ResearchEventOutliningStart struct{…}

Envelope for the “outlining:start” event from /v1/research.

Data ResearchEventOutliningStartData

Message string

PagesAnalyzed float64

Total pages analyzed across all iterations

QualityPageCount float64

Pages that meet quality threshold (medium+ relevance and reliability)

Timestamp float64

Event OutliningStart

type ResearchEventPlanningEnd struct{…}

Envelope for the “planning:end” event from /v1/research.

Data ResearchEventPlanningEndData

Complexity string

One of the following:

const ResearchEventPlanningEndDataComplexitySimple ResearchEventPlanningEndDataComplexity = "simple"

const ResearchEventPlanningEndDataComplexityModerate ResearchEventPlanningEndDataComplexity = "moderate"

const ResearchEventPlanningEndDataComplexityComplex ResearchEventPlanningEndDataComplexity = "complex"

Message string

Objective string

Plan string

Queries []string

Questions []string

Timestamp float64

Event PlanningEnd

type ResearchEventPlanningStart struct{…}

Envelope for the “planning:start” event from /v1/research.

Data ResearchEventPlanningStartData

HasPrefetchedContext bool

Whether prefetched user-provided URLs exist for context

Message string

Timestamp float64

Event PlanningStart

type ResearchEventPrefetchingEnd struct{…}

Envelope for the “prefetching:end” event from /v1/research.

Data ResearchEventPrefetchingEndData

Failed float64

Fetched float64

Message string

Timestamp float64

Event PrefetchingEnd

type ResearchEventPrefetchingStart struct{…}

Envelope for the “prefetching:start” event from /v1/research.

Data ResearchEventPrefetchingStartData

Message string

Timestamp float64

URLCount float64

URLs []string

Event PrefetchingStart

type ResearchEventSearchingEnd struct{…}

Envelope for the “searching:end” event from /v1/research.

Data ResearchEventSearchingEndData

Iteration float64

Message string

Timestamp float64

URLsFound float64

URLsNew float64

Event SearchingEnd

type ResearchEventSearchingStart struct{…}

Envelope for the “searching:start” event from /v1/research.

Data ResearchEventSearchingStartData

Iteration float64

Message string

Queries []string

Timestamp float64

Event SearchingStart

type ResearchEventStart struct{…}

Envelope for the “start” event from /v1/research.

Data ResearchEventStartData

start - Research begins

Message string

Timestamp float64

Event Start

type ResearchEventWritingEnd struct{…}

Envelope for the “writing:end” event from /v1/research.

Data ResearchEventWritingEndData

Attempt float64

Message string

Timestamp float64

Event WritingEnd

type ResearchEventWritingStart struct{…}

Envelope for the “writing:start” event from /v1/research.

Data ResearchEventWritingStartData

Attempt float64

IsRevision bool

Whether this is a revision attempt (attempt > 1)

MaxAttempts float64

Maximum attempts allowed (1 + maxRevisions)

Message string

Timestamp float64

PreviousScore float64Optional

Previous judgment score if this is a revision

Event WritingStart