```
__ __ ____ ___ __ _
/ / / /__ / / /___ / | ____ ____ ____ / /_(_)________ _
/ /_/ / _ \/ / / __ \ / /| |/ __ `/ _ \/ __ \/ __/ / ___/ __ `/
/ __ / __/ / / /_/ / / ___ / /_/ / __/ / / / /_/ / /__/ /_/ /
/_/ /_/\___/_/_/\____( ) /_/ |_\__, /\___/_/ /_/\__/_/\___/\__,_/
|/ /____/
```
```
__ __ ____ ___ __ _
/ / / /__ / / /___ / | ____ ____ ____ / /_(_)________ _
/ /_/ / _ \/ / / __ \ / /| |/ __ `/ _ \/ __ \/ __/ / ___/ __ `/
/ __ / __/ / / /_/ / / ___ / /_/ / __/ / / / /_/ / /__/ /_/ /
/_/ /_/\___/_/_/\____( ) /_/ |_\__, /\___/_/ /_/\__/_/\___/\__,_/
|/ /____/
```
Like this? Get an agent to [make it](/concepts/agentic#art).
### How do you use the Agentica SDK?
We are depending on `markdown`, `xhtml2pdf` as external dependencies.
Additionally, `agentica.std.web` exports web-search utilities based on Exa.
* If you use `web_search` / `web_fetch` directly, you need `EXA_API_KEY`.
* This demo creates **ephemeral** Exa keys per subagent, which requires `EXA_SERVICE_API_KEY`.
```python expandable theme={null}
import asyncio
import json
import re
from dataclasses import dataclass, field
from datetime import datetime
from pathlib import Path
from typing import Literal
import markdown
from xhtml2pdf import pisa
from agentica import Agent
from agentica.logging import AgentListener
from agentica.std.caption import CaptionLogger
from agentica.std.web import ExaAdmin, ExaClient, SearchResult
type SourceType = Literal[
"primary",
"secondary",
"vendor",
"press",
"blog",
"forum",
"unknown",
]
LEAD_RESEARCHER_MODEL = "anthropic/claude-opus-4.5"
SUBAGENT_MODEL = "anthropic/claude-sonnet-4.5"
CITATION_MODEL = "openai/gpt-4.1"
```
Let's create a simple storage class that can save and load research artifacts.
```python theme={null}
STORAGE_DIR = Path("deep_research_test")
@dataclass
class Storage:
"""Centralized storage for all research artifacts."""
directory: Path = field(default=STORAGE_DIR)
_result_counts: dict[int, int] = field(default_factory=dict)
def __post_init__(self):
self.directory.mkdir(parents=True, exist_ok=True)
```
We need to be able to save and read a **plan** as a .txt file in the storage directory.
Likewise, we need to be bale to make a pdf out of the final markdown report.
```python expandable theme={null}
# Plan
def save_plan(self, plan: str) -> None:
"""Save the research plan."""
(self.directory / "plan.md").write_text(plan)
def load_plan(self) -> str:
"""Load the research plan."""
path = self.directory / "plan.md"
if not path.exists():
raise FileNotFoundError("Plan file not created yet.")
return path.read_text()
# Search Results
def save_search_result(
self,
subagent_id: int,
result: SearchResult,
lines_used: list[tuple[int, int]],
*,
query: str | None = None,
extracted_claims: list[str] | None = None,
source_type: SourceType | None = None,
source_notes: str | None = None,
) -> str:
count = self._result_counts.get(subagent_id, 0) + 1
self._result_counts[subagent_id] = count
path = self.directory / f"subagent_{subagent_id}" / f"result_{count}.json"
path.parent.mkdir(parents=True, exist_ok=True)
# Extract only the relevant lines
filtered_lines: list[str] = []
for start, end in lines_used:
filtered_lines.extend(result.content_lines[start - 1 : end])
data = {
"title": result.title,
"url": result.url,
"content_lines": filtered_lines,
"score": result.score,
# Rich artifact metadata (kept compatible with SearchResult.load()).
"saved_at": datetime.now().isoformat(),
"subagent_id": subagent_id,
"query": query,
"lines_used": lines_used,
"extracted_claims": extracted_claims or [],
"source_type": source_type,
"source_notes": source_notes,
}
path.write_text(json.dumps(data))
return str(path)
def load_search_result(self, path: str) -> SearchResult:
"""
Load a previously saved search-result artifact (JSON) and return it as a SearchResult.
Note: artifacts may include extra metadata fields, but SearchResult.load() only uses:
- title
- url
- content_lines
- score
"""
p = Path(path)
if not p.is_relative_to(self.directory):
raise ValueError(f"Path must be within {self.directory}")
return SearchResult.load(p)
def list_search_results(self) -> list[str]:
"""List all saved search result paths."""
files: list[str] = []
for subagent_dir in self.directory.glob("subagent_*"):
if not subagent_dir.is_dir():
continue
for file in subagent_dir.iterdir():
if file.suffix == ".json" and re.match(r"^result_\d+$", file.stem):
files.append(str(file))
return files
# Report
def save_report(self, md_report: str) -> str:
"""Save the final report as markdown and PDF."""
md_path = self.directory / "report.md"
pdf_path = self.directory / "report.pdf"
md_path.write_text(md_report)
try:
html = markdown.markdown(md_report, extensions=['tables'])
with pdf_path.open("wb") as pdf:
pisa.CreatePDF(html, dest=pdf)
except Exception as e:
print(f"Warning: PDF conversion failed: {e}")
return str(pdf_path)
@property
def report_path(self) -> Path:
return self.directory / "report.pdf"
def report_exists(self) -> bool:
return (self.directory / "report.md").exists()
# Summary
def summary(self) -> str:
"""Return a summary of all stored artifacts."""
lines = [
"",
"━" * 40,
f"📁 Research stored in: {self.directory.resolve()}",
"━" * 40,
]
if self.report_exists():
lines.append(f"📄 Report: {self.report_path.name}")
if (self.directory / "report.md").exists():
lines.append(f" {(self.directory / 'report.md').name}")
if (self.directory / "plan.md").exists():
lines.append("📋 Plan: plan.md")
search_results = self.list_search_results()
if search_results:
lines.append(f"🔍 Search results: {len(search_results)} files")
by_subagent: dict[str, list[str]] = {}
for path in search_results:
p = Path(path)
subagent = p.parent.name
by_subagent.setdefault(subagent, []).append(p.name)
for subagent, files in sorted(by_subagent.items()):
lines.append(f" {subagent}/: {len(files)} results")
lines.append("━" * 40)
return "\n".join(lines)
storage = Storage()
```
The lead researcher should be able to **create and run as many subagents as it deems necessary**
to work on independent tasks (with web search).
Let’s add some bonus features:
* the lead researcher should have the option to reuse a subagent with persistent context e.g. asking a subagent to redo a task that it got wrong
* subagents should **save the web search results that they use specifying what they have used** for the citation agent to review
```python expandable theme={null}
class SubAgent:
"""
A subagent with web search capabilities.
For each task, a subagent must be **created**, then **run** with `.call()`.
If a subagent needs to be reused, perhaps because it got something wrong, it
may be run **again** with a second `.call()`, persisting its history.
"""
_id: int
_exa: ExaClient | None
_agent: Agent
_initialized: bool
def __init__(self):
self._id = 0
self._exa = None
async def web_search(query: str) -> list[SearchResult]:
"""Tool: search the web for `query`. Returns a small list of SearchResult objects."""
print(f"Searching: {query}")
await self._ensure_init()
assert self._exa is not None
return await self._exa.search(query, num_results=2)
def save_search_result(
result: SearchResult,
lines_used: list[tuple[int, int]],
query: str | None = None,
extracted_claims: list[str] | None = None,
source_type: SourceType | None = None,
source_notes: str | None = None,
) -> str:
"""
Tool: save a SearchResult artifact for later citation/inspection.
Parameters
----------
result:
The SearchResult you are using.
lines_used:
1-indexed (inclusive) line ranges from result.content_lines that support your claims.
query:
The web query you used to find this result (optional but recommended).
extracted_claims:
Short bullet claims you will rely on, derived from the saved lines.
source_type:
Optional coarse label, e.g. "primary", "secondary", "vendor", "press", "blog", "forum", "unknown".
source_notes:
Optional brief notes justifying the label / quality.
Returns
-------
str:
Path to the saved JSON artifact (within the storage directory).
"""
return storage.save_search_result(
self._id,
result,
lines_used,
query=query,
extracted_claims=extracted_claims,
source_type=source_type,
source_notes=source_notes,
)
self._agent = Agent(
model=SUBAGENT_MODEL,
premise=SUBAGENT_PREMISE,
scope=dict(
web_search=web_search,
save_search_result=save_search_result,
SearchResult=SearchResult,
SubAgentReport=SubAgentReport,
SourceInfo=SourceInfo,
),
)
self._initialized = False
async def _ensure_init(self) -> None:
if self._initialized:
return
self._initialized = True
# Get agent ID from listener
await self._agent._ensure_init()
if (listener := self._agent._listener) and listener.logger.local_id:
self._id = int(listener.logger.local_id)
else:
raise ValueError("Agent listener not found")
# Create ephemeral Exa API key for this subagent
admin = ExaAdmin()
key_name = f"SubAgent_{self._id}"
api_key = await admin.create_key(key_name)
print(f"Created Exa API key for subagent {self._id}: {api_key[:4]}...{api_key[-4:]}")
self._exa = ExaClient(api_key=api_key)
async def call(self, task: str) -> 'SubAgentReport':
"""Run the subagent on a task."""
await self._ensure_init()
print(f"Running web-search subagent ({self._id})")
with CaptionLogger():
return await self._agent.call(SubAgentReport, task)
@dataclass
class SourceInfo:
"""
A single source you used in your research.
Fill this out in your SubAgentReport so the coordinator can understand:
- what URL you relied on,
- what you searched for to find it,
- what claims you are taking from it,
- and an approximate source category (primary/secondary/vendor/press/blog/forum/unknown).
"""
url: str
source_type: SourceType | None = None
query: str | None = None
extracted_claims: list[str] = field(default_factory=list)
artifact_path: str | None = None
lines_used: list[tuple[int, int]] = field(default_factory=list)
@dataclass
class SubAgentReport:
"""
Your final output for one subagent task.
Requirements:
- `content` may be paraphrased, but MUST be supported by the saved `lines_used`.
- `sources` must include one SourceInfo per source you relied on.
"""
title: str
content: str
sources: list[SourceInfo] = field(default_factory=list)
```
The citation agent should be able to list and look back through
web searches made by subagents as well as save the final report as an .md file.
```python expandable theme={null}
class CitationAgent:
"""Agent that adds citations to a research report."""
def __init__(self):
self._agent = Agent(
model=CITATION_MODEL,
premise=CITATION_PREMISE,
scope=dict(
list_search_results=storage.list_search_results,
load_search_result=storage.load_search_result,
save_report=storage.save_report,
),
)
async def call(self, md_report: str) -> None:
"""Add citations to a research report."""
print("Running citation agent")
return await self._agent.call(
None,
f"The `research_report = '{md_report[:10]}...' [truncated]` has been provided to you in the REPL.",
research_report=md_report,
)
```
Finally, let’s put it all together, making sure that
* the citation agent is **always called after the research report is generated by the lead researcher**, and
* the user has the opportunity to **ask follow-up questions** after receiving the research report.
```python expandable theme={null}
class DeepResearchSession:
"""Orchestrates a deep research session with multiple agents."""
def __init__(self):
self._lead_researcher = Agent(
model=LEAD_RESEARCHER_MODEL,
premise=LEAD_RESEARCHER_PREMISE,
scope=dict(
save_plan=storage.save_plan,
load_plan=storage.load_plan,
list_search_results=storage.list_search_results,
load_search_result=storage.load_search_result,
SubAgent=SubAgent,
SubAgentReport=SubAgentReport,
SourceInfo=SourceInfo,
SearchResult=SearchResult,
),
listener=lambda: AgentListener(CaptionLogger("Lead Researcher")),
)
self._citation_agent = CitationAgent()
async def call(self, query: str) -> str:
"""Run the deep research process."""
try:
# Research phase
report = await self._lead_researcher.call(str, query)
# Citation phase
with CaptionLogger():
await self._citation_agent.call(report)
if not storage.report_exists():
raise RuntimeError("Report was not created")
print(storage.summary())
return f"Check out the research report at {storage.report_path}. Ask me any questions!"
finally:
# Clean up ephemeral API keys
print("Pruning Exa API keys...")
deleted = await ExaAdmin().prune_keys(prefix="SubAgent_")
if deleted:
print(f"Pruned {deleted} key(s)")
```
Let's go back and define the premise prompts for all the agents.
```python expandable theme={null}
CITATION_PREMISE = """
You are a citation agent.
# Task
You must:
1. Review the research report provided to you as `research_report` line by line.
2. Identify which lines of the research report use information that could be from web search results.
3. List the web search results that were used in creating the research report.
4. For each of these lines, use the `load_search_result` function to load the web search result that was used.
5. Add a markdown citation with the URL of the web search result to the claim in the research report by modifying the `research_report` variable.
6. Once this is done, make sure the `research_report` is valid markdown - if not, change the markdown to make it valid.
7. Use the `save_report` function to save the research report to memory as a markdown file at the end.
8. Return saying you have finished.
# Rules
- Your citations MUST be consistent throughout the `research_report`.
- Any URL in the final markdown MUST be formatted as a markdown link, not a bare URL.
- You MUST use the `list_search_results` function to list the web search results that were used in creating the research report
- You MUST use the `load_search_result` function to load the web search results.
- You MUST use the `research_report` variable provided to you to modify the research report by adding citations.
- You MUST make sure the `research_report` is valid markdown.
- You MUST use the `save_report` function to save the research report to memory at the end.
- You MUST inspect the report before saving it to make sure it is valid and what you intended. Iterate until it is valid.
## Citation format
- Prefer inline citations like: `... claim ... ([source](https://example.com))`
- If multiple sources support a sentence, include multiple links: `... ([s1](...), [s2](...))`
"""
LEAD_RESEARCHER_PREMISE = """
You are a lead researcher. You have access to web-search enabled subagents.
# Task
You must:
1. Create a plan to research the user query.
2. Determine how many specialised subagents (with access to the web) are necessary, each with a different specific research task.
3. Call ALL subagents in parallel using asyncio.gather with return_exceptions=True so partial results are preserved.
4. Summarise the results of the subagents in a final research report as markdown. Use sections, sub-sections, list and formatting to make the report easy to read and understand. The formatting should be consistent and easy to follow.
5. Check the final research report, as this will be shown to the user.
6. Return the final research report using `return` at the very end.
# Rules
- Do NOT construct the final report until you have run the subagents.
- Do NOT return the final report in the REPL until planning, assigning subagents and returning the final report is complete.
- Do NOT add citations to the final research report yourself, this will be done afterwards.
- Do NOT repeat yourself in the final research report.
- You MUST raise an AgentError if you cannot complete the task with what you have available.
- You MUST check the final research report string before returning it to the user.
## Planning
- You MUST write the plan yourself.
- You MUST write the plan before assigning subagents to tasks.
- You MUST break down the task into small individual tasks.
## Subagents
- You MUST assign each small individual task to a subagent.
- For each task, YOU MUST create a **new** SubAgent, and provide it with a task via `.call()`.
- You MUST NOT assign multiple unrelated tasks to the same SubAgent.
- You should only call a SubAgent repeatedly if you feel you failed to get enough information from a single call, instructing them with what they were missing.
- You MUST instruct subagents to use the web_search and save_search_result functions if the task requires it.
- Do NOT ask subagents to cite the web, instead instruct them to use the save_search_result function.
- Subagents MUST be assigned independent tasks.
- IF after subagents have returned their findings more research is needed, you can assign more subagents to tasks.
- DO NOT try to preemptively *parse* the output of the subagents, **just look at the output yourself**.
- Subagents may fail! `asyncio.gather` will raise an exception if any of the subagents fail. Instead, you should pass `return_exceptions=True` to `asyncio.gather` to not lose the results of the successful subagents.
## Final Report
- Do NOT write the final report yourself without running subagents to do so.
- Do NOT add citations to the final research report yourself, this will be done afterwards by another agent.
- Do NOT repeat yourself in the final research report.
- Do NOT return a report with missing information, omitted fields or `N/A` values. If more work needs to be done, you must assign more subagents to tasks, or reuse the necessary subagents to extract more information.
- You MUST load the plan from memory before returning the final research report to check that you have followed the plan.
- You MUST check the final research report before returning it to the user.
- Check the final report for quality, completeness and consistency. If up to standard, return using a single `return` as the sole statement in its very own
- Your final report MUST include a short "Sources consulted" section:
- List each source URL you relied on
- Include its source_type and 1-2 extracted claims
- Any URL you include MUST be a markdown hyperlink (not a bare URL).
- Do NOT put the whole report in a table.
"""
SUBAGENT_PREMISE = """
You are a helpful assistant.
# Task
You must:
1. Construct a list of things to search for using the web_search function.
2. Execute ALL web_search calls in parallel using asyncio.gather and asyncio.run.
3. For each search result, `print()` relevant sections using SearchResult.content_with_line_numbers(start=..., end=...).
4. Identify which lines of content you are going to use in your report.
5. Use the save_search_result function to save the SearchResult to memory and include the lines of the content that you have used.
- Include the specific `query` you searched for.
- Include `extracted_claims`: a list of short claims you will rely on (derived from the saved lines).
- Include `source_type`: one of ["primary", "secondary", "vendor", "press", "blog", "forum", "unknown"].
Use your best judgment based on the URL/domain and the content.
- IMPORTANT: save_search_result returns a saved artifact path; keep it and include it in SourceInfo.artifact_path
6. Condense the search results into a single report with what you have found.
7. Return the report using `return` at the very end in a separate REPL session.
# Rules
- You MUST use `print()` to print the content of each search result by via SearchResult.content_with_line_numbers().
- You MUST use the web_search function if instructed to do so OR if the task requires finding information.
- Do NOT assume that the web_search function will return the information you need, you must go through the content of each search result line by line by combing through the content with SearchResult.content_with_line_numbers(start=, end=).
- Do NOT assume which lines of content you are going to use in your report, you must go through the content of each search result line by line via SearchResult.content_with_line_numbers(start=, end=).
- If you cannot find any information, do NOT provide information yourself, instead raise an error for the lead researcher in the REPL.
- You MUST save the SearchResult of any research that you have used to memory and include the lines of the content that you have used (are relevant).
- When saving, pass `query`, `extracted_claims`, and `source_type` to save_search_result.
- Your returned SubAgentReport MUST include `sources`: one entry per saved source, including url, source_type, query, extracted_claims, artifact_path, and lines_used.
- Return the report using `return` at the very end in a separate REPL session.
"""
```
We can now run the session with a user query!
```python theme={null}
if __name__ == "__main__":
session = DeepResearchSession()
result = asyncio.run(
session.call(
"What are all of the companies in the US working on AI agents in 2025? "
"Make a list of at least 10. For each, include the name, website and product, "
"description of what they do, type of agents they build, and their vertical/industry."
)
)
print(result)
```
View the generated report
First, import the Agentica TypeScript SDK and the Slack Web API.
```typescript theme={null}
import { agentic } from '@symbolica/agentica';
import { WebClient } from '@slack/web-api';
```
Then, initialize the Slack client with your token.
```typescript theme={null}
const SLACK_BOT_TOKEN = 'YOUR-TOKEN-HERE';
// Initialize Slack client
const slackClient = new WebClient(SLACK_BOT_TOKEN);
```
Let's create a function that sends messages over the Slack API, keeping in mind that
this is something for the agent to use.
```typescript theme={null}
/** Post message
* @param userName The name of the user to send a morning message to
*/
async function postMessage(userName: string, text: string): Promise {
await slackClient.chat.postMessage({
channel: `@${userName}`,
text: text,
});
}
```
Then, create the *agentic function* that will use the Slack API to send a message.
```typescript theme={null}
/**
* Uses the Slack API to send the user a direct message. Light and cheerful!
* @param userName The name of the user to send a morning message to
*/
async function sendMorningMessage(userName: string): Promise {
await agentic('Use the Slack API to send the user a direct message. Light and cheerful!', {
postMessage,
userName,
});
}
```
Finally, invoke this function to send a message to the user.
```typescript theme={null}
// Execute the function
void sendMorningMessage('John Smith');
```
First, let's set up a backend that can stream partial translations per language.
```typescript theme={null}
import { Agent, spawn } from '@symbolica/agentica';
```
Define a `Translator` that encapsulates a single agent and exposes a streaming callback.
```typescript theme={null}
/**
* Represents a single language translator agent
*/
export class Translator {
id: string;
language: string;
private agent: Agent | null = null;
onProgress?: (chunk: string) => void;
constructor(id: string, language: string) {
this.id = id;
this.language = language;
}
```
Initialize the underlying agent with a strict output-only system prompt.
```typescript theme={null}
async initialize(): Promise {
this.agent = await spawn({
system: `You are an expert ${this.language} translator.
Your task is to provide a single best translation of the user's text into ${this.language}.
STRICT RULES:
- Return ONLY the best-effort translated text.
- Do NOT add explanations, notes, or any extra words.
- Do NOT mention dialects or alternatives.
- Do NOT ask clarifying questions.
- Do NOT use any English, or any other language other than the requested target language in your response.
- Be natural and idiomatic, but concise.
- Preserve meaning precisely as best you can without adding ANY context.`,
model: 'openai/gpt-4.1',
});
}
```
Stream the translation via the agent listener and post-process the final result for consistency.
````typescript expandable theme={null}
async translate(text: string): Promise {
if (!this.agent) {
throw new Error(`Translator ${this.id} not initialized`);
}
// Use local variable so transformer can handle it
const agent = this.agent;
let result: string = await agent.call(
`Translate the text into "${this.language}". Respond with ONLY the best-effort translated text with NO additional context.\n\n${text}`,
{
text,
language: this.language,
},
{
listener: (iid: string, chunk: { content?: string; role?: string }) => {
// Only forward agent-generated content, not system/user messages
if (this.onProgress && chunk && chunk.content && chunk.role === 'agent') {
this.onProgress(chunk.content);
}
},
}
);
// Post-process to enforce strict output
result = (result ?? '').trim();
// Strip code fences and labels like "Translation:" or language prefixes
result = result
.replace(/^```[a-z]*\n([\s\S]*?)\n```$/i, '$1')
.replace(/^\s*(translation\s*:\s*)/i, '')
.replace(new RegExp(`^\s*(${this.language})\s*:\s*`, 'i'), '')
.trim();
// Remove surrounding quotes if model added them
if ((result.startsWith('"') && result.endsWith('"')) || (result.startsWith("'") && result.endsWith("'"))) {
result = result.slice(1, -1).trim();
}
return result;
}
````
Finally, a way to tidy up the agent resource when done.
```typescript theme={null}
async close(): Promise {
if (this.agent) {
await this.agent.close();
}
}
}
```
Now, let's define the way to
coordinate many translators in parallel with a `TranslationManager` and UI callbacks.
```typescript theme={null}
/**
* Coordinates multiple translator agents working in parallel
*/
export class TranslationManager {
private translators: Map = new Map();
// Callbacks for UI updates
onTranslatorSpawned?: (id: string, language: string) => void;
onTranslatorProgress?: (id: string, chunk: string) => void;
onTranslatorComplete?: (id: string, translation: string) => void;
```
Let's implement the `translateToMany` method on this class.
It consists of two phases:
Phase 1: Initialize all translators concurrently and register streaming.
```typescript expandable theme={null}
async translateToMany(text: string, languages: string[]): Promise> {
// Phase 1: Create and initialize all translators in parallel
const initPromises = languages.map(async (language, index) => {
const id = `translator_${index}`;
const translator = new Translator(id, language);
// Set up progress callback
translator.onProgress = (chunk: string) => {
this.onTranslatorProgress?.(id, chunk);
};
// Initialize the translator
await translator.initialize();
this.translators.set(id, translator);
// Notify UI that translator was spawned
this.onTranslatorSpawned?.(id, language);
return { id, language, translator };
});
const translators = await Promise.all(initPromises);
```
Phase 2: Run all translations in parallel, notify completion, and aggregate results.
```typescript expandable theme={null}
// Phase 2: Run all translations in parallel (don't await here!)
const translationPromises = translators.map(({ id, language, translator }) => {
return (async () => {
const finalTranslation = await translator.translate(text);
// Notify completion
this.onTranslatorComplete?.(id, finalTranslation);
return { language, translation: finalTranslation };
})();
});
// Wait for all translations to complete
const results = await Promise.all(translationPromises);
// Convert to map for easy lookup
const translations = new Map();
for (const { language, translation } of results) {
translations.set(language, translation);
}
return translations;
}
```
Finally, the `close` method to close and clear all translators when leaving the session.
```typescript theme={null}
async close(): Promise {
// Close all translators
for (const translator of this.translators.values()) {
await translator.close();
}
this.translators.clear();
}
// [end of TranslationManager]
}
```
Let's start with a minimal Ink app shell and the dependencies.
```typescript theme={null}
import { Box, Text, render, useApp, useInput } from 'ink';
import TextInput from 'ink-text-input';
import React, { useEffect, useMemo, useState } from 'react';
import { TranslationManager } from './backend.js';
```
Define a list of built-in languages and emoji labels and
represent in-flight translator state for the UI.
```typescript expandable theme={null}
const languageEmojis: Record = {
Spanish: '🇪🇸',
French: '🇫🇷',
German: '🇩🇪',
Japanese: '🇯🇵',
Italian: '🇮🇹',
Portuguese: '🇵🇹',
Korean: '🇰🇷',
Chinese: '🇨🇳',
};
const AVAILABLE_LANGUAGES = [
'Spanish', 'French', 'German', 'Japanese',
'Italian', 'Portuguese', 'Korean', 'Chinese'
] as const;
type Language = typeof AVAILABLE_LANGUAGES[number];
interface TranslatorState {
language: string; // allow custom languages
chunks: string[];
complete: boolean;
}
interface TranslationViewProps {
text: string;
languages: string[]; // may include custom user-provided languages
onNextPhrase?: (text: string) => void;
}
```
Build the `TranslationView` that wires manager callbacks to live UI updates.
```typescript expandable theme={null}
const TranslationView: React.FC = ({ text, languages, onNextPhrase }) => {
const [translatorStates, setTranslatorStates] = useState>(new Map());
const [isComplete, setIsComplete] = useState(false);
const [manager] = useState(() => new TranslationManager());
const [nextPhrase, setNextPhrase] = useState('');
const { exit } = useApp();
useEffect(() => {
manager.onTranslatorSpawned = (id: string, language: string) => {
setTranslatorStates((prev: Map) => {
const newMap = new Map(prev);
newMap.set(id, { language, chunks: [], complete: false });
return newMap;
});
};
manager.onTranslatorProgress = (id: string, chunk: string) => {
setTranslatorStates((prev: Map) => {
const newMap = new Map(prev);
const state = newMap.get(id);
if (state) {
state.chunks.push(chunk);
newMap.set(id, { ...state });
}
return newMap;
});
};
manager.onTranslatorComplete = (id: string) => {
setTranslatorStates((prev: Map) => {
const newMap = new Map(prev);
const state = newMap.get(id);
if (state) {
state.complete = true;
newMap.set(id, { ...state });
}
return newMap;
});
};
// Reset state and start the translation
const runTranslation = async () => {
setTranslatorStates(new Map());
setIsComplete(false);
const results = await manager.translateToMany(text, languages);
setIsComplete(true);
};
runTranslation().catch(console.error);
// Cleanup
return () => {
manager.close().catch(console.error);
};
}, [text, languages, manager]);
const completedCount = Array.from(translatorStates.values()).filter((s: TranslatorState) => s.complete).length;
const totalCount = translatorStates.size;
// Allow Esc to exit while on the translation screen as well
useInput((input, key) => {
if (key.escape) {
// Try to close agents, then force exit regardless
manager.close().catch(() => {}).finally(() => {
exit();
setTimeout(() => (globalThis as any).process?.exit(0), 10);
});
}
});
```
Finally, let's render the dashboard, live translations, and a follow-up input box by returning the appropriate JSX UI.
```typescript expandable theme={null}
return (
{/* Header */}
🌍 ✨ Multi-Language Translation Dashboard ✨ 🌍
{/* Input Section */}
📝 SOURCE TEXT
"{text}"
🎯 TARGET LANGUAGES:
{languages.join(' • ')}
{/* Progress Bar */}
{totalCount > 0 && (
⚡ Progress:
{completedCount}/{totalCount} completed
{isComplete && 🎉 }
)}
{/* Translations Section */}
🔄 LIVE TRANSLATIONS
{Array.from<[string, TranslatorState]>(translatorStates.entries()).map(([id, state]: [string, TranslatorState]) => {
const emoji = languageEmojis[state.language] || '🌐';
const translationText = state.chunks.join('');
return (
{emoji} {state.language}
{state.complete && ✓ }
{!state.complete && ⟳ }
{translationText || '...'}
{!state.complete && ▊ }
);
})}
{/* Next input box under translations */}
📝 Enter next text to translate:
›
{
const trimmed = nextPhrase.trim();
if (trimmed) {
onNextPhrase?.(trimmed);
setNextPhrase('');
}
}}
placeholder={isComplete ? 'Type your next text here...' : 'Wait until current translation completes...'}
/>
Press Enter to start translation; Esc to exit.
{!isComplete && (
Current translation in progress...
)}
);
};
```
Compose the outer app for language selection, text entry, and running the translation step.
```typescript expandable theme={null}
type Step = 'select' | 'input' | 'translate';
const App: React.FC = () => {
const [inputText, setInputText] = useState('');
const [selectedLanguages, setSelectedLanguages] = useState>(new Set());
const [currentStep, setCurrentStep] = useState('select');
const [cursorIndex, setCursorIndex] = useState(0);
const [additionalLanguagesText, setAdditionalLanguagesText] = useState('');
const [selectFocusIndex, setSelectFocusIndex] = useState<0 | 1>(0); // select step: 0 = list, 1 = additional input
const { exit } = useApp();
useInput((input, key) => {
if (currentStep === 'select') {
if (input === '\t') {
setSelectFocusIndex(prev => (prev === 0 ? 1 : 0));
return;
}
if (selectFocusIndex === 0 && key.upArrow) {
setCursorIndex(prev => Math.max(0, prev - 1));
return;
}
if (selectFocusIndex === 0 && key.downArrow) {
if (cursorIndex === AVAILABLE_LANGUAGES.length - 1) {
setSelectFocusIndex(1);
} else {
setCursorIndex(prev => Math.min(AVAILABLE_LANGUAGES.length - 1, prev + 1));
}
return;
}
if (selectFocusIndex === 1 && key.upArrow) {
setSelectFocusIndex(0);
return;
}
if (selectFocusIndex === 0 && input === ' ') {
const lang = AVAILABLE_LANGUAGES[cursorIndex];
if (lang === undefined) return;
setSelectedLanguages(prev => {
const newSet = new Set(prev);
if (newSet.has(lang)) {
newSet.delete(lang);
} else {
newSet.add(lang);
}
return newSet;
});
return;
}
if (key.return && selectedLanguages.size > 0) {
setCurrentStep('input');
return;
}
} else if (currentStep === 'input') {
if (key.escape) {
exit();
setTimeout(() => (globalThis as any).process?.exit(0), 10);
return;
}
}
});
const extraLanguages = useMemo(() => (
additionalLanguagesText
.split(',')
.map(s => s.trim())
.filter(Boolean)
), [additionalLanguagesText]);
const combinedLanguages: string[] = useMemo(() => ([
...Array.from(selectedLanguages),
...extraLanguages,
]), [selectedLanguages, extraLanguages]);
if (currentStep === 'translate') {
return (
{
setInputText(text);
}}
/>
);
}
return (
{/* Header */}
🌍 ✨ Multi-Language Translation Setup ✨ 🌍
{currentStep === 'select' && (
🎯 Select target languages:
{AVAILABLE_LANGUAGES.map((lang, index) => {
const isSelected = selectedLanguages.has(lang);
const isCursor = index === cursorIndex;
const emoji = languageEmojis[lang] || '🌐';
return (
{isCursor ? '→ ' : ' '}
[{isSelected ? '✓' : ' '}] {emoji} {lang}
);
})}
➕ Additional languages (optional)
›
{
if (selectedLanguages.size > 0) {
setCurrentStep('input');
}
}}
placeholder="Klingon, Sami"
focus={selectFocusIndex === 1}
/>
↑↓ Navigate • Space Select • Tab Focus input • Enter Continue
Selected: {selectedLanguages.size} language{selectedLanguages.size !== 1 ? 's' : ''}
)}
{currentStep === 'input' && (
📝 Enter text to translate:
›
{
if (inputText.trim()) {
setCurrentStep('translate');
}
}}
placeholder="Type your text here..."
/>
Press Enter to start translation; Esc to exit.
)}
);
};
```
Finally, let's run the application by rendering the `
We are depending on `md-to-pdf` as an external dependency.
Additionally, `@symbolica/agentica/std/web` exports web-search utilities based on Exa.
* If you use `webSearch` / `webFetch` directly, you need `EXA_API_KEY`.
* This demo creates **ephemeral** Exa keys per subagent, which requires `EXA_SERVICE_API_KEY`.
```typescript theme={null}
import * as fs from 'fs';
import * as path from 'path';
import { randomUUID } from 'crypto';
import { Agent, spawn } from '@symbolica/agentica';
import { ExaAdmin, ExaClient, SearchResult } from '@symbolica/agentica/std/web';
import { mdToPdf } from 'md-to-pdf';
import { exit } from 'process';
```
Let's create a simple storage class that can save and load research artifacts.
```typescript theme={null}
const STORAGE_DIR = 'deep_research_test';
/**
* Centralized storage for all research artifacts.
*/
class Storage {
private readonly directory = STORAGE_DIR;
private resultCounts: Map = new Map();
constructor() {
fs.mkdirSync(this.directory, { recursive: true });
}
```
We need to be able to save and read a **plan** as a .txt file in the storage directory.
Likewise, we need to be able to make a pdf out of the final markdown report.
```typescript expandable theme={null}
// Plan
/**
* Save the research plan.
*/
savePlan(plan: string): void {
fs.writeFileSync(path.join(this.directory, 'plan.md'), plan);
console.log(`[storage] saved plan.md (${plan.length} chars)`);
}
/**
* Load the research plan.
*/
loadPlan(): string {
const planPath = path.join(this.directory, 'plan.md');
if (!fs.existsSync(planPath)) {
throw new Error('Plan file not created yet.');
}
return fs.readFileSync(planPath, 'utf-8');
}
// Search Results
/**
* Tool storage: persist the *used* slices of a SearchResult as a JSON artifact.
*
* The returned file is later consumed by the citation agent via `loadSearchResult()`.
*
* - `linesUsed` is 1-indexed inclusive ranges into `result.contentLines`.
* - `meta` is optional but helps trace provenance (query, claims, source quality).
*/
saveSearchResult(
subagentId: number,
result: SearchResult,
linesUsed: Array<[number, number]>,
meta?: {
// With `exactOptionalPropertyTypes`, passing `{ query: undefined }` is not
// assignable to `{ query?: string }`. Allow explicit `undefined` so
// subagents can pass optional args positionally without extra boilerplate.
query?: string | undefined;
extractedClaims?: string[] | undefined;
sourceType?: SourceType | undefined;
sourceNotes?: string | undefined;
}
): string {
const count = (this.resultCounts.get(subagentId) ?? 0) + 1;
this.resultCounts.set(subagentId, count);
const subagentDir = path.join(this.directory, `subagent_${subagentId}`);
fs.mkdirSync(subagentDir, { recursive: true });
const filePath = path.join(subagentDir, `result_${count}.json`);
// Extract only the relevant lines
const filteredLines: string[] = [];
for (const [start, end] of linesUsed) {
filteredLines.push(...result.contentLines.slice(start - 1, end));
}
const data = {
title: result.title,
url: result.url,
content_lines: filteredLines,
score: result.score,
// Rich artifact metadata (kept compatible with SearchResult.fromJSON/load in citation flows).
saved_at: new Date().toISOString(),
subagent_id: subagentId,
query: meta?.query ?? null,
lines_used: linesUsed,
extractedClaims: meta?.extractedClaims ?? [],
sourceType: meta?.sourceType ?? null,
sourceNotes: meta?.sourceNotes ?? null,
};
fs.writeFileSync(filePath, JSON.stringify(data));
console.log(`[storage] saved search artifact: ${filePath} (${result.url})`);
return filePath;
}
loadSearchResult(filePath: string): SearchResult {
/**
* Load a previously saved JSON artifact and return it as a SearchResult.
*
* Note: artifacts may include extra metadata fields, but the SearchResult
* payload is reconstructed from the core fields.
*/
const resolvedPath = path.resolve(filePath);
if (!resolvedPath.startsWith(path.resolve(this.directory))) {
throw new Error(`Path must be within ${this.directory}`);
}
const data = JSON.parse(fs.readFileSync(filePath, 'utf-8'));
return new SearchResult({
title: data.title,
url: data.url,
contentLines: data.content_lines,
score: data.score,
});
}
/**
* List all saved search result paths.
*/
listSearchResults(): string[] {
const files: string[] = [];
const entries = fs.readdirSync(this.directory, { withFileTypes: true });
for (const entry of entries) {
if (entry.isDirectory() && entry.name.startsWith('subagent_')) {
const subagentDir = path.join(this.directory, entry.name);
const subFiles = fs.readdirSync(subagentDir);
for (const file of subFiles) {
if (file.endsWith('.json') && /^result_\d+\.json$/.test(file)) {
files.push(path.join(subagentDir, file));
}
}
}
}
return files;
}
// Report
/**
* Save the final report as markdown and PDF.
*/
async saveReport(mdReport: string): Promise {
const mdPath = path.join(this.directory, 'report.md');
const pdfPath = path.join(this.directory, 'report.pdf');
fs.writeFileSync(mdPath, mdReport);
console.log(`[storage] saved report.md (${mdReport.length} chars)`);
try {
const pdf = await mdToPdf({ content: mdReport });
if (pdf.content) {
fs.writeFileSync(pdfPath, pdf.content);
console.log(`[storage] saved report.pdf (${pdf.content.length} bytes)`);
}
} catch (e) {
console.warn(`Warning: PDF conversion failed: ${e}`);
}
return pdfPath;
}
get reportPath(): string {
return path.join(this.directory, 'report.pdf');
}
reportExists(): boolean {
return fs.existsSync(path.join(this.directory, 'report.md'));
}
// Summary
/**
* Return a summary of all stored artifacts.
*/
summary(): string {
const lines = [
'',
'━'.repeat(40),
`📁 Research stored in: ${path.resolve(this.directory)}`,
'━'.repeat(40),
];
if (this.reportExists()) {
lines.push(`📄 Report: report.pdf`);
lines.push(` report.md`);
}
if (fs.existsSync(path.join(this.directory, 'plan.md'))) {
lines.push('📋 Plan: plan.md');
}
const searchResults = this.listSearchResults();
if (searchResults.length > 0) {
lines.push(`🔍 Search results: ${searchResults.length} files`);
const bySubagent: Map = new Map();
for (const filePath of searchResults) {
const subagent = path.basename(path.dirname(filePath));
if (!bySubagent.has(subagent)) bySubagent.set(subagent, []);
bySubagent.get(subagent)!.push(path.basename(filePath));
}
for (const [subagent, files] of [...bySubagent.entries()].sort()) {
lines.push(` ${subagent}/: ${files.length} results`);
}
}
lines.push('━'.repeat(40));
return lines.join('\n');
}
}
const storage = new Storage();
```
The lead researcher should be able to **create and run as many subagents as it deems necessary**
to work on independent tasks (with web search).
Let's add some bonus features:
* the lead researcher should have the option to reuse a subagent with persistent context e.g. asking a subagent to redo a task that it got wrong
* subagents should **save the web search results that they use specifying what they have used** for the citation agent to review
```typescript expandable theme={null}
/**
* The title, relevant URLs and relevant content from one search session.
* The content can be paraphrased or summarised, but
* - MUST be consistent with the original content from; and
* - MUST be derived from the **lines used** in the search result.
*/
interface SubAgentReport {
/**
* Structured output of a web-search subagent.
*
* `sources` is intended for the lead agent to quickly inspect provenance/quality
* without reloading artifacts.
*/
title: string;
content: string;
sources: Array<{
/** Source URL. */
url: string;
/** Coarse source label (primary/secondary/vendor/press/blog/forum/unknown). */
sourceType?: SourceType;
/** Query used to discover this source (if provided). */
query?: string;
/** Short claims derived from the cited lines that the subagent relied on. */
extractedClaims: string[];
/** Saved artifact path (within storage directory). */
artifactPath?: string;
/** 1-indexed inclusive line ranges into the saved artifact's content. */
linesUsed?: Array<[number, number]>;
}>;
}
let subagentCounter = 0;
/**
* A subagent with web search capabilities.
* For each task, a subagent must be **created**, then **run** with `.call()`.
* If a subagent needs to be reused, perhaps because it got something wrong, it
* may be run **again** with a second `.call()`, persisting its history.
*/
class SubAgent {
private id: number = 0;
private exa: ExaClient | null = null;
private agent: Agent | null = null;
private initialized = false;
async ensureInit(): Promise {
if (this.initialized) return;
this.initialized = true;
this.id = ++subagentCounter;
console.log(`[subagent ${this.id}] initializing`);
// Create ephemeral Exa API key for this subagent
const admin = new ExaAdmin();
const keyName = `SubAgent_${this.id}_${randomUUID()}`;
const apiKey = await admin.createKey(keyName);
console.log(`Created Exa API key for subagent ${this.id}: ${apiKey.slice(0, 4)}...${apiKey.slice(-4)}`);
this.exa = new ExaClient({ apiKey });
// Create scope with web search functions
/**
* Tool: search the web for `query`. Returns a small list of SearchResult objects.
*/
const webSearch = async (query: string): Promise => {
console.log(`Searching: ${query}`);
return await this.exa!.search(query, { numResults: 2 });
};
/**
* Tool: save a SearchResult artifact for later citation/inspection.
*
* - `linesUsed`: 1-indexed inclusive ranges into `result.contentLines`
* - `query` / `extractedClaims` / `sourceType` are optional provenance/quality metadata
*
* Returns the file path of the saved artifact.
*/
const saveSearchResult = (
result: SearchResult,
linesUsed: Array<[number, number]>,
query?: string,
extractedClaims?: string[],
sourceType?: SourceType,
sourceNotes?: string
): string => {
return storage.saveSearchResult(this.id, result, linesUsed, { query, extractedClaims, sourceType, sourceNotes });
};
this.agent = await spawn(
{
model: SUBAGENT_MODEL,
premise: SUBAGENT_PREMISE,
},
{
webSearch,
saveSearchResult,
SearchResult,
}
);
console.log(`[subagent ${this.id}] ready`);
}
/**
* Run the subagent on a task.
*/
async call(task: string): Promise {
await this.ensureInit();
console.log(`Running web-search subagent (${this.id})`);
const result = await this.agent!.call(task);
console.log(`[subagent ${this.id}] finished: ${JSON.stringify(result.title)}`);
return result;
}
}
/**
* Get a web-search enabled subagent to run a task for you.
* @param task - The task assigned to the subagent.
* @returns The report from the subagent.
*/
async function runSubAgent(task: string): Promise {
const subAgent = new SubAgent();
return await subAgent.call(task);
}
```
The citation agent should be able to list and look back through
web searches made by subagents as well as save the final report as an .md file.
```typescript expandable theme={null}
/**
* Agent that adds citations to a research report.
*/
class CitationAgent {
private agent: Agent | null = null;
private initialized = false;
async ensureInit(): Promise {
if (this.initialized) return;
this.initialized = true;
this.agent = await spawn(
{
model: CITATION_MODEL,
premise: CITATION_PREMISE,
},
{
/** Tool: list all saved search-result artifact paths. */
listSearchResults: () => storage.listSearchResults(),
/** Tool: load a saved search-result artifact and return a SearchResult. */
loadSearchResult: (p: string) => storage.loadSearchResult(p),
/** Tool: persist the final report (md + pdf). */
saveReport: (md: string) => storage.saveReport(md),
}
);
}
/**
* Add citations to a research report.
*/
async call(mdReport: string): Promise {
console.log('Running citation agent');
await this.ensureInit();
console.log(`[citation] adding citations to report (${mdReport.length} chars)`);
await this.agent!.call(
`The \`research_report = ${mdReport.slice(0, 10)}...[truncated]\` has been provided to you in the REPL.`,
{ research_report: mdReport }
);
console.log('[citation] done');
}
}
```
Finally, let's put it all together, making sure that
* the citation agent is **always called after the research report is generated by the lead researcher**, and
* the user has the opportunity to **ask follow-up questions** after receiving the research report.
```typescript expandable theme={null}
/**
* Orchestrates a deep research session with multiple agents.
*/
class DeepResearchSession {
private leadResearcher: Agent | null = null;
private citationAgent = new CitationAgent();
private initialized = false;
private async ensureInit(): Promise {
if (this.initialized) return;
this.initialized = true;
console.log('[session] initializing lead researcher');
this.leadResearcher = await spawn(
{
model: LEAD_RESEARCHER_MODEL,
premise: LEAD_RESEARCHER_PREMISE,
},
{
savePlan: (plan: string) => storage.savePlan(plan),
loadPlan: () => storage.loadPlan(),
listSearchResults: () => storage.listSearchResults(),
loadSearchResult: (p: string) => storage.loadSearchResult(p),
runSubAgent,
}
);
console.log('[session] lead researcher ready');
await this.citationAgent.ensureInit();
console.log('[session] citation agent ready');
}
/**
* Run the deep research process.
*/
async call(query: string): Promise {
await this.ensureInit();
try {
console.log(`[session] starting research: ${JSON.stringify(query.slice(0, 120))}${query.length > 120 ? '…' : ''}`);
// Research phase
const report = await this.leadResearcher!.call(query);
console.log(`[session] research draft ready (${report.length} chars)`);
// Citation phase
await this.citationAgent.call(report);
if (!storage.reportExists()) {
throw new Error('Report was not created');
}
console.log(storage.summary());
return `Check out the research report at ${storage.reportPath}. Ask me any questions!`;
} finally {
// Clean up ephemeral API keys
console.log('Pruning Exa API keys...');
const deleted = await new ExaAdmin().pruneKeys('SubAgent_');
if (deleted > 0) {
console.log(`Pruned ${deleted} key(s)`);
}
console.log('[session] done');
}
}
}
```
Let's go back and define the premise prompts for all the agents.
```typescript expandable theme={null}
type SourceType = 'primary' | 'secondary' | 'vendor' | 'press' | 'blog' | 'forum' | 'unknown';
const LEAD_RESEARCHER_MODEL = 'anthropic/claude-opus-4.5';
const SUBAGENT_MODEL = 'anthropic/claude-sonnet-4.5';
const CITATION_MODEL = 'openai/gpt-4.1';
const CITATION_PREMISE = `
You are a citation agent.
# Task
You must:
1. Review the research report provided to you as \`research_report\` line by line.
2. Identify which lines of the research report use information that could be from web search results.
3. List the web search results that were used in creating the research report.
4. For each of these lines, use the \`loadSearchResult\` function to load the web search result that was used.
5. Add a markdown citation with the URL of the web search result to the claim in the research report by modifying the \`research_report\` variable.
6. Once this is done, make sure the \`research_report\` is valid markdown - if not, change the markdown to make it valid.
7. Use the \`saveReport\` function to save the research report to memory as a markdown file at the end.
8. Return saying you have finished.
# Rules
- Your citations MUST be consistent throughout the \`research_report\`.
- Any URL in the final markdown MUST be formatted as a markdown link, not a bare URL.
- You MUST use the \`listSearchResults\` function to list the web search results that were used in creating the research report
- You MUST use the \`loadSearchResult\` function to load the web search results.
- You MUST use the \`research_report\` variable provided to you to modify the research report by adding citations.
- You MUST make sure the \`research_report\` is valid markdown.
- You MUST use the \`saveReport\` function to save the research report to memory at the end.
- You MUST inspect the report before saving it to make sure it is valid and what you intended. Iterate until it is valid.
## Citation format
- Prefer inline citations like: \`... claim ... ([source](https://example.com))\`
- If multiple sources support a sentence, include multiple links: \`... ([s1](...), [s2](...))\`
`;
const LEAD_RESEARCHER_PREMISE = `
You are a lead researcher. You have access to web-search enabled subagents.
# Task
You must:
1. Create a plan to research the user query.
2. Determine how many specialised subagents (with access to the web) are necessary, each with a different specific research task.
3. Call ALL subagents in parallel. In the Python REPL, use \`asyncio.gather(..., return_exceptions=True)\` so partial results are preserved.
4. Summarise the results of the subagents in a final research report as markdown. Use sections, sub-sections, list and formatting to make the report easy to read and understand. The formatting should be consistent and easy to follow.
5. Check the final research report, as this will be shown to the user.
6. Return the final research report using \`return\` at the very end.
# Rules
- Do NOT construct the final report until you have run the subagents.
- Do NOT return the final report in the REPL until planning, assigning subagents and returning the final report is complete.
- Do NOT add citations to the final research report yourself, this will be done afterwards.
- Do NOT repeat yourself in the final research report.
- You MUST raise an Error if you cannot complete the task with what you have available.
- You MUST check the final research report string before returning it to the user.
## Planning
- You MUST write the plan yourself.
- You MUST write the plan before assigning subagents to tasks.
- You MUST break down the task into small individual tasks.
## Subagents
- You MUST assign each small individual task to a subagent.
- You MUST NOT assign multiple unrelated tasks to the same subagent.
- You MUST instruct subagents to use the webSearch and saveSearchResult functions if the task requires it.
- Do NOT ask subagents to cite the web, instead instruct them to use the saveSearchResult function.
- Subagents MUST be assigned independent tasks.
- IF after subagents have returned their findings more research is needed, you can assign more subagents to tasks.
- DO NOT try to pre-emptively *parse* the output of the subagents, **just look at the output yourself**.
- Subagents may fail! In the Python REPL, use \`asyncio.gather(..., return_exceptions=True)\` to not lose successful results.
## Final Report
- Do NOT write the final report yourself without running subagents to do so.
- Do NOT add citations to the final research report yourself, this will be done afterwards by another agent.
- Do NOT repeat yourself in the final research report.
- Do NOT return a report with missing information, omitted fields or \`N/A\` values. If more work needs to be done, you must assign more subagents to tasks, or reuse the necessary subagents to extract more information.
- You MUST load the plan from memory before returning the final research report to check that you have followed the plan.
- You MUST check the final research report before returning it to the user.
- Check the final report for quality, completeness and consistency. If up to standard, return using a single \`return\` as the sole statement in its very own
- Your final report MUST include a short "Sources consulted" section:
- List each source URL you relied on
- Include its sourceType and 1-2 extracted claims
- Any URL you include MUST be a markdown hyperlink (not a bare URL).
`;
const SUBAGENT_PREMISE = `
You are a helpful assistant.
# Task
You must:
1. Construct a list of things to search for using the webSearch function.
2. In REPL, execute ALL webSearch calls in parallel using \`asyncio.gather(...)\` (use \`asyncio.run(...)\` if needed).
3. For each search result, use \`print()\` to print relevant sections via SearchResult.contentWithLineNumbers(start, end).
4. Identify which lines of content you are going to use in your report.
5. Use the saveSearchResult function to save the SearchResult to memory and include the lines of the content that you have used.
- Include the specific \`query\` you searched for.
- Include \`extractedClaims\`: a list of short claims you will rely on (derived from the saved lines).
- Include \`sourceType\`: one of ["primary", "secondary", "vendor", "press", "blog", "forum", "unknown"].
Use your best judgment based on the URL/domain and the content.
- IMPORTANT: saveSearchResult returns a saved artifact path; keep it and include it in sources[].artifactPath
6. Condense the search results into a single report with what you have found.
7. Return the report using \`return\` at the very end in a separate REPL session.
# Rules
- You MUST use \`print()\` to print the content of each search result via SearchResult.contentWithLineNumbers(start, end).
- You MUST use the webSearch function if instructed to do so OR if the task requires finding information.
- Do NOT assume that the webSearch function will return the information you need, you must go through the content of each search result line by line by combing through the content with SearchResult.contentWithLineNumbers(start, end).
- Do NOT assume which lines of content you are going to use in your report, you must go through the content of each search result line by line via SearchResult.contentWithLineNumbers(start, end).
- If you cannot find any information, do NOT provide information yourself, instead raise an error for the lead researcher in the REPL.
- You MUST save the SearchResult of any research that you have used to memory and include the lines of the content that you have used (are relevant).
- When saving, pass \`query\`, \`extractedClaims\`, and \`sourceType\` to saveSearchResult.
- Your returned SubAgentReport MUST include \`sources\`: one entry per saved source, including url, sourceType, query, extractedClaims, artifactPath, and linesUsed.
- Return the report using \`return\` at the very end in a separate REPL session.
`;
```
We can now run the session with a user query!
```typescript theme={null}
async function main() {
const session = new DeepResearchSession();
const result = await session.call(
'What are all of the companies in the US working on AI agents in 2025? ' +
'Make a list of at least 10. For each, include the name, website and product, ' +
'description of what they do, type of agents they build, and their vertical/industry.'
);
console.log(result);
exit(0);
}
main().catch(console.error);
```
View the generated report