{"openapi":"3.1.0","info":{"title":"Scout","description":"Web intelligence API - search, extract, and research the live web, shaped for AI agents.","version":"1.0.0"},"paths":{"/v1/search":{"post":{"tags":["Search"],"summary":"Search Post","description":"Run one or more web searches; return merged, de-duplicated results.","operationId":"search_post_v1_search_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequestV1"},"example":{"queries":["climate tech startups 2025","carbon capture funding"],"depth":"fast","limit":10,"country":"us","language":"en","freshness":"month"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"},"example":{"queries":["climate tech startups 2025","carbon capture funding"],"results":[{"url":"https://techcrunch.com/2025/01/12/climate-tech-funding","title":"Climate tech startups raised $32B in 2024","excerpts":["Carbon capture companies led the year, taking the single largest share of climate venture funding.","Early-stage climate funding grew 18% year over year."],"publishedDate":"2025-01-12"},{"url":"https://www.canarymedia.com/articles/carbon-capture","title":"The carbon capture funding boom, explained","excerpts":["Direct air capture drew more than $1.1B in new commitments across just six rounds."],"publishedDate":"2024-11-30"}],"credits":2}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]}},"/v1/extract":{"post":{"tags":["Extract"],"summary":"Extract Post","description":"Extract clean markdown from 1-20 URLs. With an output_schema, each\nURL's content is also coerced into a structured object on `data`.","operationId":"extract_post_v1_extract_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractRequestV1"},"example":{"urls":["https://www.anthropic.com/company"],"output_schema":{"type":"object","properties":{"company_name":{"type":"string"},"headquarters":{"type":"string"},"industry":{"type":"string"}}}}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractResponse"},"example":{"results":[{"url":"https://www.anthropic.com/company","title":"Anthropic - Company","content":"# Anthropic\n\nAnthropic is an AI safety company based in San Francisco. We build reliable, interpretable, and steerable AI systems.\n\n## Our mission\n\nEnsure that humanity safely navigates the transition through transformative AI.","data":{"company_name":"Anthropic","headquarters":"San Francisco, California","industry":"Artificial intelligence"},"error":null}],"credits":4}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]},"get":{"tags":["Extract"],"summary":"Extract Get","operationId":"extract_get_v1_extract_get","parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","minLength":1,"title":"Url"}},{"name":"max_chars","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Max Chars"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractResponse"},"example":{"results":[{"url":"https://www.anthropic.com/company","title":"Anthropic - Company","content":"# Anthropic\n\nAnthropic is an AI safety company based in San Francisco. We build reliable, interpretable, and steerable AI systems.\n\n## Our mission\n\nEnsure that humanity safely navigates the transition through transformative AI.","data":null,"error":null}],"credits":2}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]}},"/v1/monitors":{"get":{"tags":["Monitors"],"summary":"Monitor List","operationId":"monitor_list_v1_monitors_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Monitor"},"type":"array","title":"Response Monitor List V1 Monitors Get"},"example":[{"id":"mon-1f6c2d9a4b7e","query":"anthropic new model release","cadence":"daily","webhook":"https://example.com/hooks/scout","country":"us","language":"en","status":"active","metadata":{"team":"research"},"createdAt":"2025-01-18T09:00:00+00:00","lastRunAt":"2025-01-20T09:00:00+00:00","nextRunAt":"2025-01-21T09:00:00+00:00","runs":3}]}}}},"security":[{"apiKey":[]}]},"post":{"tags":["Monitors"],"summary":"Monitor Create","operationId":"monitor_create_v1_monitors_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorCreate"},"example":{"query":"anthropic new model release","webhook":"https://example.com/hooks/scout","cadence":"daily","country":"us","language":"en","metadata":{"team":"research"}}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Monitor"},"example":{"id":"mon-1f6c2d9a4b7e","query":"anthropic new model release","cadence":"daily","webhook":"https://example.com/hooks/scout","country":"us","language":"en","status":"active","metadata":{"team":"research"},"createdAt":"2025-01-18T09:00:00+00:00","lastRunAt":"2025-01-20T09:00:00+00:00","nextRunAt":"2025-01-21T09:00:00+00:00","runs":3}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]}},"/v1/monitors/{monitor_id}":{"get":{"tags":["Monitors"],"summary":"Monitor Get","operationId":"monitor_get_v1_monitors__monitor_id__get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Monitor"},"example":{"id":"mon-1f6c2d9a4b7e","query":"anthropic new model release","cadence":"daily","webhook":"https://example.com/hooks/scout","country":"us","language":"en","status":"active","metadata":{"team":"research"},"createdAt":"2025-01-18T09:00:00+00:00","lastRunAt":"2025-01-20T09:00:00+00:00","nextRunAt":"2025-01-21T09:00:00+00:00","runs":3}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]},"patch":{"tags":["Monitors"],"summary":"Monitor Update","operationId":"monitor_update_v1_monitors__monitor_id__patch","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Monitor"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]},"delete":{"tags":["Monitors"],"summary":"Monitor Delete","operationId":"monitor_delete_v1_monitors__monitor_id__delete","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]}},"/v1/monitors/{monitor_id}/events":{"get":{"tags":["Monitors"],"summary":"Monitor Events","operationId":"monitor_events_v1_monitors__monitor_id__events_get","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MonitorEvent"},"title":"Response Monitor Events V1 Monitors  Monitor Id  Events Get"},"example":[{"id":"evt-7a2b9c3d1e5f","monitor_id":"mon-1f6c2d9a4b7e","event_group_id":"grp-4d8e2f1a","summary":"2 new results for 'anthropic new model release'.","event_date":"2025-01-20T09:00:00+00:00","source_urls":["https://www.anthropic.com/news/claude-opus","https://techcrunch.com/2025/01/20/anthropic-claude"],"results":[{"url":"https://www.anthropic.com/news/claude-opus","title":"Introducing the next Claude model","excerpts":["The new model improves on coding and reasoning."],"publishedDate":"2025-01-20"}]}]}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]}},"/v1/monitors/{monitor_id}/run":{"post":{"tags":["Monitors"],"summary":"Monitor Run","description":"Trigger a monitor run immediately (handy for testing).","operationId":"monitor_run_v1_monitors__monitor_id__run_post","parameters":[{"name":"monitor_id","in":"path","required":true,"schema":{"type":"string","title":"Monitor Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorRunResult"},"example":{"monitorId":"mon-1f6c2d9a4b7e","event":{"id":"evt-7a2b9c3d1e5f","monitor_id":"mon-1f6c2d9a4b7e","event_group_id":"grp-4d8e2f1a","summary":"2 new results for 'anthropic new model release'.","event_date":"2025-01-20T09:00:00+00:00","source_urls":["https://www.anthropic.com/news/claude-opus","https://techcrunch.com/2025/01/20/anthropic-claude"],"results":[{"url":"https://www.anthropic.com/news/claude-opus","title":"Introducing the next Claude model","excerpts":["The new model improves on coding and reasoning."],"publishedDate":"2025-01-20"}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]}},"/v1/task":{"post":{"tags":["Tasks"],"summary":"Task Post","description":"Deep research -> a structured answer with a per-field citation basis.","operationId":"task_post_v1_task_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskRequest"},"example":{"task":"Find Anthropic's CEO and headquarters city.","output_schema":{"type":"object","properties":{"ceo":{"type":"string"},"headquarters":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskResponse"},"example":{"task":"Find Anthropic's CEO and headquarters city.","output":{"type":"json","content":{"ceo":"Dario Amodei","headquarters":"San Francisco, California"},"basis":[{"field":"ceo","citations":[{"url":"https://www.anthropic.com/company","title":"Anthropic - Company","excerpts":["Dario Amodei is the CEO and co-founder of Anthropic."]}],"reasoning":"The company's official site names Dario Amodei as CEO and co-founder.","confidence":"high"},{"field":"headquarters","citations":[{"url":"https://en.wikipedia.org/wiki/Anthropic","title":"Anthropic - Wikipedia","excerpts":["Anthropic is headquartered in San Francisco."]}],"reasoning":"Multiple sources place the headquarters in San Francisco, California.","confidence":"high"}],"source_stats":{"num_sources_considered":9,"num_sources_read":3,"sources_read_sample":["https://www.anthropic.com/company","https://en.wikipedia.org/wiki/Anthropic"]}},"credits":6}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]}},"/v1/tasks/runs":{"post":{"tags":["Tasks"],"summary":"Task Run Create","description":"Start an async web-research run. Returns a run_id immediately; poll\nGET /v1/tasks/runs/{run_id}, stream /events, or supply a webhook.","operationId":"task_run_create_v1_tasks_runs_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskRunRequest"},"example":{"task":"Find Anthropic's CEO and headquarters city.","webhook":"https://example.com/hooks/scout"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskRunView"},"example":{"run_id":"run-9c4f1a7be2d04e3a8f56","status":"queued","task":"Find Anthropic's CEO and headquarters city.","output":null,"error":null,"createdAt":"2025-01-20T14:03:11+00:00","completedAt":null,"credits":0}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]}},"/v1/tasks/runs/{run_id}":{"get":{"tags":["Tasks"],"summary":"Task Run Get","description":"Poll an async task run.","operationId":"task_run_get_v1_tasks_runs__run_id__get","parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"string","title":"Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskRunView"},"example":{"run_id":"run-9c4f1a7be2d04e3a8f56","status":"completed","task":"Find Anthropic's CEO and headquarters city.","output":{"type":"json","content":{"ceo":"Dario Amodei","headquarters":"San Francisco, California"},"basis":[{"field":"ceo","citations":[{"url":"https://www.anthropic.com/company","title":"Anthropic - Company","excerpts":["Dario Amodei is the CEO and co-founder of Anthropic."]}],"reasoning":"The company's official site names Dario Amodei as CEO and co-founder.","confidence":"high"},{"field":"headquarters","citations":[{"url":"https://en.wikipedia.org/wiki/Anthropic","title":"Anthropic - Wikipedia","excerpts":["Anthropic is headquartered in San Francisco."]}],"reasoning":"Multiple sources place the headquarters in San Francisco, California.","confidence":"high"}],"source_stats":{"num_sources_considered":9,"num_sources_read":3,"sources_read_sample":["https://www.anthropic.com/company","https://en.wikipedia.org/wiki/Anthropic"]}},"error":null,"createdAt":"2025-01-20T14:03:11+00:00","completedAt":"2025-01-20T14:03:48+00:00","credits":6}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]}},"/v1/tasks/runs/{run_id}/events":{"get":{"tags":["Tasks"],"summary":"Task Run Events","description":"Stream an async task run's progress as Server-Sent Events.","operationId":"task_run_events_v1_tasks_runs__run_id__events_get","parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"string","title":"Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]}},"/v1/chat/completions":{"post":{"tags":["Chat"],"summary":"Chat Completions","description":"OpenAI-compatible chat completions, grounded in live web research.","operationId":"chat_completions_v1_chat_completions_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatRequest"},"example":{"messages":[{"role":"user","content":"What did Anthropic announce this week?"}],"model":"scout-web"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCompletion"},"example":{"id":"chatcmpl-2b8f1d6a4c9e","object":"chat.completion","created":1737382991,"model":"scout-web","choices":[{"index":0,"message":{"role":"assistant","content":"This week Anthropic announced a new Claude model with improved coding and reasoning performance."},"finish_reason":"stop"}],"usage":{"prompt_tokens":14,"completion_tokens":28,"total_tokens":42}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]}},"/v1/findall":{"post":{"tags":["FindAll"],"summary":"Findall Post","description":"Enumerate every entity matching a description, as structured rows.","operationId":"findall_post_v1_findall_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindAllRequest"},"example":{"query":"S-1 stage AI infrastructure companies","fields":["name","website","headquarters"],"limit":20}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindAllResponse"},"example":{"query":"S-1 stage AI infrastructure companies","entities":[{"name":"CoreWeave","website":"https://coreweave.com","headquarters":"Livingston, New Jersey","source":"https://en.wikipedia.org/wiki/CoreWeave"},{"name":"Lambda","website":"https://lambdalabs.com","headquarters":"San Francisco, California","source":"https://lambdalabs.com/about"}],"count":2,"sources":["https://en.wikipedia.org/wiki/CoreWeave","https://lambdalabs.com/about"],"turns":7,"credits":7}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]}},"/v1/findall/runs":{"post":{"tags":["FindAll"],"summary":"Findall Run Create","description":"Start an async entity-discovery run. Returns a findall_id at once;\npoll GET /v1/findall/runs/{id}, stream /events, or supply a webhook.","operationId":"findall_run_create_v1_findall_runs_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindAllRunRequest"},"example":{"query":"S-1 stage AI infrastructure companies","fields":["name","website","headquarters"],"limit":20,"webhook":"https://example.com/hooks/scout"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindAllRunView"},"example":{"findall_id":"fa-37e97d4654d14fa6ad2fb342","status":"queued","query":"S-1 stage AI infrastructure companies","fields":["name","website","headquarters"],"entities":[],"count":0,"error":null,"createdAt":"2025-01-20T14:10:02+00:00","completedAt":null,"credits":0}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]}},"/v1/findall/runs/{findall_id}":{"get":{"tags":["FindAll"],"summary":"Findall Run Get","description":"Poll an async FindAll run; entities are included once it completes.","operationId":"findall_run_get_v1_findall_runs__findall_id__get","parameters":[{"name":"findall_id","in":"path","required":true,"schema":{"type":"string","title":"Findall Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindAllRunView"},"example":{"findall_id":"fa-37e97d4654d14fa6ad2fb342","status":"completed","query":"S-1 stage AI infrastructure companies","fields":["name","website","headquarters"],"entities":[{"name":"CoreWeave","website":"https://coreweave.com","headquarters":"Livingston, New Jersey","source":"https://en.wikipedia.org/wiki/CoreWeave"},{"name":"Lambda","website":"https://lambdalabs.com","headquarters":"San Francisco, California","source":"https://lambdalabs.com/about"}],"count":2,"error":null,"createdAt":"2025-01-20T14:10:02+00:00","completedAt":"2025-01-20T14:11:39+00:00","credits":7}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]}},"/v1/findall/runs/{findall_id}/events":{"get":{"tags":["FindAll"],"summary":"Findall Run Events","description":"Stream an async FindAll run's progress as Server-Sent Events.","operationId":"findall_run_events_v1_findall_runs__findall_id__events_get","parameters":[{"name":"findall_id","in":"path","required":true,"schema":{"type":"string","title":"Findall Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]}},"/v1/findall/runs/{findall_id}/cancel":{"post":{"tags":["FindAll"],"summary":"Findall Run Cancel","description":"Cancel an async FindAll run. A run already mid-flight stops at its\nnext checkpoint; its partial result is discarded.","operationId":"findall_run_cancel_v1_findall_runs__findall_id__cancel_post","parameters":[{"name":"findall_id","in":"path","required":true,"schema":{"type":"string","title":"Findall Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindAllRunView"},"example":{"findall_id":"fa-37e97d4654d14fa6ad2fb342","status":"cancelled","query":"S-1 stage AI infrastructure companies","fields":["name","website","headquarters"],"entities":[{"name":"CoreWeave","website":"https://coreweave.com","headquarters":"Livingston, New Jersey","source":"https://en.wikipedia.org/wiki/CoreWeave"},{"name":"Lambda","website":"https://lambdalabs.com","headquarters":"San Francisco, California","source":"https://lambdalabs.com/about"}],"count":2,"error":null,"createdAt":"2025-01-20T14:10:02+00:00","completedAt":"2025-01-20T14:11:39+00:00","credits":7}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]}},"/v1/findall/runs/{findall_id}/extend":{"post":{"tags":["FindAll"],"summary":"Findall Run Extend","description":"Continue a completed run - find more distinct entities and append\nthem. Returns the run re-queued; poll or stream it as usual.","operationId":"findall_run_extend_v1_findall_runs__findall_id__extend_post","parameters":[{"name":"findall_id","in":"path","required":true,"schema":{"type":"string","title":"Findall Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindAllExtendRequest"},"example":{"limit":20}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindAllRunView"},"example":{"findall_id":"fa-37e97d4654d14fa6ad2fb342","status":"completed","query":"S-1 stage AI infrastructure companies","fields":["name","website","headquarters"],"entities":[{"name":"CoreWeave","website":"https://coreweave.com","headquarters":"Livingston, New Jersey","source":"https://en.wikipedia.org/wiki/CoreWeave"},{"name":"Lambda","website":"https://lambdalabs.com","headquarters":"San Francisco, California","source":"https://lambdalabs.com/about"}],"count":2,"error":null,"createdAt":"2025-01-20T14:10:02+00:00","completedAt":"2025-01-20T14:11:39+00:00","credits":7}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]}},"/v1/findall/runs/{findall_id}/enrich":{"post":{"tags":["FindAll"],"summary":"Findall Run Enrich","description":"Enrich a completed run - research and add new data to every entity\nalready found, as plain fields or against a JSON Schema. Returns the\nrun re-queued; poll or stream it.","operationId":"findall_run_enrich_v1_findall_runs__findall_id__enrich_post","parameters":[{"name":"findall_id","in":"path","required":true,"schema":{"type":"string","title":"Findall Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindAllEnrichRequest"},"example":{"fields":["employee_count","founded_year"]}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindAllRunView"},"example":{"findall_id":"fa-37e97d4654d14fa6ad2fb342","status":"completed","query":"S-1 stage AI infrastructure companies","fields":["name","website","headquarters"],"entities":[{"name":"CoreWeave","website":"https://coreweave.com","headquarters":"Livingston, New Jersey","source":"https://en.wikipedia.org/wiki/CoreWeave"},{"name":"Lambda","website":"https://lambdalabs.com","headquarters":"San Francisco, California","source":"https://lambdalabs.com/about"}],"count":2,"error":null,"createdAt":"2025-01-20T14:10:02+00:00","completedAt":"2025-01-20T14:11:39+00:00","credits":7}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"apiKey":[]}]}}},"components":{"schemas":{"ChatChoice":{"properties":{"index":{"type":"integer","title":"Index"},"message":{"$ref":"#/components/schemas/ChatResponseMessage"},"finish_reason":{"type":"string","title":"Finish Reason"}},"type":"object","required":["index","message","finish_reason"],"title":"ChatChoice"},"ChatCompletion":{"properties":{"id":{"type":"string","title":"Id"},"object":{"type":"string","title":"Object","description":"Always 'chat.completion'."},"created":{"type":"integer","title":"Created","description":"Unix creation timestamp."},"model":{"type":"string","title":"Model"},"choices":{"items":{"$ref":"#/components/schemas/ChatChoice"},"type":"array","title":"Choices"},"usage":{"$ref":"#/components/schemas/ChatUsage"}},"type":"object","required":["id","object","created","model","choices","usage"],"title":"ChatCompletion"},"ChatMessage":{"properties":{"role":{"type":"string","title":"Role","description":"'system', 'user' or 'assistant'."},"content":{"type":"string","minLength":1,"title":"Content"}},"type":"object","required":["role","content"],"title":"ChatMessage"},"ChatRequest":{"properties":{"messages":{"items":{"$ref":"#/components/schemas/ChatMessage"},"type":"array","minItems":1,"title":"Messages","description":"OpenAI-style messages (system / user / assistant)."},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Echoed back in the response; does not affect routing."},"stream":{"type":"boolean","title":"Stream","description":"Streaming is not supported; a full response is returned.","default":false}},"type":"object","required":["messages"],"title":"ChatRequest"},"ChatResponseMessage":{"properties":{"role":{"type":"string","title":"Role","description":"Always 'assistant'."},"content":{"type":"string","title":"Content","description":"The assistant's reply."}},"type":"object","required":["role","content"],"title":"ChatResponseMessage"},"ChatUsage":{"properties":{"prompt_tokens":{"type":"integer","title":"Prompt Tokens"},"completion_tokens":{"type":"integer","title":"Completion Tokens"},"total_tokens":{"type":"integer","title":"Total Tokens"}},"type":"object","required":["prompt_tokens","completion_tokens","total_tokens"],"title":"ChatUsage"},"Citation":{"properties":{"url":{"type":"string","title":"Url","description":"URL of the cited source."},"title":{"type":"string","title":"Title","description":"Title of the cited source.","default":""},"excerpts":{"items":{"type":"string"},"type":"array","title":"Excerpts","description":"Verbatim excerpts from the source supporting the field."}},"type":"object","required":["url"],"title":"Citation"},"DeleteResult":{"properties":{"deleted":{"type":"string","title":"Deleted","description":"The id of the deleted resource."}},"type":"object","required":["deleted"],"title":"DeleteResult"},"ExtractRequestV1":{"properties":{"urls":{"items":{"type":"string"},"type":"array","maxItems":20,"minItems":1,"title":"Urls","description":"Public http(s) URLs to extract (1-20)."},"max_chars":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Max Chars","description":"Cap on the content characters returned for each URL."},"output_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Output Schema","description":"Optional JSON Schema. When set, each URL's content is additionally coerced into a structured object matching this schema, returned on the result's `data` field."}},"type":"object","required":["urls"],"title":"ExtractRequestV1"},"ExtractResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/ExtractResult"},"type":"array","title":"Results","description":"One result per requested URL, in order."},"credits":{"type":"integer","title":"Credits","description":"Cost - 2 credits per URL."}},"type":"object","required":["results","credits"],"title":"ExtractResponse"},"ExtractResult":{"properties":{"url":{"type":"string","title":"Url","description":"The URL that was extracted."},"title":{"type":"string","title":"Title","description":"The page title.","default":""},"content":{"type":"string","title":"Content","description":"Main page content, as markdown.","default":""},"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Data","description":"Structured extraction conforming to the request's output_schema. Present only when output_schema was set."},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error","description":"Present only when the URL failed to extract."}},"type":"object","required":["url"],"title":"ExtractResult"},"FieldBasis":{"properties":{"field":{"type":"string","title":"Field","description":"The output field this entry supports."},"citations":{"items":{"$ref":"#/components/schemas/Citation"},"type":"array","title":"Citations","description":"Citations supporting the field."},"reasoning":{"type":"string","title":"Reasoning","description":"How the cited sources support the field.","default":""},"confidence":{"type":"string","title":"Confidence","description":"Confidence level: high, medium or low.","default":"medium"}},"type":"object","required":["field"],"title":"FieldBasis"},"FindAllEnrichRequest":{"properties":{"fields":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Fields","description":"New data field names to add to every found entity."},"output_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Output Schema","description":"JSON Schema each enriched entity must conform to. Takes precedence over `fields`. One of fields or output_schema is required."}},"type":"object","title":"FindAllEnrichRequest"},"FindAllExtendRequest":{"properties":{"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"How many more entities to find.","default":20}},"type":"object","title":"FindAllExtendRequest"},"FindAllRequest":{"properties":{"query":{"type":"string","minLength":1,"title":"Query","description":"Description of the entity set to enumerate."},"fields":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Fields","description":"Column names for each entity row."},"output_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Output Schema","description":"Optional JSON Schema each entity object must conform to. Takes precedence over `fields` for typed rows."},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"Max entities to return.","default":20}},"type":"object","required":["query"],"title":"FindAllRequest"},"FindAllResponse":{"properties":{"query":{"type":"string","title":"Query","description":"The enumeration query."},"entities":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Entities","description":"Matched entities as structured rows."},"count":{"type":"integer","title":"Count","description":"Number of entities returned."},"sources":{"items":{"type":"string"},"type":"array","title":"Sources","description":"URLs retrieved during enumeration."},"turns":{"type":"integer","title":"Turns","description":"Agent steps taken."},"credits":{"type":"integer","title":"Credits","description":"Cost of the call."}},"type":"object","required":["query","entities","count","turns","credits"],"title":"FindAllResponse"},"FindAllRunRequest":{"properties":{"query":{"type":"string","minLength":1,"title":"Query","description":"Description of the entity set to enumerate."},"fields":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Fields","description":"Column names for each entity row."},"output_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Output Schema","description":"Optional JSON Schema each entity object must conform to. Takes precedence over `fields` for typed rows."},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"Max entities to find.","default":20},"webhook":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook","description":"If set, the finished run is POSTed here."}},"type":"object","required":["query"],"title":"FindAllRunRequest"},"FindAllRunView":{"properties":{"findall_id":{"type":"string","title":"Findall Id","description":"Opaque run identifier."},"status":{"type":"string","title":"Status","description":"queued, running, completed, failed or cancelled."},"query":{"type":"string","title":"Query","description":"The enumeration query."},"fields":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Fields","description":"The requested entity fields, if any."},"output_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Output Schema","description":"The JSON Schema for entity objects, if any."},"entities":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Entities","description":"Entities found so far (populated once completed)."},"count":{"type":"integer","title":"Count","description":"Number of entities found."},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error","description":"Failure reason when status is failed."},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Createdat","description":"ISO-8601 created."},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completedat","description":"ISO-8601 finished."},"credits":{"type":"integer","title":"Credits","description":"Cost accumulated by the run."}},"type":"object","required":["findall_id","status","query","entities","count","credits"],"title":"FindAllRunView"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Monitor":{"properties":{"id":{"type":"string","title":"Id","description":"Monitor identifier."},"query":{"type":"string","title":"Query","description":"The tracked query."},"cadence":{"type":"string","title":"Cadence","description":"hourly, daily or weekly."},"webhook":{"type":"string","title":"Webhook","description":"Where change events are delivered."},"country":{"type":"string","title":"Country"},"language":{"type":"string","title":"Language"},"status":{"type":"string","title":"Status","description":"active or paused."},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata","description":"Arbitrary caller metadata."},"createdAt":{"type":"string","title":"Createdat","description":"ISO-8601 creation timestamp."},"lastRunAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lastrunat","description":"ISO-8601 timestamp of the most recent run."},"nextRunAt":{"type":"string","title":"Nextrunat","description":"ISO-8601 timestamp of the next run."},"runs":{"type":"integer","title":"Runs","description":"How many times the monitor has run."}},"type":"object","required":["id","query","cadence","webhook","country","language","status","metadata","createdAt","nextRunAt","runs"],"title":"Monitor"},"MonitorCreate":{"properties":{"query":{"type":"string","minLength":1,"title":"Query","description":"What to track."},"webhook":{"type":"string","minLength":1,"title":"Webhook","description":"URL to POST events to."},"cadence":{"type":"string","title":"Cadence","description":"hourly | daily | weekly.","default":"daily"},"country":{"type":"string","title":"Country","description":"Two-letter country code.","default":"us"},"language":{"type":"string","title":"Language","description":"UI language code.","default":"en"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata","description":"Arbitrary caller metadata."}},"type":"object","required":["query","webhook"],"title":"MonitorCreate"},"MonitorEvent":{"properties":{"id":{"type":"string","title":"Id","description":"Event identifier."},"monitor_id":{"type":"string","title":"Monitor Id","description":"The monitor that produced it."},"event_group_id":{"type":"string","title":"Event Group Id"},"summary":{"type":"string","title":"Summary","description":"Human-readable summary."},"event_date":{"type":"string","title":"Event Date","description":"ISO-8601 timestamp the event fired."},"source_urls":{"items":{"type":"string"},"type":"array","title":"Source Urls","description":"URLs of the newly-found results."},"results":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Results","description":"The full new result objects."}},"type":"object","required":["id","monitor_id","event_group_id","summary","event_date","source_urls","results"],"title":"MonitorEvent"},"MonitorRunResult":{"properties":{"monitorId":{"type":"string","title":"Monitorid"},"event":{"anyOf":[{"$ref":"#/components/schemas/MonitorEvent"},{"type":"null"}],"description":"The change event, or null for a baseline / no-op run."}},"type":"object","required":["monitorId"],"title":"MonitorRunResult"},"MonitorUpdate":{"properties":{"cadence":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cadence","description":"hourly | daily | weekly."},"webhook":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook","description":"New webhook URL."},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"active | paused."}},"type":"object","title":"MonitorUpdate"},"SearchRequestV1":{"properties":{"queries":{"items":{"type":"string"},"type":"array","maxItems":5,"minItems":1,"title":"Queries","description":"Keyword search queries to run; their results are merged and de-duplicated. Provide 1-5."},"depth":{"type":"string","enum":["fast","deep"],"title":"Depth","description":"'fast' for lowest latency, 'deep' to gather and merge more candidates per query.","default":"fast"},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","description":"Maximum merged results to return.","default":10},"country":{"type":"string","title":"Country","description":"Two-letter country code to localize results.","default":"us"},"language":{"type":"string","title":"Language","description":"UI language code.","default":"en"},"freshness":{"anyOf":[{"type":"string","enum":["hour","day","week","month","year"]},{"type":"null"}],"title":"Freshness","description":"Restrict to recent results: hour, day, week, month or year."},"include_domains":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Include Domains","description":"Only return results whose URL is on these domains."},"exclude_domains":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Exclude Domains","description":"Drop results whose URL is on these domains."},"max_excerpt_chars":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Max Excerpt Chars","description":"Cap on total excerpt characters across all results."}},"type":"object","required":["queries"],"title":"SearchRequestV1"},"SearchResponse":{"properties":{"queries":{"items":{"type":"string"},"type":"array","title":"Queries","description":"The queries that were run."},"results":{"items":{"$ref":"#/components/schemas/SearchResult"},"type":"array","title":"Results","description":"Merged, de-duplicated results across all queries."},"credits":{"type":"integer","title":"Credits","description":"Cost - one credit per query."}},"type":"object","required":["queries","results","credits"],"title":"SearchResponse"},"SearchResult":{"properties":{"url":{"type":"string","title":"Url","description":"Result page URL - use it as the citation."},"title":{"type":"string","title":"Title","description":"The page title.","default":""},"excerpts":{"items":{"type":"string"},"type":"array","title":"Excerpts","description":"Excerpt text relevant to the query."},"publishedDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Publisheddate","description":"Publication date, when the source exposes one."}},"type":"object","required":["url"],"title":"SearchResult"},"SourceStats":{"properties":{"num_sources_considered":{"type":"integer","title":"Num Sources Considered","description":"Distinct sources the agent encountered."},"num_sources_read":{"type":"integer","title":"Num Sources Read","description":"Sources the agent fetched in full."},"sources_read_sample":{"items":{"type":"string"},"type":"array","title":"Sources Read Sample","description":"A sample of read source URLs."}},"type":"object","required":["num_sources_considered","num_sources_read"],"title":"SourceStats"},"TaskOutput":{"properties":{"type":{"type":"string","title":"Type","description":"\"text\" or \"json\"."},"content":{"title":"Content","description":"The answer - a string, or a JSON object."},"basis":{"items":{"$ref":"#/components/schemas/FieldBasis"},"type":"array","title":"Basis","description":"Per-field citation basis."},"source_stats":{"$ref":"#/components/schemas/SourceStats","description":"Research source stats."}},"type":"object","required":["type","content","basis","source_stats"],"title":"TaskOutput"},"TaskRequest":{"properties":{"task":{"type":"string","minLength":1,"title":"Task","description":"The natural-language objective."},"output_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Output Schema","description":"Optional desired output JSON schema."}},"type":"object","required":["task"],"title":"TaskRequest"},"TaskResponse":{"properties":{"task":{"type":"string","title":"Task","description":"The objective that was run."},"output":{"$ref":"#/components/schemas/TaskOutput","description":"The structured answer."},"credits":{"type":"integer","title":"Credits","description":"Cost of the call."}},"type":"object","required":["task","output","credits"],"title":"TaskResponse"},"TaskRunRequest":{"properties":{"task":{"type":"string","minLength":1,"title":"Task","description":"The natural-language objective."},"output_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Output Schema","description":"Optional desired output JSON schema."},"webhook":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook","description":"If set, the completed (or failed) run is POSTed here."}},"type":"object","required":["task"],"title":"TaskRunRequest"},"TaskRunView":{"properties":{"run_id":{"type":"string","title":"Run Id","description":"Opaque run identifier."},"status":{"type":"string","title":"Status","description":"queued, running, completed or failed."},"task":{"type":"string","title":"Task","description":"The objective."},"output":{"anyOf":[{"$ref":"#/components/schemas/TaskOutput"},{"type":"null"}],"description":"The answer once completed; null until then."},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error","description":"Failure reason when status is failed."},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Createdat","description":"ISO-8601 creation timestamp."},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completedat","description":"ISO-8601 completion timestamp."},"credits":{"type":"integer","title":"Credits","description":"Cost accumulated by the run."}},"type":"object","required":["run_id","status","task","credits"],"title":"TaskRunView"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"Your API key, sent as a Bearer token."}}},"tags":[{"name":"Search","description":"Rank the live web for a query; results carry excerpts."},{"name":"Extract","description":"Turn public URLs into clean, LLM-ready markdown."},{"name":"Tasks","description":"Deep web research - synchronous tasks and async runs, each answer carrying a per-field citation basis."},{"name":"FindAll","description":"Enumerate every entity matching a description, as rows."},{"name":"Chat","description":"OpenAI-compatible chat completions, web-grounded."},{"name":"Monitors","description":"Track a query on a schedule; webhook new results."}]}