research_status
Check a notebook's research status to monitor progress and get poll_task_id for importing completed results.
Instructions
Check a notebook's research status. Accepts a notebook name or ID.
Returns status (no_research|in_progress|completed|failed|not_found),
poll_task_id, sources, and report metadata. Poll until
completed, then pass poll_task_id to research_import.
termination_reason splits failed into no_results|cancelled|
unknown (else completed|in_progress); see hint.
report and per-source report_markdown are omitted unless
include_report=True (truncated to report_max_chars).
report_char_count is the full size; report_truncated flags an
omitted/truncated one. source_limit/source_offset page sources.
poll_task_id (optional) pins one of several in-flight tasks; omit
for a single task (ambiguous with two+). An unmatched pin reports
not_found. task_id is a deprecated alias (removed in v0.9.0).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| task_id | No | ||
| notebook | Yes | ||
| poll_task_id | No | ||
| source_limit | No | ||
| source_offset | No | ||
| include_report | No | ||
| report_max_chars | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||