Execute AI-powered browser automation tasks using natural language with optional geotargeting. This endpoint always streams responses using Server-Sent Events (SSE).
Streaming Response:
- All responses are streamed using Server-Sent Events (
text/event-stream) - Real-time progress updates and results as they’re generated
Geotargeting:
- Optionally specify a country code for geotargeted browsing
Use Cases:
- Web scraping and data extraction
- Form filling and interaction
- Navigation and information gathering
- Multi-step web workflows
- Content analysis from web pages
ParametersExpand Collapse
body AgentAutomateParams
Optional geotargeting parameters for proxy requests
Optional geotargeting parameters for proxy requests
Country code using ISO 3166-1 alpha-2 standard (2 letters, e.g., “US”, “GB”, “JP”). See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
ReturnsExpand Collapse
type AutomateEventUnion interface{…}A Server-Sent Event from /v1/automate. Typed discriminated union keyed on event.
A Server-Sent Event from /v1/automate. Typed discriminated union keyed on event.
type AutomateEventAgentExtracted struct{…}Envelope for the “agent:extracted” event from /v1/automate.
Envelope for the “agent:extracted” event from /v1/automate.
type AutomateEventAgentProcessing struct{…}Envelope for the “agent:processing” event from /v1/automate.
Envelope for the “agent:processing” event from /v1/automate.
type AutomateEventAIGeneration struct{…}Envelope for the “ai:generation” event from /v1/automate.
Envelope for the “ai:generation” event from /v1/automate.
Data AutomateEventAIGenerationDataEvent data when AI generation occurs
Event data when AI generation occurs
FinishReason string
Messages []AutomateEventAIGenerationDataMessageUnionOptional
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.
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.
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageSystemProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageUser struct{…}A user message. It can contain text or a combination of text and images.
A user message. It can contain text or a combination of text and images.
Content AutomateEventAIGenerationDataMessageUserContentUnionContent of a user message. It can be a string or an array of text and image parts.
Content of a user message. It can be a string or an array of text and image parts.
type AutomateEventAIGenerationDataMessageUserContentArray []AutomateEventAIGenerationDataMessageUserContentArrayItemUnion
type AutomateEventAIGenerationDataMessageUserContentArrayItemText struct{…}Text content part of a prompt. It contains a string of text.
Text content part of a prompt. It contains a string of text.
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageUserContentArrayItemTextProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageUserContentArrayItemTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageUserContentArrayItemTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageUserContentArrayItemImage struct{…}Image content part of a prompt. It contains an image.
Image content part of a prompt. It contains an image.
Image AutomateEventAIGenerationDataMessageUserContentArrayItemImageImageUnionImage data. Can either be:
- data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
- URL: a URL that points to the image
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
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageUserContentArrayItemImageProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageUserContentArrayItemImageProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageUserContentArrayItemImageProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageUserContentArrayItemFile struct{…}File content part of a prompt. It contains a file.
File content part of a prompt. It contains a file.
Data AutomateEventAIGenerationDataMessageUserContentArrayItemFileDataUnionFile data. Can either be:
- data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
- URL: a URL that points to the image
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
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageUserContentArrayItemFileProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageUserContentArrayItemFileProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageUserContentArrayItemFileProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageUserProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageAssistant struct{…}An assistant message. It can contain text, tool calls, or a combination of text and tool calls.
An assistant message. It can contain text, tool calls, or a combination of text and tool calls.
Content AutomateEventAIGenerationDataMessageAssistantContentUnionContent of an assistant message. It can be a string or an array of text, image, reasoning, redacted reasoning, and tool call parts.
Content of an assistant message. It can be a string or an array of text, image, reasoning, redacted reasoning, and tool call parts.
type AutomateEventAIGenerationDataMessageAssistantContentArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemUnion
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemText struct{…}Text content part of a prompt. It contains a string of text.
Text content part of a prompt. It contains a string of text.
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemTextProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemFile struct{…}File content part of a prompt. It contains a file.
File content part of a prompt. It contains a file.
Data AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileDataUnionFile data. Can either be:
- data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
- URL: a URL that points to the image
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
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemReasoning struct{…}Reasoning content part of a prompt. It contains a reasoning.
Reasoning content part of a prompt. It contains a reasoning.
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemReasoningProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemReasoningProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemReasoningProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolCall struct{…}Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).
Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).
Arguments of the tool call. This is a JSON-serializable object that matches the tool’s input schema.
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolCallProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolCallProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolCallProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResult struct{…}Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
Output AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputUnionResult of the tool call. This is a JSON-serializable object.
Result of the tool call. This is a JSON-serializable object.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputText struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputTextProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJson struct{…}
Value AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueUnionA 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.
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.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueMap map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueMapItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727ItemUnion]
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputExecutionDenied struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputExecutionDeniedProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputExecutionDeniedProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputExecutionDeniedProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorText struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorTextProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJson struct{…}
Value AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueUnionA 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.
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.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueMap map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueMapItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727ItemUnion]
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContent struct{…}
Value []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueUnion
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueText struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueTextProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueMedia struct{…}
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileData struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileDataProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileDataProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileDataProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileURL struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileURLProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileURLProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileURLProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileID struct{…}
FileID AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileIDFileIDUnionID 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’.
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’.
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileIDProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageData struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageDataProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageDataProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageDataProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageURL struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageURLProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageURLProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageURLProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileID struct{…}
FileID AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileIDFileIDUnionImage 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’.
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’.
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileIDProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueCustom struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueCustomProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueCustomProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueCustomProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageTool struct{…}A tool message. It contains the result of one or more tool calls.
A tool message. It contains the result of one or more tool calls.
Content []AutomateEventAIGenerationDataMessageToolContentUnionContent of a tool message. It is an array of tool result parts.
Content of a tool message. It is an array of tool result parts.
type AutomateEventAIGenerationDataMessageToolContentToolResult struct{…}Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
Output AutomateEventAIGenerationDataMessageToolContentToolResultOutputUnionResult of the tool call. This is a JSON-serializable object.
Result of the tool call. This is a JSON-serializable object.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputText struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputTextProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJson struct{…}
Value AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueUnionA 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.
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.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueMap map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueMapItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727ItemUnion]
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputExecutionDenied struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputExecutionDeniedProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputExecutionDeniedProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputExecutionDeniedProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorText struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorTextProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJson struct{…}
Value AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueUnionA 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.
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.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueMap map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueMapItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727ItemUnion]
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContent struct{…}
Value []AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueUnion
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueText struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueTextProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileData struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileDataProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileDataProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileDataProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileURL struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileURLProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileURLProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileURLProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileID struct{…}
FileID AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileIDFileIDUnionID 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’.
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’.
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileIDProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageData struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageDataProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageDataProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageDataProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageURL struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageURLProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageURLProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageURLProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileID struct{…}
FileID AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileIDFileIDUnionImage 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’.
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’.
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileIDProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueCustom struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueCustomProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueCustomProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueCustomProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageToolContentToolResultProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationError struct{…}Envelope for the “ai:generation:error” event from /v1/automate.
Envelope for the “ai:generation:error” event from /v1/automate.
type AutomateEventBrowserActionCompleted struct{…}Envelope for the “browser:action_completed” event from /v1/automate.
Envelope for the “browser:action_completed” event from /v1/automate.
type AutomateEventBrowserActionStarted struct{…}Envelope for the “browser:action_started” event from /v1/automate.
Envelope for the “browser:action_started” event from /v1/automate.
type AutomateEventBrowserNavigated struct{…}Envelope for the “browser:navigated” event from /v1/automate.
Envelope for the “browser:navigated” event from /v1/automate.
type AutomateEventBrowserReconnected struct{…}Envelope for the “browser:reconnected” event from /v1/automate.
Envelope for the “browser:reconnected” event from /v1/automate.
type AutomateEventBrowserScreenshotCaptured struct{…}Envelope for the “browser:screenshot_captured” event from /v1/automate.
Envelope for the “browser:screenshot_captured” event from /v1/automate.
type AutomateEventBrowserScreenshotCapturedImage struct{…}Envelope for the “browser:screenshot_captured_image” event from /v1/automate.
Envelope for the “browser:screenshot_captured_image” event from /v1/automate.
type AutomateEventCdpEndpointConnected struct{…}Envelope for the “cdp:endpoint_connected” event from /v1/automate.
Envelope for the “cdp:endpoint_connected” event from /v1/automate.
type AutomateEventCdpEndpointCycle struct{…}Envelope for the “cdp:endpoint_cycle” event from /v1/automate.
Envelope for the “cdp:endpoint_cycle” event from /v1/automate.
type AutomateEventComplete struct{…}Envelope for the “complete” event from /v1/automate.
Envelope for the “complete” event from /v1/automate.
Data AutomateEventCompleteDataPayload 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.
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.
Error AutomateEventCompleteDataErrorOptionalStructured error information for failed tasks
Structured error information for failed tasks
type AutomateEventError struct{…}Envelope for the “error” event from /v1/automate.
Envelope for the “error” event from /v1/automate.
Data AutomateEventErrorDataPayload 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.
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.
type AutomateEventInteractiveFormDataError struct{…}Envelope for the “interactive:form_data:error” event from /v1/automate.
Envelope for the “interactive:form_data:error” event from /v1/automate.
Data AutomateEventInteractiveFormDataErrorDataEvent 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.
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.
Fields []AutomateEventInteractiveFormDataErrorDataField
FieldType stringSemantic field type
Semantic field type
type AutomateEventInteractiveFormDataRequest struct{…}Envelope for the “interactive:form_data:request” event from /v1/automate.
Envelope for the “interactive:form_data:request” event from /v1/automate.
Data AutomateEventInteractiveFormDataRequestDataEvent data when the agent requests user data for form fields
Event data when the agent requests user data for form fields
Fields []AutomateEventInteractiveFormDataRequestDataField
FieldType stringSemantic field type
Semantic field type
type AutomateEventSystemDebugCompression struct{…}Envelope for the “system:debug_compression” event from /v1/automate.
Envelope for the “system:debug_compression” event from /v1/automate.
type AutomateEventSystemDebugMessage struct{…}Envelope for the “system:debug_message” event from /v1/automate.
Envelope for the “system:debug_message” event from /v1/automate.
type AutomateEventTaskMetricsIncremental struct{…}Envelope for the “task:metrics_incremental” event from /v1/automate.
Envelope for the “task:metrics_incremental” event from /v1/automate.
type AutomateEventTaskSetup struct{…}Envelope for the “task:setup” event from /v1/automate.
Envelope for the “task:setup” event from /v1/automate.
type AutomateEventTaskTraceContext struct{…}Envelope for the “task:trace_context” event from /v1/automate.
Envelope for the “task:trace_context” event from /v1/automate.
type AutomateEventTaskValidated struct{…}Envelope for the “task:validated” event from /v1/automate.
Envelope for the “task:validated” event from /v1/automate.
Data AutomateEventTaskValidatedDataEvent data for task validation
Event data for task validation
CompletionQuality string
type AutomateEventUnion interface{…}A Server-Sent Event from /v1/automate. Typed discriminated union keyed on event.
A Server-Sent Event from /v1/automate. Typed discriminated union keyed on event.
type AutomateEventAgentExtracted struct{…}Envelope for the “agent:extracted” event from /v1/automate.
Envelope for the “agent:extracted” event from /v1/automate.
type AutomateEventAgentProcessing struct{…}Envelope for the “agent:processing” event from /v1/automate.
Envelope for the “agent:processing” event from /v1/automate.
type AutomateEventAIGeneration struct{…}Envelope for the “ai:generation” event from /v1/automate.
Envelope for the “ai:generation” event from /v1/automate.
Data AutomateEventAIGenerationDataEvent data when AI generation occurs
Event data when AI generation occurs
FinishReason string
Messages []AutomateEventAIGenerationDataMessageUnionOptional
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.
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.
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageSystemProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageUser struct{…}A user message. It can contain text or a combination of text and images.
A user message. It can contain text or a combination of text and images.
Content AutomateEventAIGenerationDataMessageUserContentUnionContent of a user message. It can be a string or an array of text and image parts.
Content of a user message. It can be a string or an array of text and image parts.
type AutomateEventAIGenerationDataMessageUserContentArray []AutomateEventAIGenerationDataMessageUserContentArrayItemUnion
type AutomateEventAIGenerationDataMessageUserContentArrayItemText struct{…}Text content part of a prompt. It contains a string of text.
Text content part of a prompt. It contains a string of text.
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageUserContentArrayItemTextProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageUserContentArrayItemTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageUserContentArrayItemTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageUserContentArrayItemImage struct{…}Image content part of a prompt. It contains an image.
Image content part of a prompt. It contains an image.
Image AutomateEventAIGenerationDataMessageUserContentArrayItemImageImageUnionImage data. Can either be:
- data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
- URL: a URL that points to the image
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
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageUserContentArrayItemImageProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageUserContentArrayItemImageProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageUserContentArrayItemImageProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageUserContentArrayItemFile struct{…}File content part of a prompt. It contains a file.
File content part of a prompt. It contains a file.
Data AutomateEventAIGenerationDataMessageUserContentArrayItemFileDataUnionFile data. Can either be:
- data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
- URL: a URL that points to the image
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
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageUserContentArrayItemFileProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageUserContentArrayItemFileProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageUserContentArrayItemFileProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageUserProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageAssistant struct{…}An assistant message. It can contain text, tool calls, or a combination of text and tool calls.
An assistant message. It can contain text, tool calls, or a combination of text and tool calls.
Content AutomateEventAIGenerationDataMessageAssistantContentUnionContent of an assistant message. It can be a string or an array of text, image, reasoning, redacted reasoning, and tool call parts.
Content of an assistant message. It can be a string or an array of text, image, reasoning, redacted reasoning, and tool call parts.
type AutomateEventAIGenerationDataMessageAssistantContentArray []AutomateEventAIGenerationDataMessageAssistantContentArrayItemUnion
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemText struct{…}Text content part of a prompt. It contains a string of text.
Text content part of a prompt. It contains a string of text.
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemTextProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemFile struct{…}File content part of a prompt. It contains a file.
File content part of a prompt. It contains a file.
Data AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileDataUnionFile data. Can either be:
- data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
- URL: a URL that points to the image
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
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemFileProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemReasoning struct{…}Reasoning content part of a prompt. It contains a reasoning.
Reasoning content part of a prompt. It contains a reasoning.
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemReasoningProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemReasoningProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemReasoningProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolCall struct{…}Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).
Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).
Arguments of the tool call. This is a JSON-serializable object that matches the tool’s input schema.
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolCallProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolCallProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolCallProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResult struct{…}Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
Output AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputUnionResult of the tool call. This is a JSON-serializable object.
Result of the tool call. This is a JSON-serializable object.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputText struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputTextProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJson struct{…}
Value AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueUnionA 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.
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.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueMap map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueMapItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727ItemUnion]
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputExecutionDenied struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputExecutionDeniedProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputExecutionDeniedProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputExecutionDeniedProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorText struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorTextProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJson struct{…}
Value AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueUnionA 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.
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.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueMap map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueMapItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727ItemUnion]
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputErrorJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContent struct{…}
Value []AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueUnion
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueText struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueTextProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueMedia struct{…}
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileData struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileDataProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileDataProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileDataProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileURL struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileURLProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileURLProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileURLProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileID struct{…}
FileID AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileIDFileIDUnionID 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’.
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’.
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileIDProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageData struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageDataProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageDataProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageDataProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageURL struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageURLProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageURLProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageURLProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileID struct{…}
FileID AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileIDFileIDUnionImage 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’.
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’.
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileIDProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueImageFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueCustom struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueCustomProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueCustomProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultOutputContentValueCustomProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageAssistantContentArrayItemToolResultProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageAssistantProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageTool struct{…}A tool message. It contains the result of one or more tool calls.
A tool message. It contains the result of one or more tool calls.
Content []AutomateEventAIGenerationDataMessageToolContentUnionContent of a tool message. It is an array of tool result parts.
Content of a tool message. It is an array of tool result parts.
type AutomateEventAIGenerationDataMessageToolContentToolResult struct{…}Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
Output AutomateEventAIGenerationDataMessageToolContentToolResultOutputUnionResult of the tool call. This is a JSON-serializable object.
Result of the tool call. This is a JSON-serializable object.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputText struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputTextProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJson struct{…}
Value AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueUnionA 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.
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.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueMap map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueMapItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727ItemUnion]
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputExecutionDenied struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputExecutionDeniedProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputExecutionDeniedProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputExecutionDeniedProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorText struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorTextProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJson struct{…}
Value AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueUnionA 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.
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.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueMap map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueMapItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonValueMapItemV1Alias922155206_411_476_922155206_0_129727ItemUnion]
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputErrorJsonProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContent struct{…}
Value []AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueUnion
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueText struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueTextProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueTextProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueTextProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileData struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileDataProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileDataProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileDataProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileURL struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileURLProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileURLProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileURLProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileID struct{…}
FileID AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileIDFileIDUnionID 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’.
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’.
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileIDProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageData struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageDataProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageDataProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageDataProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageURL struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageURLProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageURLProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageURLProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileID struct{…}
FileID AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileIDFileIDUnionImage 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’.
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’.
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileIDProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueImageFileIDProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueCustom struct{…}
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueCustomProviderOptionUnion]]OptionalProvider-specific options.
Provider-specific options.
type AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueCustomProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultOutputContentValueCustomProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolContentToolResultProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationDataMessageToolContentToolResultProviderOptionV1Alias922155206_411_476_922155206_0_129727 map[string, AutomateEventAIGenerationDataMessageToolContentToolResultProviderOptionV1Alias922155206_411_476_922155206_0_129727ItemUnion]
ProviderOptions map[string, map[string, AutomateEventAIGenerationDataMessageToolProviderOptionUnion]]OptionalAdditional 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.
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.
type AutomateEventAIGenerationError struct{…}Envelope for the “ai:generation:error” event from /v1/automate.
Envelope for the “ai:generation:error” event from /v1/automate.
type AutomateEventBrowserActionCompleted struct{…}Envelope for the “browser:action_completed” event from /v1/automate.
Envelope for the “browser:action_completed” event from /v1/automate.
type AutomateEventBrowserActionStarted struct{…}Envelope for the “browser:action_started” event from /v1/automate.
Envelope for the “browser:action_started” event from /v1/automate.
type AutomateEventBrowserNavigated struct{…}Envelope for the “browser:navigated” event from /v1/automate.
Envelope for the “browser:navigated” event from /v1/automate.
type AutomateEventBrowserReconnected struct{…}Envelope for the “browser:reconnected” event from /v1/automate.
Envelope for the “browser:reconnected” event from /v1/automate.
type AutomateEventBrowserScreenshotCaptured struct{…}Envelope for the “browser:screenshot_captured” event from /v1/automate.
Envelope for the “browser:screenshot_captured” event from /v1/automate.
type AutomateEventBrowserScreenshotCapturedImage struct{…}Envelope for the “browser:screenshot_captured_image” event from /v1/automate.
Envelope for the “browser:screenshot_captured_image” event from /v1/automate.
type AutomateEventCdpEndpointConnected struct{…}Envelope for the “cdp:endpoint_connected” event from /v1/automate.
Envelope for the “cdp:endpoint_connected” event from /v1/automate.
type AutomateEventCdpEndpointCycle struct{…}Envelope for the “cdp:endpoint_cycle” event from /v1/automate.
Envelope for the “cdp:endpoint_cycle” event from /v1/automate.
type AutomateEventComplete struct{…}Envelope for the “complete” event from /v1/automate.
Envelope for the “complete” event from /v1/automate.
Data AutomateEventCompleteDataPayload 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.
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.
Error AutomateEventCompleteDataErrorOptionalStructured error information for failed tasks
Structured error information for failed tasks
type AutomateEventError struct{…}Envelope for the “error” event from /v1/automate.
Envelope for the “error” event from /v1/automate.
Data AutomateEventErrorDataPayload 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.
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.
type AutomateEventInteractiveFormDataError struct{…}Envelope for the “interactive:form_data:error” event from /v1/automate.
Envelope for the “interactive:form_data:error” event from /v1/automate.
Data AutomateEventInteractiveFormDataErrorDataEvent 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.
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.
Fields []AutomateEventInteractiveFormDataErrorDataField
FieldType stringSemantic field type
Semantic field type
type AutomateEventInteractiveFormDataRequest struct{…}Envelope for the “interactive:form_data:request” event from /v1/automate.
Envelope for the “interactive:form_data:request” event from /v1/automate.
Data AutomateEventInteractiveFormDataRequestDataEvent data when the agent requests user data for form fields
Event data when the agent requests user data for form fields
Fields []AutomateEventInteractiveFormDataRequestDataField
FieldType stringSemantic field type
Semantic field type
type AutomateEventSystemDebugCompression struct{…}Envelope for the “system:debug_compression” event from /v1/automate.
Envelope for the “system:debug_compression” event from /v1/automate.
type AutomateEventSystemDebugMessage struct{…}Envelope for the “system:debug_message” event from /v1/automate.
Envelope for the “system:debug_message” event from /v1/automate.
type AutomateEventTaskMetricsIncremental struct{…}Envelope for the “task:metrics_incremental” event from /v1/automate.
Envelope for the “task:metrics_incremental” event from /v1/automate.
type AutomateEventTaskSetup struct{…}Envelope for the “task:setup” event from /v1/automate.
Envelope for the “task:setup” event from /v1/automate.
type AutomateEventTaskTraceContext struct{…}Envelope for the “task:trace_context” event from /v1/automate.
Envelope for the “task:trace_context” event from /v1/automate.
type AutomateEventTaskValidated struct{…}Envelope for the “task:validated” event from /v1/automate.
Envelope for the “task:validated” event from /v1/automate.
Data AutomateEventTaskValidatedDataEvent data for task validation
Event data for task validation
CompletionQuality string
AI Task
package main
import (
"context"
"fmt"
"github.com/stainless-sdks/tabstack-go"
"github.com/stainless-sdks/tabstack-go/option"
)
func main() {
client := tabstack.NewClient(
option.WithAPIKey("My API Key"),
)
stream := client.Agent.AutomateStreaming(context.TODO(), tabstack.AgentAutomateParams{
Task: "Find the top 3 trending repositories and extract their names, descriptions, and star counts",
Guardrails: tabstack.String("browse and extract only, don't interact with repositories"),
URL: tabstack.String("https://github.com/trending"),
})
for stream.Next() {
fmt.Printf("%+v\n", stream.Current())
}
err := stream.Err()
if err != nil {
panic(err.Error())
}
}
{
"error": "maxIterations must be between 1 and 100"
}{
"error": "invalid URL format"
}{
"error": "task is required"
}Returns Examples
{
"error": "maxIterations must be between 1 and 100"
}{
"error": "invalid URL format"
}{
"error": "task is required"
}