Skip to content
Get started

Agent

AI Task
client.agent.automate(AgentAutomateParams { task, data, geo_target, 4 more } body, RequestOptionsoptions?): AutomateEvent { data, event } | Stream<AutomateEvent { data, event } >
POST/automate
Research
client.agent.research(AgentResearchParams { query, fetch_timeout, mode, nocache } body, RequestOptionsoptions?): ResearchEvent { data, event } | Stream<ResearchEvent { data, event } >
POST/research
ModelsExpand Collapse
AutomateEvent { data, event }
data?: unknown

Event payload data

event?: string

The event type (e.g., start, agent:processing, complete)

ResearchEvent { data, event }
data?: unknown

Event payload data

event?: "phase" | "progress" | "complete" | "error"

The event type: phase, progress, complete, or error

Accepts one of the following:
"phase"
"progress"
"complete"
"error"