API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Agent

AI Task

agent.automate(AgentAutomateParams**kwargs) -> AutomateEvent

POST/automate

Research

agent.research(AgentResearchParams**kwargs) -> ResearchEvent

POST/research

ModelsExpand Collapse

class AutomateEvent: …

data: Optional[object]

Event payload data

event: Optional[str]

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

class ResearchEvent: …

data: Optional[object]

Event payload data

event: Optional[Literal["phase", "progress", "complete", "error"]]

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

Accepts one of the following:

"phase"

"progress"

"complete"

"error"