Skip to main content
The Workflows API enables templated, reproducible research designed for automation. Unlike the conversational Research Agent, Workflows uses parameterized templates that produce consistent outputs across executions.

​
Workflows vs Research Agent

​
Core Concepts

​
Templates

Templates are reusable research specifications that define:
  • Prompt: The research question with Jinja2 placeholders (e.g., {{ company_id }})
  • Expected inputs: Typed parameters the template requires
  • Content filters: Optional restrictions on which sources to search
  • Research plan: Optional predefined steps for structured execution
  • Expected output: Optional report template describing the final answer’s structure, tone, and format

​
Research Plan Behavior

The Workflows API behavior is controlled by the presence of a research_plan:
  • Without a plan: The agent dynamically determines research steps based on your prompt.
  • With a plan: The agent follows your predefined steps for structured, predictable output.

​
Input Types

Templates support two input types:
  • rp_entity_id: A Bigdata entity ID (e.g., company identifier like D8442A)
  • string: Free-form text input

Quickstart Guide

Get started with your first workflow execution

Running a Workflow

Submit a run that outlives your connection, then read, watch, or cancel it

Creating Templates

Learn how to build effective templates

Research Plans

Learn how research plans affect execution

Community Templates

Discover and clone shared templates

​
Running a workflow: synchronous or asynchronous

A workflow can stream its result on the connection that started it, or run independently of that connection.
  • POST /v1/workflow/execute streams the whole run back on the same HTTP response. Closing the connection cancels the run.
  • POST /v1/workflow/execute/async returns an execution_id immediately and the run continues on its own. Its result is always stored, you can attach to its event stream at any point, and disconnecting never stops it.
Use the asynchronous endpoint for production integrations. See Running a workflow.

​
API Endpoints

The Workflows API provides the following endpoints:

​
Available Models

Select the model that best fits your use case:

​
Time Range Options

Control the time range of research data: Rolling time ranges:
  • last_24_hours
  • last_7_days
  • last_30_days
  • last_60_days
  • last_90_days
  • last_180_days
  • last_365_days
Custom date range:

​
Streaming Response

The Workflows API returns responses via Server-Sent Events (SSE). Each event wraps a typed payload in a delta field. The most common message types:
This list is abbreviated. For every public message type — including LLM_RETRY, TOOL_ERROR, and STRUCTURED_OUTPUT — their field schemas, when each fires, and a copy-paste Python handler, see Streaming responses.