{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
API Reference
Run research with SSE streaming
Search, evaluate sources, and synthesize a cited report from a natural-language query. Accepted requests always return a Server-Sent Events stream, including when stream is false.
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
{
"error": {
"code": "INVALID_INPUT",
"message": "Field \"url\" is required and must be a string",
"details": "<unknown>"
},
"request_id": "8f9dba20-e37b-4749-a919-2269e28b4a2c"
}
Continue a research session. Mutually exclusive with prior_run_id.
Response
Server-Sent Events stream. Save the run ID from created and stop reading after done. See the Research API reference for the full event catalog.
The response is of type string.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"TinyFish Web Agent","colors":{"primary":"#D74B28","light":"#D74B28","dark":"#D74B28"},"logo":{"light":"https://mintcdn.com/tinyfish/SAWuKzAHuR-ZMRAB/logo/TF_Horizontal.svg?fit=max\u0026auto=format\u0026n=SAWuKzAHuR-ZMRAB\u0026q=85\u0026s=3ff7a57ebbe744005f4f984e986f16b9","dark":"https://mintcdn.com/tinyfish/VrMSbq950IKhOmzd/logo/dark.svg?fit=max\u0026auto=format\u0026n=VrMSbq950IKhOmzd\u0026q=85\u0026s=78303ae67f6f601a47cdfd79f978f941","href":"https://agent.tinyfish.ai"},"favicon":"https://mintcdn.com/tinyfish/SAWuKzAHuR-ZMRAB/logo/TF_ICON.svg?fit=max\u0026auto=format\u0026n=SAWuKzAHuR-ZMRAB\u0026q=85\u0026s=9151d20cf17b84686c03e299a8997a32","navbar":{"primary":{"type":"button","label":"Get API Key","href":"https://agent.tinyfish.ai/api-keys"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/tinyfish-ai","x":"https://x.com/Tiny_Fish","discord":"https://discord.gg/tinyfish","youtube":"https://www.youtube.com/@TinyFish-AI"}},"integrations":{"ga4":{"measurementId":"G-P52K96QP6R"},"posthog":{"apiKey":"phc_NJaHVgJntoRghYPq3Q92cniMBBbLRh4cE2S5xX1XVyL"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tinyfish","hasAudioNarration":false,"actualSubdomain":"tinyfish","customDomains":["docs.tinyfish.ai"],"gitSource":{"type":"github","owner":"tinyfish-io","repo":"ux-labs","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adc0ebdbfa14b4ae8dcc153","collectionId":"140f5da7-47b9-4bbd-adcf-5eceb15bcd35","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adc0ebdbfa14b4ae8dcc153"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6adfd737f741f2f93e2ca3b4","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":66},{"language":"default","tag":"Documentation","count":50},{"language":"default","tag":"Agent \u0026 Runs","count":28},{"language":"default","tag":"Browser Context Profiles","count":10},{"language":"default","tag":"Agent API","count":8},{"language":"default","tag":"Monitor","count":8},{"language":"default","tag":"Tools \u0026 Integrations","count":7},{"language":"default","tag":"Capabilities","count":7},{"language":"default","tag":"Runs","count":7},{"language":"default","tag":"Research","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/run-research-with-sse-streaming","slug":"/api-reference/run-research-with-sse-streaming","pageMetadata":{"title":"Run research with SSE streaming","description":"Search, evaluate sources, and synthesize a cited report from a natural-language query. Accepted requests always return a Server-Sent Events stream, including when stream is false.","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/research post /v1/automation/run-research","href":"/api-reference/run-research-with-sse-streaming","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Search, evaluate sources, and synthesize a cited report from a natural-language query. Accepted requests always return a Server-Sent Events stream, including when stream is false.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Run research with SSE streaming","description":"Search, evaluate sources, and synthesize a cited report from a natural-language query. Accepted requests always return a Server-Sent Events stream, including when stream is false.","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/research post /v1/automation/run-research","href":"/api-reference/run-research-with-sse-streaming","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"runResearch","description":"Search, evaluate sources, and synthesize a cited report from a natural-language query. Accepted requests always return a Server-Sent Events stream, including when stream is false.","summary":"Run research with SSE streaming","security":["f7dd15f0-2e1e-4164-9527-440f8a3fc252"],"requestBody":"5c29439e-82eb-4815-b9ce-91799fba1b7d","responses":{"200":"2c0d25b2-2e0b-41d8-9691-f068f592b14b","400":"b4a39d11-a31d-4329-9503-e01d69cbfa53","401":"ff7f193e-4069-448f-af87-a40c3290a0d7","402":"ea62d783-9ea7-430a-8707-e2d4b4ee100e","403":"683ac0ab-00dc-49eb-bbf0-a423e07ced5d","404":"010c3efc-a4da-46af-b927-73bb1fe353bf","429":"ad47238f-a808-4acc-b8ce-2a974a940c1a","500":"58775fb4-f910-444e-9781-0fe9f0a2052c","503":"9ecb1258-aecf-44a9-9bae-a2bbeab62b20"},"method":"post","type":"path","servers":["c6a50419-8084-4ac1-8469-4d8dc8b53c9e"],"path":"/v1/automation/run-research","baseUrlOptions":["https://agent.tinyfish.ai"],"title":"Run research with SSE streaming","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"Research parameters","content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":2000,"description":"Research question","example":"Compare long-duration energy storage approaches","isRequired":true,"uniqueKey":"query","typeLabel":"string"},"mode":{"type":"string","enum":["deep","max"],"description":"Depth of research. Omitted selects deep.","example":"deep","uniqueKey":"mode","typeLabel":"enum\u003cstring>"},"stream":{"type":"boolean","description":"Emit report text through synthesis_delta events as it is written","uniqueKey":"stream","typeLabel":"boolean"},"output_language":{"type":"string","description":"BCP 47 language tag for the report","example":"ja","uniqueKey":"output_language","typeLabel":"string"},"weak_sources_enabled":{"type":"boolean","description":"Allow relevant social and community sources","uniqueKey":"weak_sources_enabled","typeLabel":"boolean"},"domain_type":{"type":"string","enum":["web","news","research_paper"],"description":"Source pool to research over","example":"news","uniqueKey":"domain_type","typeLabel":"enum\u003cstring>"},"after_date":{"type":"string","format":"date","description":"Include results on or after this date (YYYY-MM-DD)","example":"2026-01-01","uniqueKey":"after_date","typeLabel":"string\u003cdate>"},"before_date":{"type":"string","format":"date","description":"Include results on or before this date (YYYY-MM-DD)","example":"2026-06-30","uniqueKey":"before_date","typeLabel":"string\u003cdate>"},"recency_minutes":{"type":"integer","minimum":1,"maximum":5256000,"description":"Include results from the last 1-5,256,000 minutes. Not combinable with date filters.","example":1440,"uniqueKey":"recency_minutes","typeLabel":"integer"},"domain_filter":{"type":"object","properties":{"mode":{"type":"string","enum":["include","exclusive"],"description":"include prioritizes the domains; exclusive restricts results to them","isRequired":true,"uniqueKey":"domain_filter.mode","typeLabel":"enum\u003cstring>"},"domains":{"type":"array","items":{"type":"string","uniqueKey":"domain_filter.domains.items.[INDEX]","typeLabel":"string"},"maxItems":150,"description":"Domains to prefer or require","uniqueKey":"domain_filter.domains","typeLabel":"string[]"},"block":{"type":"array","items":{"type":"string","uniqueKey":"domain_filter.block.items.[INDEX]","typeLabel":"string"},"maxItems":150,"description":"Domains to always remove","uniqueKey":"domain_filter.block","typeLabel":"string[]"}},"required":["mode"],"description":"Domain preferences. Each list accepts at most 150 entries.","uniqueKey":"domain_filter","typeLabel":"object"},"prior_run_id":{"type":"string","description":"Seed this run with a completed report and its evidence","uniqueKey":"prior_run_id","typeLabel":"string"},"session_id":{"type":"string","format":"uuid","description":"Continue a research session. Mutually exclusive with prior_run_id.","uniqueKey":"session_id","typeLabel":"string\u003cuuid>"}},"required":["query"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"query":"Compare long-duration energy storage approaches","mode":"deep","stream":true,"output_language":"ja","weak_sources_enabled":true,"domain_type":"news","after_date":"2026-01-01","before_date":"2026-06-30","recency_minutes":1440,"prior_run_id":"\u003cstring>","session_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"2c0d25b2-2e0b-41d8-9691-f068f592b14b":{"description":"Server-Sent Events stream. Save the run ID from created and stop reading after done. See the Research API reference for the full event catalog.","content":{"text/event-stream":{"schema":{"type":"string","uniqueKey":"","typeLabel":"string"},"example":"data: {\"event\":\"created\",\"research_run_id\":\"019...\"}\n\ndata: {\"event\":\"plan_updated\",\"iteration\":1}\n\ndata: {\"event\":\"final_result\",\"result\":\"...\",\"citations\":[]}\n\ndata: {\"event\":\"done\"}","examples":{"Example":{"title":"Example","value":"data: {\"event\":\"created\",\"research_run_id\":\"019...\"}\n\ndata: {\"event\":\"plan_updated\",\"iteration\":1}\n\ndata: {\"event\":\"final_result\",\"result\":\"...\",\"citations\":[]}\n\ndata: {\"event\":\"done\"}"}},"exampleType":"examples"}},"exampleType":"examples"},"b4a39d11-a31d-4329-9503-e01d69cbfa53":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["MISSING_API_KEY","INVALID_API_KEY","INVALID_INPUT","RATE_LIMIT_EXCEEDED","DAILY_LIMIT_EXCEEDED","INTERNAL_ERROR","RETRY_REQUIRED","UNAUTHORIZED","VAULT_RECONNECT_REQUIRED","FORBIDDEN","NOT_FOUND","FEATURE_NOT_AVAILABLE","SERVICE_BUSY","TIMEOUT","INSUFFICIENT_CREDITS","FREE_ALLOWANCE_EXHAUSTED","CONTENT_POLICY_VIOLATION","MAX_STEPS_EXCEEDED","SITE_BLOCKED","TASK_FAILED","CANCELLED"],"description":"Machine-readable error code","example":"INVALID_INPUT","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"Field \"url\" is required and must be a string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details (validation errors, etc.)","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"description":"Additional error details (validation errors, etc.)","type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request correlation ID, also returned as the X-Request-ID response header. Include it when reporting issues.","example":"8f9dba20-e37b-4749-a919-2269e28b4a2c","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_INPUT","message":"Field \"url\" is required and must be a string","details":"\u003cunknown>"},"request_id":"8f9dba20-e37b-4749-a919-2269e28b4a2c"}}},"exampleType":"generated"}},"exampleType":"generated"},"ff7f193e-4069-448f-af87-a40c3290a0d7":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["MISSING_API_KEY","INVALID_API_KEY","INVALID_INPUT","RATE_LIMIT_EXCEEDED","DAILY_LIMIT_EXCEEDED","INTERNAL_ERROR","RETRY_REQUIRED","UNAUTHORIZED","VAULT_RECONNECT_REQUIRED","FORBIDDEN","NOT_FOUND","FEATURE_NOT_AVAILABLE","SERVICE_BUSY","TIMEOUT","INSUFFICIENT_CREDITS","FREE_ALLOWANCE_EXHAUSTED","CONTENT_POLICY_VIOLATION","MAX_STEPS_EXCEEDED","SITE_BLOCKED","TASK_FAILED","CANCELLED"],"description":"Machine-readable error code","example":"INVALID_INPUT","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"Field \"url\" is required and must be a string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details (validation errors, etc.)","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"description":"Additional error details (validation errors, etc.)","type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request correlation ID, also returned as the X-Request-ID response header. Include it when reporting issues.","example":"8f9dba20-e37b-4749-a919-2269e28b4a2c","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_INPUT","message":"Field \"url\" is required and must be a string","details":"\u003cunknown>"},"request_id":"8f9dba20-e37b-4749-a919-2269e28b4a2c"}}},"exampleType":"generated"}},"exampleType":"generated"},"ea62d783-9ea7-430a-8707-e2d4b4ee100e":{"description":"Payment required - wallet balance too low to start a run","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["MISSING_API_KEY","INVALID_API_KEY","INVALID_INPUT","RATE_LIMIT_EXCEEDED","DAILY_LIMIT_EXCEEDED","INTERNAL_ERROR","RETRY_REQUIRED","UNAUTHORIZED","VAULT_RECONNECT_REQUIRED","FORBIDDEN","NOT_FOUND","FEATURE_NOT_AVAILABLE","SERVICE_BUSY","TIMEOUT","INSUFFICIENT_CREDITS","FREE_ALLOWANCE_EXHAUSTED","CONTENT_POLICY_VIOLATION","MAX_STEPS_EXCEEDED","SITE_BLOCKED","TASK_FAILED","CANCELLED"],"description":"Machine-readable error code","example":"INVALID_INPUT","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"Field \"url\" is required and must be a string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details (validation errors, etc.)","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"description":"Additional error details (validation errors, etc.)","type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request correlation ID, also returned as the X-Request-ID response header. Include it when reporting issues.","example":"8f9dba20-e37b-4749-a919-2269e28b4a2c","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_INPUT","message":"Field \"url\" is required and must be a string","details":"\u003cunknown>"},"request_id":"8f9dba20-e37b-4749-a919-2269e28b4a2c"}}},"exampleType":"generated"}},"exampleType":"generated"},"683ac0ab-00dc-49eb-bbf0-a423e07ced5d":{"description":"Forbidden - Research is not enabled for this account","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["MISSING_API_KEY","INVALID_API_KEY","INVALID_INPUT","RATE_LIMIT_EXCEEDED","DAILY_LIMIT_EXCEEDED","INTERNAL_ERROR","RETRY_REQUIRED","UNAUTHORIZED","VAULT_RECONNECT_REQUIRED","FORBIDDEN","NOT_FOUND","FEATURE_NOT_AVAILABLE","SERVICE_BUSY","TIMEOUT","INSUFFICIENT_CREDITS","FREE_ALLOWANCE_EXHAUSTED","CONTENT_POLICY_VIOLATION","MAX_STEPS_EXCEEDED","SITE_BLOCKED","TASK_FAILED","CANCELLED"],"description":"Machine-readable error code","example":"INVALID_INPUT","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"Field \"url\" is required and must be a string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details (validation errors, etc.)","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"description":"Additional error details (validation errors, etc.)","type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request correlation ID, also returned as the X-Request-ID response header. Include it when reporting issues.","example":"8f9dba20-e37b-4749-a919-2269e28b4a2c","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_INPUT","message":"Field \"url\" is required and must be a string","details":"\u003cunknown>"},"request_id":"8f9dba20-e37b-4749-a919-2269e28b4a2c"}}},"exampleType":"generated"}},"exampleType":"generated"},"010c3efc-a4da-46af-b927-73bb1fe353bf":{"description":"Not found - unknown session_id or prior_run_id","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["MISSING_API_KEY","INVALID_API_KEY","INVALID_INPUT","RATE_LIMIT_EXCEEDED","DAILY_LIMIT_EXCEEDED","INTERNAL_ERROR","RETRY_REQUIRED","UNAUTHORIZED","VAULT_RECONNECT_REQUIRED","FORBIDDEN","NOT_FOUND","FEATURE_NOT_AVAILABLE","SERVICE_BUSY","TIMEOUT","INSUFFICIENT_CREDITS","FREE_ALLOWANCE_EXHAUSTED","CONTENT_POLICY_VIOLATION","MAX_STEPS_EXCEEDED","SITE_BLOCKED","TASK_FAILED","CANCELLED"],"description":"Machine-readable error code","example":"INVALID_INPUT","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"Field \"url\" is required and must be a string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details (validation errors, etc.)","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"description":"Additional error details (validation errors, etc.)","type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request correlation ID, also returned as the X-Request-ID response header. Include it when reporting issues.","example":"8f9dba20-e37b-4749-a919-2269e28b4a2c","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_INPUT","message":"Field \"url\" is required and must be a string","details":"\u003cunknown>"},"request_id":"8f9dba20-e37b-4749-a919-2269e28b4a2c"}}},"exampleType":"generated"}},"exampleType":"generated"},"ad47238f-a808-4acc-b8ce-2a974a940c1a":{"description":"Concurrent-run or daily-completion limit reached","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["MISSING_API_KEY","INVALID_API_KEY","INVALID_INPUT","RATE_LIMIT_EXCEEDED","DAILY_LIMIT_EXCEEDED","INTERNAL_ERROR","RETRY_REQUIRED","UNAUTHORIZED","VAULT_RECONNECT_REQUIRED","FORBIDDEN","NOT_FOUND","FEATURE_NOT_AVAILABLE","SERVICE_BUSY","TIMEOUT","INSUFFICIENT_CREDITS","FREE_ALLOWANCE_EXHAUSTED","CONTENT_POLICY_VIOLATION","MAX_STEPS_EXCEEDED","SITE_BLOCKED","TASK_FAILED","CANCELLED"],"description":"Machine-readable error code","example":"INVALID_INPUT","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"Field \"url\" is required and must be a string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details (validation errors, etc.)","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"description":"Additional error details (validation errors, etc.)","type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request correlation ID, also returned as the X-Request-ID response header. Include it when reporting issues.","example":"8f9dba20-e37b-4749-a919-2269e28b4a2c","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_INPUT","message":"Field \"url\" is required and must be a string","details":"\u003cunknown>"},"request_id":"8f9dba20-e37b-4749-a919-2269e28b4a2c"}}},"exampleType":"generated"}},"exampleType":"generated"},"58775fb4-f910-444e-9781-0fe9f0a2052c":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["MISSING_API_KEY","INVALID_API_KEY","INVALID_INPUT","RATE_LIMIT_EXCEEDED","DAILY_LIMIT_EXCEEDED","INTERNAL_ERROR","RETRY_REQUIRED","UNAUTHORIZED","VAULT_RECONNECT_REQUIRED","FORBIDDEN","NOT_FOUND","FEATURE_NOT_AVAILABLE","SERVICE_BUSY","TIMEOUT","INSUFFICIENT_CREDITS","FREE_ALLOWANCE_EXHAUSTED","CONTENT_POLICY_VIOLATION","MAX_STEPS_EXCEEDED","SITE_BLOCKED","TASK_FAILED","CANCELLED"],"description":"Machine-readable error code","example":"INVALID_INPUT","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"Field \"url\" is required and must be a string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details (validation errors, etc.)","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"description":"Additional error details (validation errors, etc.)","type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request correlation ID, also returned as the X-Request-ID response header. Include it when reporting issues.","example":"8f9dba20-e37b-4749-a919-2269e28b4a2c","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_INPUT","message":"Field \"url\" is required and must be a string","details":"\u003cunknown>"},"request_id":"8f9dba20-e37b-4749-a919-2269e28b4a2c"}}},"exampleType":"generated"}},"exampleType":"generated"},"9ecb1258-aecf-44a9-9bae-a2bbeab62b20":{"description":"Research is temporarily unavailable","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["MISSING_API_KEY","INVALID_API_KEY","INVALID_INPUT","RATE_LIMIT_EXCEEDED","DAILY_LIMIT_EXCEEDED","INTERNAL_ERROR","RETRY_REQUIRED","UNAUTHORIZED","VAULT_RECONNECT_REQUIRED","FORBIDDEN","NOT_FOUND","FEATURE_NOT_AVAILABLE","SERVICE_BUSY","TIMEOUT","INSUFFICIENT_CREDITS","FREE_ALLOWANCE_EXHAUSTED","CONTENT_POLICY_VIOLATION","MAX_STEPS_EXCEEDED","SITE_BLOCKED","TASK_FAILED","CANCELLED"],"description":"Machine-readable error code","example":"INVALID_INPUT","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message","example":"Field \"url\" is required and must be a string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details (validation errors, etc.)","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"description":"Additional error details (validation errors, etc.)","type":"null","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","description":"Request correlation ID, also returned as the X-Request-ID response header. Include it when reporting issues.","example":"8f9dba20-e37b-4749-a919-2269e28b4a2c","uniqueKey":"request_id","typeLabel":"string"}},"required":["error"],"description":"Standard error response format","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_INPUT","message":"Field \"url\" is required and must be a string","details":"\u003cunknown>"},"request_id":"8f9dba20-e37b-4749-a919-2269e28b4a2c"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f7dd15f0-2e1e-4164-9527-440f8a3fc252":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for authentication. Get your key from the API Keys page.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"c6a50419-8084-4ac1-8469-4d8dc8b53c9e":{"url":"https://agent.tinyfish.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for authentication. Get your key from the API Keys page.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-API-Key","type":"string","description":"API key for authentication. Get your key from the API Keys page.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"https://agent.tinyfish.ai/v1/openapi/research"},"subdomain":"tinyfish","siteName":"TinyFish Web Agent","title":"Run research with SSE streaming - TinyFish Web Agent","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T22:32:49.932Z","originalFileLocation":"api-reference/run-research-with-sse-streaming.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Search, evaluate sources, and synthesize a cited report from a natural-language query. Accepted requests always return a Server-Sent Events stream, including when stream is false.\">\u003cmeta data-mint-head name=\"application-name\" content=\"TinyFish Web Agent\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Run research with SSE streaming - TinyFish Web Agent\">\u003cmeta data-mint-head property=\"og:description\" content=\"Search, evaluate sources, and synthesize a cited report from a natural-language query. Accepted requests always return a Server-Sent Events stream, including when stream is false.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"TinyFish Web Agent\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tinyfish.ai/api-reference/run-research-with-sse-streaming\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tinyfish.mintlify.app/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Run+research+with+SSE+streaming\u0026amp;description=Search%2C+evaluate+sources%2C+and+synthesize+a+cited+report+from+a+natural-language+query.+Accepted+requests+always+return+a+Server-Sent+Events+stream%2C+including+wh\u0026amp;theme=619f6727a66ef17f9efad127\u0026amp;signature=f309d3b457d9589de849b30800786f60d96f90ba8171a18f1bd188c5ebf52c05\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Run research with SSE streaming - TinyFish Web Agent\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Search, evaluate sources, and synthesize a cited report from a natural-language query. Accepted requests always return a Server-Sent Events stream, including when stream is false.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tinyfish.mintlify.app/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Run+research+with+SSE+streaming\u0026amp;description=Search%2C+evaluate+sources%2C+and+synthesize+a+cited+report+from+a+natural-language+query.+Accepted+requests+always+return+a+Server-Sent+Events+stream%2C+including+wh\u0026amp;theme=619f6727a66ef17f9efad127\u0026amp;signature=f309d3b457d9589de849b30800786f60d96f90ba8171a18f1bd188c5ebf52c05\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/tinyfish/05k5zsm6ySkMI6wO/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"TinyFish Web Agent\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#D74B28\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tinyfish.ai/api-reference/run-research-with-sse-streaming\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/run-research-with-sse-streaming.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tinyfish.ai/#organization\",\"name\":\"TinyFish Web Agent\",\"url\":\"https://docs.tinyfish.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tinyfish/SAWuKzAHuR-ZMRAB/logo/TF_Horizontal.svg?fit=max\u0026auto=format\u0026n=SAWuKzAHuR-ZMRAB\u0026q=85\u0026s=3ff7a57ebbe744005f4f984e986f16b9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tinyfish.ai#website\",\"name\":\"TinyFish Web Agent\",\"url\":\"https://docs.tinyfish.ai\",\"publisher\":{\"@id\":\"https://docs.tinyfish.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tinyfish.ai/api-reference/run-research-with-sse-streaming#webpage\",\"url\":\"https://docs.tinyfish.ai/api-reference/run-research-with-sse-streaming\",\"name\":\"Run research with SSE streaming\",\"description\":\"Search, evaluate sources, and synthesize a cited report from a natural-language query. Accepted requests always return a Server-Sent Events stream, including when stream is false.\",\"dateModified\":\"2026-10-23T22:32:49.932Z\",\"isPartOf\":{\"@id\":\"https://docs.tinyfish.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tinyfish.ai/api-reference/run-research-with-sse-streaming#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tinyfish.ai/api-reference/run-research-with-sse-streaming#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"TinyFish Web Agent\",\"item\":\"https://docs.tinyfish.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Run research with SSE streaming\",\"item\":\"https://docs.tinyfish.ai/api-reference/run-research-with-sse-streaming\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tinyfish.ai/api-reference/run-research-with-sse-streaming#apireference\",\"headline\":\"Run research with SSE streaming\",\"name\":\"Run research with SSE streaming\",\"description\":\"Search, evaluate sources, and synthesize a cited report from a natural-language query. Accepted requests always return a Server-Sent Events stream, including when stream is false.\",\"url\":\"https://docs.tinyfish.ai/api-reference/run-research-with-sse-streaming\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tinyfish.ai/api-reference/run-research-with-sse-streaming#webpage\"},\"dateModified\":\"2026-10-23T22:32:49.932Z\",\"publisher\":{\"@id\":\"https://docs.tinyfish.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tinyfish.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"TinyFish Web Agent\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"TinyFish Web Agent","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Agent \u0026 Runs","icon":"sparkles","pages":[{"group":"Automation","pages":[{"title":"Run browser automation with SSE streaming","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/automation/run-sse","href":"/api-reference/automation/run-browser-automation-with-sse-streaming"},{"title":"Run browser automation synchronously","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/automation/run","href":"/api-reference/automation/run-browser-automation-synchronously"},{"title":"Start automation asynchronously","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/automation/run-async","href":"/api-reference/automation/start-automation-asynchronously"},{"title":"Start multiple automations asynchronously","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/automation/run-batch","href":"/api-reference/automation/start-multiple-automations-asynchronously"}]},{"group":"Runs","pages":[{"title":"List and search runs","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main get /v1/runs","href":"/api-reference/runs/list-and-search-runs"},{"title":"Get multiple runs by IDs","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/runs/batch","href":"/api-reference/runs/get-multiple-runs-by-ids"},{"title":"Cancel multiple runs by IDs","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/runs/batch/cancel","href":"/api-reference/runs/cancel-multiple-runs-by-ids"},{"title":"Get run by ID","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main get /v1/runs/{id}","href":"/api-reference/runs/get-run-by-id"},{"title":"Cancel run by ID","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/runs/{id}/cancel","href":"/api-reference/runs/cancel-run-by-id"},{"title":"Get step screenshot","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main get /v1/runs/{id}/steps/{stepId}/screenshot","href":"/api-reference/runs/get-step-screenshot"},{"title":"Get step HTML snapshot","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main get /v1/runs/{id}/steps/{stepId}/html","href":"/api-reference/runs/get-step-html-snapshot"}]},{"group":"Browser Context Profiles","pages":[{"title":"List Browser Context Profiles","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main get /v1/profiles","href":"/api-reference/browser-context-profiles/list-browser-context-profiles"},{"title":"Create a Browser Context Profile","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/profiles","href":"/api-reference/browser-context-profiles/create-a-browser-context-profile"},{"title":"Get a Browser Context Profile","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main get /v1/profiles/{profileId}","href":"/api-reference/browser-context-profiles/get-a-browser-context-profile"},{"title":"Delete a Browser Context Profile","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main delete /v1/profiles/{profileId}","href":"/api-reference/browser-context-profiles/delete-a-browser-context-profile"},{"title":"Update a Browser Context Profile","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main patch /v1/profiles/{profileId}","href":"/api-reference/browser-context-profiles/update-a-browser-context-profile"},{"title":"Create a profile setup session","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/profiles/{profileId}/setup-session","href":"/api-reference/browser-context-profiles/create-a-profile-setup-session"},{"title":"Cancel a profile setup session","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/profiles/{profileId}/setup-session/cancel","href":"/api-reference/browser-context-profiles/cancel-a-profile-setup-session"},{"title":"Save a profile setup session","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/profiles/{profileId}/save","href":"/api-reference/browser-context-profiles/save-a-profile-setup-session"},{"title":"Upload Browser Context Profile state","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/profiles/{profileId}/upload","href":"/api-reference/browser-context-profiles/upload-browser-context-profile-state"},{"title":"Delete a saved profile domain","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main delete /v1/profiles/{profileId}/domains/{domain}","href":"/api-reference/browser-context-profiles/delete-a-saved-profile-domain"}]},{"group":"Vault","pages":[{"title":"List vault connections","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main get /v1/vault/connections","href":"/api-reference/vault/list-vault-connections"},{"title":"Connect a vault provider","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/vault/connections","href":"/api-reference/vault/connect-a-vault-provider"},{"title":"Disconnect a vault provider","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main delete /v1/vault/connections/{connectionId}","href":"/api-reference/vault/disconnect-a-vault-provider"},{"title":"List vault items","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main get /v1/vault/items","href":"/api-reference/vault/list-vault-items"},{"title":"Sync vault items","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/vault/items/sync","href":"/api-reference/vault/sync-vault-items"}]},{"group":"Wallet","pages":[{"title":"Get wallet","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main get /v1/wallet","href":"/api-reference/wallet/get-wallet"},{"title":"Top up wallet (agent-paid)","description":"Add money to the wallet, paid by the calling agent over the Machine Payments Protocol (MPP). The first call answers 402 with a payment challenge in WWW-Authenticate; retry with a Payment-Authorization credential to settle the charge and credit the wallet.","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/main post /v1/wallet/top-up","href":"/api-reference/wallet/top-up-wallet-agent-paid"}]}]},{"group":"Research","icon":"telescope","pages":[{"group":"API Reference","pages":[{"title":"Run research with SSE streaming","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/research post /v1/automation/run-research","href":"/api-reference/run-research-with-sse-streaming"},{"title":"Start research asynchronously","description":"Enqueue research and return its ID after durable dispatch. Poll GET /v1/research-run/{id} or attach to its events endpoint.","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/research post /v1/automation/run-research-async","href":"/api-reference/start-research-asynchronously"},{"title":"Attach to research progress","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/research get /v1/research-run/{research_run_id}/events","href":"/api-reference/attach-to-research-progress"},{"title":"List research runs","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/research get /v1/research-run","href":"/api-reference/list-research-runs"},{"title":"Get research run by ID","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/research get /v1/research-run/{research_run_id}","href":"/api-reference/get-research-run-by-id"},{"title":"Cancel research run by ID","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/research post /v1/research-run/{research_run_id}/cancel","href":"/api-reference/cancel-research-run-by-id"}]}]},{"group":"Fetch","icon":"bolt","pages":[{"group":"API Reference","pages":[{"title":"Fetch and extract content from URLs","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/fetch post /","href":"/api-reference/fetch-and-extract-content-from-urls"},{"title":"List fetch usage","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/fetch get /usage","href":"/api-reference/list-fetch-usage"}]}]},{"group":"Search","icon":"magnifying-glass","pages":[{"group":"API Reference","pages":[{"title":"Search the web","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/search get /","href":"/api-reference/search-the-web"},{"title":"List search usage","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/search get /usage","href":"/api-reference/list-search-usage"}]}]},{"group":"Browser","icon":"browser","pages":[{"group":"API Reference","pages":[{"title":"Create a remote browser session","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/browser post /","href":"/api-reference/create-a-remote-browser-session"},{"title":"List browser session usage","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/browser get /usage","href":"/api-reference/list-browser-session-usage"},{"title":"Terminate a browser session","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/browser delete /{sessionId}","href":"/api-reference/terminate-a-browser-session"}]}]},{"group":"Monitor","icon":"eye","pages":[{"group":"API Reference","pages":[{"title":"List Monitors","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/monitor get /v1/monitors","href":"/api-reference/list-monitors"},{"title":"Create a Monitor","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/monitor post /v1/monitors","href":"/api-reference/create-a-monitor"},{"title":"Get a Monitor","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/monitor get /v1/monitors/{id}","href":"/api-reference/get-a-monitor"},{"title":"Delete a Monitor","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/monitor delete /v1/monitors/{id}","href":"/api-reference/delete-a-monitor"},{"title":"Update a Monitor","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/monitor patch /v1/monitors/{id}","href":"/api-reference/update-a-monitor"},{"title":"Run a Monitor now","deprecated":null,"version":null,"openapi":"https://agent.tinyfish.ai/v1/openapi/monitor post /v1/monitors/{id}/runs","href":"/api-reference/run-a-monitor-now"}]}]}]},{"tab":"Cookbook","icon":"utensils","href":"https://github.com/tinyfish-io/tinyfish-cookbook"}]},"title":"Run research with SSE streaming - TinyFish Web Agent","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}