POST/v1/automation/run-research

Run research

Execute a source-backed research report with SSE streaming. Returns a comprehensive report with citations from web sources. Supports standard, deep, and max research modes.

TinyFish·$0 per call

Example code

// Using @orth/sdk - The simplest way to call APIs
// Install: npm install @orth/sdk
import Orthogonal from "@orth/sdk";

const orthogonal = new Orthogonal({
  apiKey: process.env.ORTHOGONAL_API_KEY,
});

const output = await orthogonal.run({
  api: "tinyfish/agent",
  path: "/v1/automation/run-research",
  body: {
    "query": "example"
  }
});

console.log(output);

Body parameters

queryrequired

string

Research question

mode

string

Depth: standard, deep (default), or max (enables browser agents)

stream

boolean

Emit report text through synthesis_delta events as written

output_language

string

BCP 47 language tag for the report (e.g. en, es, ja)

browser_enabled

boolean

Max mode only. Defaults true in max mode.

weak_sources_enabled

boolean

Allow relevant social and community sources

domain_type

string

Source pool to research over

after_date

string

Include results on or after this date (YYYY-MM-DD)

before_date

string

Include results on or before this date (YYYY-MM-DD)

recency_minutes

integer

Include results from the last N minutes (1-5256000)

domain_filter

object

Domain preferences with include/exclude lists (max 150 entries each)

prior_run_id

string

Seed this run with a completed report and its evidence

session_id

string

Continue a standard-mode session. Mutually exclusive with prior_run_id.