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

FeatureResearch AgentWorkflows API
Interaction styleAd-hoc natural language queriesTemplated, reproducible research
ExecutionSingle executionReusable templates
State managementConversational (chatId)Parameterized (template + inputs)
Best forExploration and discoveryAutomation and production
Research planDynamic, agent-determinedOptional predefined steps

​
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

​
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

Creating Templates

Learn how to build effective templates

Research Plans

Learn how research plans affect execution

Community Templates

Discover and clone shared templates

​
API Endpoints

The Workflows API provides the following endpoints:
EndpointMethodDescription
/v1/workflow/executePOSTExecute a workflow with inline or stored template
/v1/workflow/templatesGETList your templates
/v1/workflow/templatesPOSTCreate a new template
/v1/workflow/templates/{id}GETGet a specific template
/v1/workflow/templates/{id}PUTUpdate a template
/v1/workflow/templates/{id}DELETEDelete a template
/v1/workflow/templates/communityGETBrowse community templates
/v1/workflow/templates/{id}/clonePOSTClone a template to your account

​
Available Models

Select the model that best fits your use case:
ModelDescription
baseDefault model, balanced performance
proEnhanced reasoning capabilities

​
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: 
{
  "start": "2024-01-01T00:00:00Z",
  "end": "2024-12-31T23:59:59Z"
}

​
Streaming Response

The Workflows API returns responses via Server-Sent Events (SSE). Each event contains a delta with one of these message types:
TypeDescription
THINKINGAgent’s reasoning process
PLANNINGResearch plan with steps
ACTIONTool being called
ANSWERFinal response content
GROUNDINGSource references
AUDITSearch results and traces
COMPLETEExecution finished with usage stats
ERRORError occurred