Edgar

{'type': 'object', 'examples': [{'entity': 'Tesla'}], 'required': ['entity'], 'properties': {'entity': {'type': 'string', 'description': 'The thing to ask about. Brand/business name, product name, person, or topic. E.g. "Pipeworx", "OpenInvoice", "Acme Corp pricing".'}, 'models': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Which models to probe. Supported: "workers-ai" (free default), "anthropic" (requires _apiKey). Omit for just workers-ai.'}, '_apiKey': {'type': 'string', 'description': 'Optional Anthropic API key (sk-ant-...) â\x80\x94 only needed if "anthropic" is in models. Passed straight through to api.anthropic.com.'}, 'context': {'type': 'string', 'description': 'Optional: a phrase locating the entity (e.g. "Boston restaurant", "B2B SaaS"). Helps disambiguate common names.'}}}

{'type': 'object', 'examples': [{'question': "What was Apple's revenue in 2024?"}, {'question': 'Any recent SEC filings for $NVDA?'}, {'question': 'Current price of bitcoin'}], 'required': ['question'], 'properties': {'q': {'type': 'string', 'description': 'Alias for question.'}, 'ask': {'type': 'string', 'description': 'Alias for question.'}, 'text': {'type': 'string', 'description': 'Alias for question.'}, 'input': {'type': 'string', 'description': 'Alias for question.'}, 'query': {'type': 'string', 'description': 'Alias for question.'}, 'prompt': {'type': 'string', 'description': 'Alias for question.'}, 'message': {'type': 'string', 'description': 'Alias for question.'}, 'question': {'type': 'string', 'description': 'Your question or request in natural language. Accepts query, q, prompt, text, input, ask, message as aliases.'}}}

{'type': 'object', 'examples': [{'question': 'What is the current US unemployment rate?'}], 'required': ['question'], 'properties': {'q': {'type': 'string', 'description': 'Alias for question.'}, 'ask': {'type': 'string', 'description': 'Alias for question.'}, 'text': {'type': 'string', 'description': 'Alias for question.'}, 'input': {'type': 'string', 'description': 'Alias for question.'}, 'query': {'type': 'string', 'description': 'Alias for question.'}, 'prompt': {'type': 'string', 'description': 'Alias for question.'}, 'message': {'type': 'string', 'description': 'Alias for question.'}, 'question': {'type': 'string', 'description': 'Your question or request in natural language. Accepts query, q, prompt, text, input, ask, message as aliases.'}}}

{'type': 'object', 'examples': [{'question': "What was Apple's fiscal 2023 revenue?"}], 'required': ['question'], 'properties': {'q': {'type': 'string', 'description': 'Alias for question.'}, 'ask': {'type': 'string', 'description': 'Alias for question.'}, 'text': {'type': 'string', 'description': 'Alias for question.'}, 'input': {'type': 'string', 'description': 'Alias for question.'}, 'query': {'type': 'string', 'description': 'Alias for question.'}, 'prompt': {'type': 'string', 'description': 'Alias for question.'}, 'message': {'type': 'string', 'description': 'Alias for question.'}, 'question': {'type': 'string', 'description': 'Your question in natural language. Accepts query, q, prompt, text, input, ask, message as aliases.'}}}

{'type': 'object', 'examples': [{'market': 'will-kristi-noem-win-the-2028-republican-presidential-nomination'}, {'market': 'https://polymarket.com/event/will-kristi-noem-win-the-2028-republican-presidential-nomination'}], 'required': ['market'], 'properties': {'depth': {'enum': ['quick', 'thorough'], 'type': 'string', 'description': 'quick = 2-3 evidence sources, thorough = full fan-out. Default thorough.'}, 'market': {'type': 'string', 'description': 'Polymarket slug ("will-kristi-noem-win-the-2028-republican-presidential-nomination"), full URL ("https://polymarket.com/event/..."), or question text ("Will Bitcoin hit $150k?"). Dated slugs stop resolving once they settle â\x80\x94 Polymarket de-indexes resolved markets â\x80\x94 so prefer an undated one.'}, 'include_raw': {'type': 'boolean', 'description': 'Default false. When false (recommended), FRED/FDA/GDELT/Federal-Register evidence is summarized to the few fields agents actually use â\x80\x94 keeps responses under ~20KB. Pass true to get full upstream payloads (50KB-500KB) when you need to recompute deltas, cite specific observations, or post-process.'}}}

{'type': 'object', 'examples': [{'period': {'type': 'annual', 'fiscal_year': 2023}, 'company': 'AAPL', 'attribute': 'revenue'}], 'required': ['company', 'attribute', 'period'], 'properties': {'as_of': {'type': 'string', 'description': 'Past ISO timestamp with timezone. Replay the latest answer actually recorded by that instant; no invented history or live fallback.'}, 'basis': {'enum': ['consolidated'], 'type': 'string', 'description': 'Only "consolidated" in v1. Segment and product-level figures are XBRL-dimensioned and are not reachable through this contract at any concept.'}, 'period': {'type': 'object', 'required': ['type', 'fiscal_year'], 'properties': {'type': {'enum': ['annual', 'quarterly'], 'type': 'string', 'description': '"annual" = the full fiscal year. "quarterly" = ONE discrete quarter, never a year-to-date figure.'}, 'fiscal_year': {'type': 'number', 'description': "The FILER'S fiscal year â\x80\x94 the year the period ends in by their own calendar. Walmart's year ending 2026-01-31 is 2026."}, 'fiscal_quarter': {'type': 'number', 'description': '1-4. Required when type is "quarterly"; rejected when type is "annual".'}}, 'description': 'The reporting period, stated explicitly. There is no default and no "latest" â\x80\x94 that is the point of this tool.'}, 'company': {'type': 'string', 'description': 'Ticker ("AAPL"), 10-digit CIK ("0000320193"), or company name. A name that matches two filers equally well returns status "ambiguous" with both named rather than guessing â\x80\x94 pass a ticker or CIK to be certain.'}, 'max_age': {'type': 'number', 'maximum': 3155760000, 'minimum': 0, 'description': 'Maximum age in seconds of the upstream publication, not our fetch. Older or undated facts are withheld.'}, 'attribute': {'enum': ['revenue', 'net_income', 'cash'], 'type': 'string', 'description': 'Which figure. "revenue" = total consolidated revenue; "net_income" = net income (loss); "cash" = cash and cash equivalents at the period end.'}, 'freshness': {'enum': ['cached', 'fresh'], 'type': 'string', 'description': 'cached (default) permits an eligible stored answer; fresh requires an upstream refresh and never silently falls back to stale data.'}, 'restatement': {'enum': ['as_amended', 'as_originally_reported'], 'type': 'string', 'description': 'Default "as_amended" â\x80\x94 the latest filed figure for the period, with everything it superseded listed. "as_originally_reported" takes the first filing instead.'}, 'exclude_publishers': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Publisher ids forbidden for fact retrieval: sec, fmp, alphavantage. Case and surrounding whitespace are normalized; unknown ids are refused. Excluding sec currently leaves no eligible fact source and returns unavailable/sources_excluded with the selection reasons. Identity and fiscal-calendar lookups may still use SEC; no excluded financial concept is fetched.'}}}

{'type': 'object', 'examples': [{'type': 'company', 'values': ['AAPL', 'MSFT']}], 'required': ['type', 'values'], 'properties': {'type': {'enum': ['company', 'drug'], 'type': 'string', 'description': 'Entity type: "company" or "drug".'}, 'values': {'type': 'array', 'items': {'type': 'string'}, 'maxItems': 5, 'minItems': 2, 'description': 'For company: 2â\x80\x935 tickers/CIKs (e.g., ["AAPL","MSFT"]). For drug: 2â\x80\x935 names (e.g., ["ozempic","mounjaro"]).'}}}

{'type': 'object', 'examples': [{'depth': 'quick', 'question': 'What is the current US unemployment rate and how has it changed over the past year?'}], 'required': ['question'], 'properties': {'q': {'type': 'string', 'description': 'Alias for question.'}, 'ask': {'type': 'string', 'description': 'Alias for question.'}, 'text': {'type': 'string', 'description': 'Alias for question.'}, 'depth': {'enum': ['quick', 'standard', 'thorough'], 'type': 'string', 'description': 'How many facets to research in parallel: quick=3 (single hop), standard=3 (default; adds a gap-recovery hop that re-angles unanswered facets + a contradictions[] scan across findings), thorough=6 (paid; adds a full iterative hop that chases leads + recovers gaps, plus the contradictions[] scan).'}, 'input': {'type': 'string', 'description': 'Alias for question.'}, 'query': {'type': 'string', 'description': 'Alias for question.'}, 'prompt': {'type': 'string', 'description': 'Alias for question.'}, 'message': {'type': 'string', 'description': 'Alias for question.'}, 'question': {'type': 'string', 'description': 'The research question, in natural language. Broad/multi-part is fine â\x80\x94 decomposition is the point. Accepts query, q, prompt, text, input, ask, message as aliases.'}}}

{'type': 'object', 'examples': [{'query': 'look up FDA drug approvals'}, {'query': 'analyze housing market trends'}], 'required': ['query'], 'properties': {'q': {'type': 'string', 'description': 'Alias for query.'}, 'task': {'type': 'string', 'description': 'Alias for query.'}, 'limit': {'type': 'number', 'description': 'Maximum number of tools to return (default 20, max 50)'}, 'query': {'type': 'string', 'description': 'Natural language description of what you want to do (e.g., "analyze housing market trends", "look up FDA drug approvals", "find trade data between countries"). Accepts task, q, description, search as aliases.'}, 'search': {'type': 'string', 'description': 'Alias for query.'}, 'description': {'type': 'string', 'description': 'Alias for query.'}}}

{'type': 'object', 'examples': [{'ticker_or_cik': 'AAPL'}, {'sic': '2836', 'limit': 10}], 'properties': {'cik': {'type': 'string', 'description': 'Alias for `ticker_or_cik` â\x80\x94 takes a ticker or a CIK. Declared because sibling SEC tools spell this argument differently.'}, 'sic': {'type': 'string', 'description': 'SIC code to search directly, e.g. "3571" (Electronic Computers), "2836" (Biological Products), "6021" (National Commercial Banks). Provide this OR ticker_or_cik.'}, 'limit': {'type': 'number', 'description': 'Max peers to return (1-100, default 25).'}, 'ticker': {'type': 'string', 'description': 'Alias for `ticker_or_cik` â\x80\x94 takes a ticker or a CIK. Declared because sibling SEC tools spell this argument differently.'}, 'form_type': {'type': 'string', 'description': 'Only include filers who have filed this form type (default "10-K" â\x80\x94 active public reporters). SEC\'s upstream search is unreliable with this left blank.'}, 'exclude_self': {'type': 'boolean', 'description': 'When resolving via ticker_or_cik, exclude that company itself from the peer list. Default true.'}, 'ticker_or_cik': {'type': 'string', 'description': 'Ticker (e.g. "AAPL") or CIK of a company whose SIC should be resolved first, then used to find its peers. Provide this OR sic. Aliases: `cik`, `ticker`.'}}}

{'type': 'object', 'examples': [{'cik': '320193', 'concept': 'Revenue'}, {'cik': '1652044', 'concept': 'NetIncomeLoss'}, {'cik': 'DOV', 'period': 'annual', 'concept': 'NetIncomeLoss', 'fiscal_year': '2024', 'fiscal_period': 'FY'}], 'required': [], 'properties': {'cik': {'type': 'string', 'description': 'REQUIRED (or one of its aliases `ticker` / `ticker_or_cik`). Ticker (e.g., "AAPL") or CIK number (e.g., "320193"). Tickers are auto-resolved.'}, 'metric': {'type': 'string', 'description': "Alias for `concept` â\x80\x94 the word this tool's own description uses for the thing you are asking about."}, 'period': {'enum': ['all', 'annual', 'quarterly'], 'type': 'string', 'description': 'Which reporting periods to return: "all" (default â\x80\x94 annual 10-K + quarterly 10-Q), "annual" (10-K/20-F/40-F only), or "quarterly" (10-Q only). Point-in-time metrics (cash/runway/debt) usually want the default so the freshest quarter is included; use "annual" for clean year-over-year trends.'}, 'ticker': {'type': 'string', 'description': 'Alias for `cik` â\x80\x94 same thing, a ticker or a CIK. Declared because sibling SEC tools name this argument differently (edgar_fund_holdings uses `ticker`, edgar_company_filings uses `ticker_or_cik`) and a caller filling arguments from prose reaches for whichever it read; all three spellings work here.'}, 'concept': {'type': 'string', 'description': 'REQUIRED (alias `metric`). Metric name. Common: "Revenue" / "Revenues", "NetIncomeLoss", "Cash", "Assets", "Liabilities", "StockholdersEquity", "EarningsPerShareDiluted", "LongTermDebt".'}, 'fiscal_year': {'type': 'string', 'description': 'Optional filter: return only rows for this fiscal year, e.g. "2024". This is the filer\'s OWN fiscal year label (NVDA\'s FY2024 ended Jan 2024), not a calendar year. Unmatched years are reported with the years that ARE available rather than as an empty result.'}, 'fiscal_period': {'enum': ['FY', 'Q1', 'Q2', 'Q3', 'Q4'], 'type': 'string', 'description': 'Optional filter: return only rows for this period within the fiscal year â\x80\x94 "FY" (annual), "Q1", "Q2", "Q3", or "Q4" (derived: FY minus Q1-Q3). Combine with fiscal_year for a single figure.'}, 'ticker_or_cik': {'type': 'string', 'description': 'Alias for `cik` â\x80\x94 the spelling used by edgar_company_filings, edgar_insider_transactions and edgar_product_revenue.'}}}

{'type': 'object', 'required': ['cik', 'company_name', 'concept', 'label', 'description', 'annual_values'], 'properties': {'cik': {'type': 'string', 'description': 'Company CIK number'}, 'label': {'type': 'string', 'description': 'Human-readable concept label'}, 'concept': {'type': 'string', 'description': 'US-GAAP concept tag name'}, 'description': {'type': 'string', 'description': 'Detailed concept description'}, 'company_name': {'type': 'string', 'description': 'Official company name'}, 'annual_values': {'type': 'array', 'items': {'type': 'object', 'properties': {'unit': {'type': 'string', 'description': 'Unit of measurement (e.g., USD, shares)'}, 'filed': {'type': 'string', 'description': 'Date filing was submitted'}, 'value': {'type': 'number', 'description': 'Reported value'}, 'period_end': {'type': 'string', 'description': 'Period end date in YYYY-MM-DD format'}, 'fiscal_year': {'type': 'number', 'description': 'Fiscal year'}}}, 'description': 'Annual values sorted by fiscal year descending'}}}

{'type': 'object', 'examples': [{'cik': '320193'}], 'required': [], 'properties': {'cik': {'type': 'string', 'description': 'REQUIRED (or one of its aliases `ticker` / `ticker_or_cik`). Ticker ("NVDA") or CIK number ("320193"). Tickers are auto-resolved to CIKs internally.'}, 'ticker': {'type': 'string', 'description': 'Alias for `cik` â\x80\x94 same thing, a ticker or a CIK. The spelling edgar_fund_holdings and edgar_ticker_to_cik use.'}, 'ticker_or_cik': {'type': 'string', 'description': 'Alias for `cik` â\x80\x94 the spelling edgar_company_filings, edgar_insider_transactions and edgar_product_revenue use.'}}}

{'type': 'object', 'required': ['cik', 'company_name', 'latest_annual', 'key_financials', 'stale_concepts', 'available_concepts'], 'properties': {'cik': {'type': 'string', 'description': 'Company CIK number'}, 'year_note': {'type': 'string', 'description': 'How `year` is derived'}, 'company_name': {'type': 'string', 'description': 'Official company name'}, 'latest_annual': {'type': 'object', 'description': 'Canonical line items for the most recent fiscal year â\x80\x94 revenue, net_income, operating_income, gross_profit, total_assets, total_liabilities, stockholders_equity, cash_and_equivalents, eps_basic, eps_diluted, shares_outstanding, research_and_development â\x80\x94 each resolved to whichever concept the filer currently reports under; null when the filer reports no current value', 'additionalProperties': {'type': ['object', 'null'], 'required': ['year', 'value', 'filed', 'period_end', 'form', 'unit', 'concept'], 'properties': {'form': {'type': 'string', 'description': 'Annual-report form the value came from (10-K, 10-K/A, 20-F, 40-F)'}, 'unit': {'type': 'string', 'description': 'XBRL unit: USD, USD/shares, shares, or pure'}, 'year': {'type': 'number', 'description': "Fiscal year the reporting period ENDS in, derived from period_end (NOT the SEC fy filing-year field, which stamps prior-year comparatives with the restating filing's year)"}, 'filed': {'type': 'string', 'description': 'Date the filing was submitted (YYYY-MM-DD)'}, 'value': {'type': 'number', 'description': 'Metric value in `unit`'}, 'concept': {'type': 'string', 'description': 'The us-gaap concept this value was read from â\x80\x94 the one the filer currently reports this line under'}, 'period_end': {'type': 'string', 'description': 'Period end / balance-sheet date (YYYY-MM-DD)'}, 'period_start': {'type': 'string', 'description': 'Period start (YYYY-MM-DD); present for duration concepts such as revenue, absent for balance-sheet instants'}}, 'description': 'Most recent annual (10-K/20-F/40-F) value, or null when the filer reports no annual value for this concept'}}, 'key_financials': {'type': 'object', 'description': 'Per-concept detail. Current concepts first, retired (stale) concepts last â\x80\x94 a stale concept is kept because a historical series still needs it, never silently dropped', 'additionalProperties': {'type': 'object', 'required': ['label', 'most_recent_annual', 'stale'], 'properties': {'label': {'type': 'string', 'description': 'Human-readable label for the XBRL concept'}, 'stale': {'type': 'boolean', 'description': "true when this concept's latest annual period ends before the filer's latest annual report â\x80\x94 the filer stopped reporting it (e.g. a pre-ASC-606 Revenues tag). Real history, not the current figure"}, 'stale_note': {'type': 'string', 'description': "Present when stale: which fiscal year the concept stops at, what the filer's latest report covers, and which current concept in latest_annual replaces it"}, 'most_recent_annual': {'type': ['object', 'null'], 'required': ['year', 'value', 'filed', 'period_end', 'form', 'unit'], 'properties': {'form': {'type': 'string', 'description': 'Annual-report form the value came from (10-K, 10-K/A, 20-F, 40-F)'}, 'unit': {'type': 'string', 'description': 'XBRL unit: USD, USD/shares, shares, or pure'}, 'year': {'type': 'number', 'description': "Fiscal year the reporting period ENDS in, derived from period_end (NOT the SEC fy filing-year field, which stamps prior-year comparatives with the restating filing's year)"}, 'filed': {'type': 'string', 'description': 'Date the filing was submitted (YYYY-MM-DD)'}, 'value': {'type': 'number', 'description': 'Metric value in `unit`'}, 'period_end': {'type': 'string', 'description': 'Period end / balance-sheet date (YYYY-MM-DD)'}, 'period_start': {'type': 'string', 'description': 'Period start (YYYY-MM-DD); present for duration concepts such as revenue, absent for balance-sheet instants'}}, 'description': 'Most recent annual (10-K/20-F/40-F) value, or null when the filer reports no annual value for this concept'}}}}, 'stale_concepts': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Concepts the filer has stopped reporting; present in key_financials flagged stale, never used in latest_annual'}, 'latest_period_end': {'type': ['string', 'null'], 'description': 'Period end of that most recent annual report (YYYY-MM-DD)'}, 'available_concepts': {'type': 'number', 'description': 'Total number of US-GAAP financial concepts available for this company'}, 'latest_fiscal_year': {'type': ['number', 'null'], 'description': "Fiscal year of the filer's most recent annual report across every concept examined"}}}

{'type': 'object', 'examples': [{'limit': 15, 'form_type': '10-Q', 'ticker_or_cik': 'AAPL'}, {'limit': 20, 'ticker_or_cik': '320193'}, {'form_type': '8-K', 'ticker_or_cik': 'Amyris'}], 'required': [], 'properties': {'cik': {'type': 'string', 'description': 'Alias for `ticker_or_cik` â\x80\x94 the spelling edgar_company_concept and edgar_company_facts use for the same thing. Takes a ticker or a CIK.'}, 'limit': {'type': 'number', 'description': 'Max filings to return (1-40, default 20)'}, 'ticker': {'type': 'string', 'description': 'Alias for `ticker_or_cik` â\x80\x94 the spelling edgar_fund_holdings and edgar_ticker_to_cik use for the same thing. Takes a ticker or a CIK.'}, 'form_type': {'type': 'string', 'description': 'Filter by SEC form type (e.g., "10-K", "10-Q", "8-K"). Omit for all types.'}, 'ticker_or_cik': {'type': 'string', 'description': 'REQUIRED (or one of its aliases `cik` / `ticker`). Ticker symbol (e.g., "AAPL") or CIK number (e.g., "320193")'}}}

{'type': 'object', 'required': ['cik', 'company_name', 'tickers', 'sic_description', 'state_of_incorporation', 'fiscal_year_end', 'filter_form_type', 'filings'], 'properties': {'cik': {'type': 'string', 'description': 'Company CIK number'}, 'sic': {'type': 'string', 'description': 'SEC Standard Industrial Classification CODE, 4 digits (e.g. "2836" Biological Products, "3571" Electronic Computers). The machine-readable twin of sic_description - branch on this, not on the prose.'}, 'filings': {'type': 'array', 'items': {'type': 'object', 'properties': {'form': {'type': 'string', 'description': 'SEC form type'}, 'filing_date': {'type': 'string', 'description': 'Date filing was submitted'}, 'document_url': {'type': 'string', 'description': 'URL to access the filing document'}, 'accession_number': {'type': 'string', 'description': 'SEC accession number'}, 'primary_document': {'type': 'string', 'description': 'Primary document filename'}}}}, 'tickers': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Associated ticker symbols'}, 'company_name': {'type': 'string', 'description': 'Official company name'}, 'fiscal_year_end': {'type': 'string', 'description': 'Fiscal year end date'}, 'sic_description': {'type': 'string', 'description': 'Standard Industrial Classification description'}, 'filter_form_type': {'type': 'string', 'description': "Form type filter applied or 'all'"}, 'state_of_incorporation': {'type': 'string', 'description': 'State where company is incorporated'}}}

{'type': 'object', 'examples': [{'ticker_or_cik': 'AAPL'}, {'form_type': '10-K', 'filings_limit': 5, 'ticker_or_cik': 'NVDA'}], 'required': [], 'properties': {'cik': {'type': 'string', 'description': 'Alias for `ticker_or_cik` â\x80\x94 same thing. The spelling edgar_company_facts and edgar_company_concept use.'}, 'ticker': {'type': 'string', 'description': 'Alias for `ticker_or_cik` â\x80\x94 same thing. The spelling edgar_ticker_to_cik uses.'}, 'form_type': {'type': 'string', 'description': 'Which filings to list. Omit for the substantive default set (10-K, 10-K/A, 10-Q, 10-Q/A, 8-K, 20-F, 40-F, 6-K, DEF 14A). Pass one form ("10-K") to list only that form, or "all" for every form including Form 4 insider filings.'}, 'filings_limit': {'type': 'number', 'description': 'How many filings to return after the form filter (1-40, default 10).'}, 'ticker_or_cik': {'type': 'string', 'description': 'REQUIRED (or one of its aliases `cik` / `ticker`). Ticker ("AAPL"), company name ("Apple Inc") or CIK ("320193"). Tickers and names are resolved to a CIK internally.'}}}

{'type': 'object', 'examples': [{'ticker': 'AAPL', 'form_type': '10-K', 'include_primary_text': True}, {'ticker': 'AAPL', 'accession': '0000320193-25-000079'}], 'required': [], 'properties': {'cik': {'type': 'string', 'description': 'The filer\'s CIK number (e.g. "320193"). Provide this OR ticker.'}, 'ticker': {'type': 'string', 'description': 'The filer\'s ticker (e.g. "AAPL", "NVDA") or company name. Provide this OR cik. Tickers are auto-resolved to CIKs.'}, 'accession': {'type': 'string', 'description': 'Optional SEC accession number of a specific filing, with or without dashes (e.g. "0000320193-25-000079"). Omit it to auto-resolve the latest filing â\x80\x94 pass form_type instead.'}, 'form_type': {'type': 'string', 'description': 'When accession is omitted, the form type of the latest filing to fetch, e.g. "10-K", "10-Q", "8-K", "DEF 14A" â\x80\x94 or a `|`-separated SET ("10-K|10-Q") for "the most recent of either, whichever is newer". Omit both accession and form_type to get the single most recent filing of ANY type at all (routine 8-Ks/Form 4s/Form 144s included, not just annual/quarterly reports) â\x80\x94 use the `|` set instead when you specifically want the newest 10-K or 10-Q.'}, 'ticker_or_cik': {'type': 'string', 'description': 'Alias for `ticker` / `cik` â\x80\x94 the single-argument spelling edgar_company_filings and edgar_insider_transactions use. Takes either a ticker or a CIK.'}, 'include_primary_text': {'type': 'boolean', 'description': 'When true, also fetch the primary document and return its text (HTML stripped to plaintext, truncated to ~40,000 chars). Default false. For the FULL, pageable document text â\x80\x94 or just one section like going-concern/liquidity â\x80\x94 use edgar_filing_text instead.'}}}

{'type': 'object', 'examples': [{'ticker': 'ACTU', 'section': 'liquidity', 'form_type': '10-Q'}, {'cik': '1652935', 'section': 'going_concern', 'accession': '0001683168-26-003909', 'max_chars': 30000}, {'search': 'processed approximately', 'ticker': 'NTRA', 'accession': '0001628280-26-054525'}], 'required': [], 'properties': {'cik': {'type': 'string', 'description': 'Filer CIK number (e.g. "1652935"). Provide this OR ticker.'}, 'find': {'type': 'string', 'description': 'Alias for `search`.'}, 'offset': {'type': 'number', 'description': "Character offset to start from (default 0). Pass the prior result's next_offset to page forward."}, 'phrase': {'type': 'string', 'description': 'Alias for `search`.'}, 'search': {'type': 'string', 'description': 'Find a specific fact instead of paging blind. Pass a short 2-4 word phrase likely to appear VERBATIM in the prose ("processed approximately", "tests processed", "going concern") rather than restating the question. Case-insensitive substring match over the WHOLE document text (or the whole `section` slice), run BEFORE max_chars/offset windowing; returns matching passages (context + their own offset) instead of the paged `text`, ranking passages with a nearby figure first. If a multi-word phrase has no verbatim match, it falls back to the phrase\'s individual words and returns the passages holding the most of them (search.match_mode "words") â\x80\x94 read those passages for the fact rather than treating them as confirmed. Use a returned offset with a follow-up call (no `search`) to read more surrounding text. **For TWO OR MORE facts from this same filing in one call, separate phrases with `|`** (e.g. "Signatera revenue|tests processed") â\x80\x94 each is searched independently and reported under `searches[]`, keyed by `phrase`, instead of the singular `search`. This is the way to answer a compound question ("what was revenue AND test volume in the latest 10-Q") without a second call. Note: a phrase naming a financial TOTAL (revenue, net income, EPS, assets, cash, gross/operating profit, long-term debt, stockholders equity, shares outstanding) often has NO verbatim match at all, because filers frequently state only the growth delta/percentage in prose and report the actual total exclusively in XBRL â\x80\x94 when a phrase names one of these, the response also attaches that concept\'s value for THIS SAME accession under `xbrl` (sourced like edgar_company_concept, not text-matched), so you don\'t need a separate edgar_company_concept call just to get the number the text search alone would report as a false "not found". Accepted aliases: `contains`, `find`, `phrase`.'}, 'ticker': {'type': 'string', 'description': 'Filer ticker (e.g. "ACTU"). Provide this OR cik. ONLY pass a ticker you are CERTAIN of â\x80\x94 a wrong remembered ticker silently retrieves a DIFFERENT company\'s filing as a clean success (a "SpaceX" question filled with SPCE returns Virgin Galactic\'s S-1). For a recent IPO or any uncertain ticker, resolve first: edgar_company_filings accepts the company NAME and returns the cik â\x80\x94 pass that cik here.'}, 'section': {'enum': ['going_concern', 'liquidity', 'capital_resources', 'subsequent_events'], 'type': 'string', 'description': 'Return only this section (located by heading). Omit for the whole document. Unmatched sections fall back to the whole document (section_found:false).'}, 'contains': {'type': 'string', 'description': 'Alias for `search`.'}, 'accession': {'type': 'string', 'description': 'SEC accession number, dashed or not (e.g. "0001683168-26-003909"). Omit to auto-resolve the latest filing of form_type for the given ticker/cik.'}, 'form_type': {'type': 'string', 'description': 'When accession is omitted, the form type of the latest filing to fetch â\x80\x94 "10-K", "10-Q", "8-K", "DEF 14A", etc. For "the most recent 10-K OR 10-Q" (or any "whichever of these is newer" question), pass a `|`-separated SET, e.g. "10-K|10-Q" â\x80\x94 do NOT guess a single type ("10-K" by habit skips a newer 10-Q) and do NOT omit this field to get "any type", since a company files far more 8-Ks/Form 4s/Form 144s between annual or quarterly reports than it files the reports themselves and an empty form_type returns the single most recent filing of ANY kind (verified live 2026-09-25, fleet #2450: NTRA\'s single most recent SEC filing was a Form 144 insider-sale notice, filed weeks after its real 10-Q and completely unrelated to the question asked).'}, 'max_chars': {'type': 'number', 'description': 'Max characters to return in this page (1000â\x80\x93100000, default 50000). Doc text past this is available via next_offset.'}, 'ticker_or_cik': {'type': 'string', 'description': 'Alias for `ticker` / `cik` â\x80\x94 the single-argument spelling edgar_company_filings and edgar_insider_transactions use. Takes either a ticker or a CIK.'}}}

{'type': 'object', 'examples': [{'limit': 25, 'ticker': 'ARKK'}, {'limit': 10, 'ticker': 'QQQ'}], 'required': [], 'properties': {'limit': {'type': 'number', 'description': 'Top N holdings by weight to return (1-100, default 25)'}, 'ticker': {'type': 'string', 'description': 'REQUIRED (or its alias `ticker_or_cik`). ETF or mutual-fund ticker (e.g. "ARKK", "SPY", "QQQ"). Fund tickers, not company stock tickers.'}, 'ticker_or_cik': {'type': 'string', 'description': 'Alias for `ticker` â\x80\x94 the spelling sibling SEC tools (edgar_company_filings, edgar_insider_transactions) use. Must still be a FUND ticker: N-PORT funds are keyed by ticker, so a bare CIK will not resolve here.'}}}

{'type': 'object', 'examples': [{'limit': 10, 'ticker_or_cik': 'TSLA'}, {'ticker_or_cik': '1318605', 'include_derivatives': True}], 'required': [], 'properties': {'cik': {'type': 'string', 'description': 'Alias for `ticker_or_cik` â\x80\x94 the spelling edgar_company_concept and edgar_company_facts use for the same thing. Takes a ticker or a CIK.'}, 'limit': {'type': 'number', 'description': 'Max Form 4/3/5 filings to parse (1-25, default 10)'}, 'ticker': {'type': 'string', 'description': 'Alias for `ticker_or_cik` â\x80\x94 the spelling edgar_fund_holdings and edgar_ticker_to_cik use for the same thing. Takes a ticker or a CIK.'}, 'ticker_or_cik': {'type': 'string', 'description': 'REQUIRED (or one of its aliases `cik` / `ticker`). Ticker symbol (e.g., "TSLA") or CIK number (e.g., "1318605")'}, 'include_derivatives': {'type': 'boolean', 'description': 'Also include derivative (options/RSU) transactions. Default false (non-derivative common-stock only).'}}}

{'type': 'object', 'examples': [{'limit': 25, 'ticker_or_cik': 'BRK-B'}, {'limit': 50, 'ticker_or_cik': '1067983'}], 'required': [], 'properties': {'cik': {'type': 'string', 'description': 'Alias for `ticker_or_cik` â\x80\x94 the spelling edgar_company_concept and edgar_company_facts use for the same thing. Takes a ticker or a CIK.'}, 'limit': {'type': 'number', 'description': 'Top N holdings by value to return (1-100, default 25)'}, 'ticker': {'type': 'string', 'description': 'Alias for `ticker_or_cik` â\x80\x94 the spelling edgar_fund_holdings and edgar_ticker_to_cik use for the same thing. Takes a ticker or a CIK.'}, 'ticker_or_cik': {'type': 'string', 'description': 'REQUIRED (or one of its aliases `cik` / `ticker`). The institutional manager\'s ticker (e.g. "BRK-B") or CIK (e.g. "1067983"). NOT the held stock â\x80\x94 the fund/manager doing the filing.'}}}

{'type': 'object', 'examples': [{'ticker_or_cik': 'MRK', 'product_filter': 'Keytruda'}, {'ticker_or_cik': 'NVS', 'product_filter': 'Entresto'}], 'required': [], 'properties': {'cik': {'type': 'string', 'description': 'Alias for `ticker_or_cik` â\x80\x94 the spelling edgar_company_concept and edgar_company_facts use for the same thing. Takes a ticker or a CIK.'}, 'limit': {'type': 'number', 'description': 'Max rows to return (1-200, default 100).'}, 'ticker': {'type': 'string', 'description': 'Alias for `ticker_or_cik` â\x80\x94 the spelling edgar_fund_holdings and edgar_ticker_to_cik use for the same thing. Takes a ticker or a CIK.'}, 'accession': {'type': 'string', 'description': 'Optional exact accession number (from edgar_company_filings) to read a specific past filing instead of the latest matching form_type.'}, 'form_type': {'type': 'string', 'description': 'Filing type to read the note from. Omit it to try 10-K, then 20-F, then 40-F automatically â\x80\x94 foreign private issuers (NVS, AZN, GSK, SNY, NVO, TAK) file 20-F and Canadian MJDS filers file 40-F. "10-Q" also works for filers that disaggregate revenue quarterly. The form actually used comes back as `resolved_form`.'}, 'ticker_or_cik': {'type': 'string', 'description': 'REQUIRED (or one of its aliases `cik` / `ticker`). Ticker (e.g. "MRK") or CIK (e.g. "310158"). Tickers are auto-resolved.'}, 'product_filter': {'type': 'string', 'description': 'Optional case-insensitive substring to match against the product/segment dimension, e.g. "Keytruda". Omit to get every disaggregated row in the table.'}}}

{'type': 'object', 'examples': [{'limit': 20, 'query': 'artificial intelligence', 'end_date': '2024-12-31', 'form_type': '10-K', 'start_date': '2024-01-01'}, {'limit': 10, 'query': 'Tesla revenue'}], 'required': ['query'], 'properties': {'limit': {'type': 'number', 'description': 'Number of results to return (1-40, default 10)'}, 'query': {'type': 'string', 'description': 'Search query (e.g., "artificial intelligence", "Tesla revenue")'}, 'end_date': {'type': 'string', 'description': 'End date in YYYY-MM-DD format (e.g., "2024-12-31")'}, 'form_type': {'type': 'string', 'description': 'Filter by SEC form type (e.g., "10-K", "10-Q", "8-K", "DEF 14A"). Omit for all types.'}, 'start_date': {'type': 'string', 'description': 'Start date in YYYY-MM-DD format (e.g., "2024-01-01")'}}}

{'type': 'object', 'properties': {'query': {'type': 'string', 'description': 'The search query used'}, 'results': {'type': 'array', 'items': {'type': 'object', 'properties': {'cik': {'type': 'string', 'description': 'Central Index Key identifier'}, 'location': {'type': 'string', 'description': 'Business location'}, 'accession': {'type': 'string'}, 'filing_id': {'type': 'string', 'description': 'Unique filing identifier'}, 'form_type': {'type': 'string', 'description': 'SEC form type (e.g., 10-K, 10-Q)'}, 'entity_name': {'type': 'string', 'description': 'Company or entity name'}, 'filing_date': {'type': 'string', 'description': 'Date filing was submitted'}, 'period_of_report': {'type': ['string', 'null'], 'description': 'Period covered by the filing'}}}}, 'date_range': {'type': 'object', 'properties': {'end': {'type': 'null', 'description': 'End date in YYYY-MM-DD format or null'}, 'start': {'type': 'null', 'description': 'Start date in YYYY-MM-DD format or null'}}}, 'total_hits': {'type': 'number', 'description': 'Total number of matching filings'}, 'form_type_filter': {'type': 'string', 'description': "Form type filter applied or 'all'"}}}

{'type': 'object', 'examples': [{'ticker': 'AAPL'}, {'ticker': 'TSLA'}], 'required': [], 'properties': {'ticker': {'type': 'string', 'description': 'REQUIRED (or one of its aliases `ticker_or_cik` / `company`). Stock ticker symbol (e.g., "AAPL", "MSFT", "TSLA") or company name (e.g., "Apple", "Microsoft")'}, 'company': {'type': 'string', 'description': 'Alias for `ticker` â\x80\x94 use it when what you have is a company NAME ("Apple Inc.") rather than a symbol. Same argument, same behaviour.'}, 'ticker_or_cik': {'type': 'string', 'description': 'Alias for `ticker` â\x80\x94 the spelling edgar_company_filings and edgar_insider_transactions use. A ticker or company name; this tool RESOLVES to a CIK, so passing a bare CIK has nothing to look up.'}}}

{'type': 'object', 'required': ['ticker', 'cik', 'cik_padded', 'company_name'], 'properties': {'cik': {'type': 'string', 'description': 'Company CIK number'}, 'ticker': {'type': ['string', 'null'], 'description': 'Stock ticker symbol; null for a filer not on SEC\'s current-listed list (delisted, bankrupt, never listed) resolved by name via matched_by "edgar_entity_search"'}, 'cik_padded': {'type': 'string', 'description': 'CIK padded to 10 digits with leading zeros'}, 'company_name': {'type': 'string', 'description': 'Official company name'}}}

{'type': 'object', 'examples': [{'limit': 25, 'period': 'CY2024', 'concept': 'Revenues'}, {'sort': 'desc', 'limit': 50, 'period': 'CY2024Q1', 'concept': 'ResearchAndDevelopmentExpense'}], 'required': ['concept', 'period'], 'properties': {'sort': {'enum': ['desc', 'asc'], 'type': 'string', 'description': '"desc" (default, largest first) or "asc".'}, 'unit': {'type': 'string', 'description': 'Unit of measure (default "USD"). Use "shares" for share counts, "USD-per-shares" for per-share.'}, 'limit': {'type': 'number', 'description': 'Max companies to return (1-200, default 25).'}, 'period': {'type': 'string', 'description': 'Calendar frame: "CY2023" (annual duration), "CY2023Q1" (quarterly duration), or "CY2023Q1I" (instant, balance-sheet items at period end).'}, 'concept': {'type': 'string', 'description': 'US-GAAP (or dei) tag, e.g. "Revenues", "NetIncomeLoss", "Assets", "ResearchAndDevelopmentExpense".'}, 'taxonomy': {'type': 'string', 'description': 'Taxonomy: "us-gaap" (default) or "dei".'}}}

{'type': 'object', 'examples': [{'type': 'company', 'value': 'AAPL'}], 'required': ['type', 'value'], 'properties': {'type': {'enum': ['company', 'ticker'], 'type': 'string', 'description': '"company" or "ticker" â\x80\x94 both are accepted and behave identically; `value` can be a ticker, CIK, or company name either way. person/place coming soon.'}, 'value': {'type': 'string', 'description': 'Ticker (e.g., "AAPL"), zero-padded CIK (e.g., "0000320193"), or company name (e.g., "Moderna") â\x80\x94 names resolve via SEC EDGAR company-name match.'}}}

{'type': 'object', 'examples': [{'ticker_or_cik': 'MRK'}, {'name_filter': 'Sharp & Dohme', 'ticker_or_cik': '310158'}], 'required': [], 'properties': {'cik': {'type': 'string', 'description': 'Alias for `ticker_or_cik` â\x80\x94 the spelling edgar_company_concept and edgar_company_facts use for the same thing. Takes a ticker or a CIK.'}, 'limit': {'type': 'number', 'description': 'Max subsidiaries to return (1-500, default 200). Large parents can disclose 500+.'}, 'ticker': {'type': 'string', 'description': 'Alias for `ticker_or_cik` â\x80\x94 the spelling edgar_fund_holdings and edgar_ticker_to_cik use for the same thing. Takes a ticker or a CIK.'}, 'name_filter': {'type': 'string', 'description': 'Optional case-insensitive substring to filter subsidiary names by, e.g. "Sharp & Dohme" to check whether that entity is among the parent\'s disclosed subsidiaries. Subsidiary names in Exhibit 21 use "&", not "and".'}, 'ticker_or_cik': {'type': 'string', 'description': 'REQUIRED (or one of its aliases `cik` / `ticker`). The PARENT company\'s ticker (e.g. "MRK") or CIK (e.g. "310158"). Tickers are auto-resolved to CIKs.'}}}

{'type': 'object', 'examples': [{'key': 'user_research_topic'}], 'required': ['key'], 'properties': {'k': {'type': 'string', 'description': 'Alias for key.'}, 'key': {'type': 'string', 'description': 'Memory key to delete. Accepts name, k, label as aliases.'}, 'name': {'type': 'string', 'description': 'Alias for key.'}, 'label': {'type': 'string', 'description': 'Alias for key.'}}}

{'type': 'object', 'examples': [{'url': 'https://pipeworx.io'}], 'required': ['url'], 'properties': {'url': {'type': 'string', 'description': 'Full URL of the site to summarize, e.g. "https://example.com" or a specific landing page.'}, 'max_links': {'type': 'number', 'description': 'Maximum number of link entries to include (default 25, max 50).'}}}

{'type': 'object', 'examples': [{'city': 'nyc'}, {'city': 'chicago'}, {'backtest_days': 14, 'series_ticker': 'KXHIGHNY'}], 'properties': {'city': {'type': 'string', 'description': 'City to price, e.g. "nyc", "chicago", "los angeles", "miami", "austin", "houston", "denver", "philadelphia". Defaults to nyc. Unmapped cities return known_cities[] rather than a wrong series.'}, 'date': {'type': 'string', 'description': 'Settlement date as YYYY-MM-DD. Defaults to the soonest open event. Daily weather markets open ~1-2 days ahead and close 05:00Z the next day.'}, 'market_type': {'type': 'string', 'description': '"high_temp" (default) | "precip". Precipitation markets return prices but no forecast_prob yet.'}, 'backtest_days': {'type': 'number', 'description': 'Run measurement mode over the last N settled days (max 60) instead of pricing today. Returns brier_market vs brier_forecast, the settlement-vs-forecast basis, and per-day detail. Both sides are scored at 12:00Z on each event day â\x80\x94 before the daily high and before resolution â\x80\x94 because a settled market prices the known outcome at close.'}, 'series_ticker': {'type': 'string', 'description': 'Explicit Kalshi series, e.g. "KXHIGHNY" or "KXHIGHTBOS" (Boston). Overrides `city`; use it for any of the 121 daily weather series not in the city list.'}}}

{'type': 'object', 'required': [], 'properties': {'include_inactive': {'type': 'boolean', 'description': 'Include cancelled subscriptions in the response (default false).'}}}

{'type': 'object', 'examples': [{'type': 'other', 'message': 'Fleet #2184 smoke test: verifying pipeworx_feedback example call returns non-empty.'}], 'properties': {'type': {'enum': ['bug', 'feature', 'data_gap', 'praise', 'other'], 'type': 'string', 'description': 'bug = something broke or returned wrong data. feature = a new tool or capability you wish existed. data_gap = data Pipeworx does not currently expose. praise = positive note. other = anything else.'}, 'context': {'type': 'object', 'properties': {'pack': {'type': 'string', 'description': 'Pack slug (e.g., "fred")'}, 'tool': {'type': 'string', 'description': 'Tool name (e.g., "fred_get_series")'}, 'vertical': {'type': 'string', 'description': 'Vertical (e.g., "housing")'}}, 'description': 'Optional structured context: which tool, pack, or vertical this relates to.'}, 'message': {'type': 'string', 'description': 'Your feedback in plain text. Be specific (which tool, what error, what data was missing). 1-2 sentences typical, 2000 chars max.'}, 'claim_token': {'type': 'string', 'description': 'Read the reply to a report you filed earlier: pass the `pwfb_â\x80¦` token that filing returned, with no other arguments. Returns the status and, once resolved, what actually changed.'}}}

{'type': 'object', 'examples': [{'window': '7d'}], 'properties': {'window': {'enum': ['24h', '7d', '30d'], 'type': 'string', 'description': "24h (default) | 7d | 30d. Shorter windows surface what's hot right now; longer windows show steady-state demand."}}}

{'type': 'object', 'examples': [{'topic': 'Fed rate decision'}], 'properties': {'event': {'type': 'string', 'description': 'Single-event mode (use this if you know the specific Polymarket event): event slug like "fed-decision-may-2026" or "when-will-bitcoin-hit-150k". Full Polymarket URLs also accepted.'}, 'topic': {'type': 'string', 'description': 'Cross-event mode (use this if you want to scan related events across the platform): a topic or seed question like "Fed rate decision" or "Strait of Hormuz traffic returns to normal". Tool searches Polymarket for related events and checks monotonicity across them.'}}}

{'type': 'object', 'examples': [{'limit': 5, 'window': '1wk'}], 'properties': {'limit': {'type': 'number', 'description': 'Top N edges to return after ranking. Default 10, max 25.'}, 'window': {'enum': ['24hr', '1wk', '1mo'], 'type': 'string', 'description': 'Polymarket volume window to filter markets. Default 1wk.'}, 'min_kelly': {'type': 'number', 'description': 'Minimum half-Kelly fraction (as decimal, e.g. 0.005 = 0.5% of bankroll) to include single-leg opportunities. Default 0 (no filter). Skips opportunities that are too small to bet sensibly even if the edge is large.'}, 'min_edge_pp': {'type': 'number', 'description': "Minimum |edge| in percentage points to include (default 0.5). Edge is evaluated NET of slippage and Polymarket's own taker fee."}, 'slippage_pp': {'type': 'number', 'description': "Assumed execution slippage in percentage points per leg (default 0.3), for bid/ask + thin depth cost that a last-trade price does not show. Subtracted from raw |edge| before ranking and Kelly sizing, ON TOP OF Polymarket's own taker fee â\x80\x94 which is NOT zero (rate 0.04-0.07 depending on category, read off each market's own published fee schedule; see fees_pp_applied on every row and fees.ts for the full schedule). Bump slippage for very thin partitions; drop to 0 if you have a smarter fill model â\x80\x94 the fee still applies regardless."}, 'max_spread_pp': {'type': 'number', 'description': 'Tradeable-edge filter. Maximum bid/ask spread in percentage points on the representative market. Default null (no filter). Set to 2 to require tight books â\x80\x94 anything wider eats most plausible edges.'}, 'min_liquidity': {'type': 'number', 'description': 'Tradeable-edge filter. Minimum $ liquidity on the representative market (or for partition_overround, on at least one top_leg). Default 0 (no filter). Set to 5000 to drop thin-book opportunities where executing the edge would walk the book past breakeven.'}, 'category_filter': {'type': 'string', 'description': 'Comma-separated list to restrict the output: "model_driven" (crypto_price + news_momentum), "structural_arbitrage" (partition_overround), "concentrated_longshot". Combine like "model_driven,structural_arbitrage". Default: all.'}, 'min_partition_leg_kelly': {'type': 'number', 'description': "Minimum BEST per-leg half-Kelly fraction across a partition_overround opportunity's top_legs (or longshot_basket legs). Default 0 (no filter). Partition arbs always return kelly_fraction_half=0 at the parent level by design (basket trades don't compose to single-leg Kelly), so min_kelly never filters them â\x80\x94 this knob applies to the per-leg Kelly inside top_legs instead. Use to suppress thin partitions whose individual leg edges aren't worth the per-leg slippage cost."}}}

{'type': 'object', 'examples': [{'days': 14, 'window': '1wk'}], 'properties': {'days': {'type': 'number', 'description': 'Lookback in days (default 14, clamp 2-30).'}, 'window': {'type': 'string', 'description': 'Which polymarket_edges window family to read snapshots for: 24hr | 1wk | 1mo (default 1wk).'}}}

{'type': 'object', 'examples': [{'side': 'buy_yes', 'market': 'will-the-fed-increase-interest-rates-by-25-bps-after-the-december-2026-meeting-20260729232808636', 'size_usd': 1000}], 'properties': {'side': {'type': 'string', 'description': 'Single-market: buy_yes | sell_yes | buy_no | sell_no (default buy_yes). Basket: sell_yes | buy_yes (default auto â\x80\x94 sell if partition sum > 1, buy if < 1).'}, 'event': {'type': 'string', 'description': 'Basket mode: event slug or full polymarket.com URL â\x80\x94 checks every leg of the partition.'}, 'market': {'type': 'string', 'description': 'Single-market mode: market slug or full polymarket.com URL.'}, 'size_usd': {'type': 'number', 'description': 'Single-market: USD to spend (buys) or target proceeds (sells). Basket: settlement notional â\x80\x94 shares per leg, each paying $1 at resolution. Default 1000, clamp 10â\x80\x931,000,000.'}}}

{'type': 'object', 'examples': [{'topic': 'fed'}, {'topic': 'btc'}, {'topic': 'bitcoin'}, {'topic': 'fed rate decision'}], 'properties': {'topic': {'type': 'string', 'description': 'Subject to compare. Canonical keys: fed | btc | eth | cpi | gdp | sp500 | recession | next_pope | next_uk_pm | next_israel_pm | 2028_president â\x80\x94 but aliases and keywords resolve too ("bitcoin", "fed rate decision", "ethereum", "inflation", "s&p 500", "us recession", "next pope", "2028 election"). Check resolution.topic_matched_by in the response: "exact"/"alias" is a curated pairing, "phrase"/"token" is a keyword guess.'}, 'kalshi_event_ticker': {'type': 'string', 'description': 'Explicit Kalshi event ticker, e.g. "KXFED-26OCT". Overrides the topic-mapped Kalshi side.'}, 'polymarket_event_slug': {'type': 'string', 'description': 'Explicit Polymarket event slug, e.g. "fed-decision-in-june-825". Overrides the topic-mapped Polymarket side.'}}}

{'type': 'object', 'examples': [{'key': 'user_research_topic'}, {}], 'required': [], 'properties': {'k': {'type': 'string', 'description': 'Alias for key.'}, 'key': {'type': 'string', 'description': 'Memory key to retrieve (omit to list all keys). Accepts name, k, label as aliases.'}, 'name': {'type': 'string', 'description': 'Alias for key.'}, 'label': {'type': 'string', 'description': 'Alias for key.'}}}

{'type': 'object', 'required': [], 'properties': {'type': {'type': 'string', 'description': 'Optional â\x80\x94 filter to one subscription type.'}, 'limit': {'type': 'number', 'description': 'Max events to return (1-200, default 50).'}, 'since': {'type': 'string', 'description': 'Optional ISO timestamp â\x80\x94 return events fired_at >= this time.'}, 'mark_read': {'type': 'boolean', 'description': 'Flag the returned events read in the same call (default false).'}, 'unread_only': {'type': 'boolean', 'description': 'Return only events where read_at is null (default false).'}}}

{'type': 'object', 'examples': [{'type': 'company', 'since': '30d', 'value': 'AAPL'}], 'required': ['type', 'value', 'since'], 'properties': {'type': {'enum': ['company'], 'type': 'string', 'description': 'Entity type. Only "company" supported today.'}, 'since': {'type': 'string', 'description': 'Window start â\x80\x94 ISO date ("2026-04-01") or relative ("7d", "30d", "3m", "1y"). Use "30d" or "1m" for typical monitoring.'}, 'value': {'type': 'string', 'description': 'Ticker (e.g., "AAPL") or zero-padded CIK (e.g., "0000320193").'}}}

{'type': 'object', 'examples': [{'hours': 72}, {'hours': 100, 'categories': 'econ,fed'}], 'properties': {'hours': {'type': 'number', 'description': 'Look-ahead window in hours from now. Default 48. Capped at 720 (30 days) â\x80\x94 econ/fed releases are dated weeks apart, so a short window is often empty; widen rather than assume nothing is scheduled.'}, 'categories': {'type': 'string', 'description': 'Comma or space separated subset of econ|fed|fda|sec|court, or "all" (default). E.g. "econ,fed" or "fda".'}}}

{'type': 'object', 'properties': {'hint': {'type': 'string', 'description': 'Present ONLY on a zero-release window: what to change (usually a wider `hours`).'}, 'as_of': {'type': 'string'}, 'notes': {'type': 'array', 'items': {'type': 'string'}}, 'window': {'type': 'object', 'properties': {'hours': {'type': 'number'}, 'since': {'type': 'string'}, 'until': {'type': 'string'}}}, 'releases': {'type': 'array', 'items': {'type': 'object', 'properties': {'markets': {'type': 'array', 'items': {'type': 'object', 'properties': {'price': {'type': ['number', 'null']}, 'venue': {'enum': ['kalshi', 'polymarket'], 'type': 'string'}, 'volume': {'type': ['number', 'null']}, 'question': {'type': 'string'}, 'matched_by': {'type': 'string'}, 'slug_or_ticker': {'type': 'string'}, 'hours_to_release': {'type': ['number', 'null']}, 'resolves_on_this_release': {'enum': ['true', 'likely', 'unclear'], 'type': 'string'}}}}, 'release': {'type': 'object', 'properties': {'name': {'type': 'string'}, 'category': {'enum': ['econ', 'fed', 'fda', 'sec', 'court'], 'type': 'string'}, 'date_only': {'type': 'boolean'}, 'source_pack': {'type': 'string'}, 'source_tool': {'type': 'string'}, 'time_source': {'type': 'string'}, 'scheduled_at': {'type': ['object', 'null'], 'properties': {'et': {'type': 'string'}, 'utc': {'type': 'string'}}}, 'hours_to_release': {'type': ['number', 'null']}, 'what_it_publishes': {'type': 'string'}}}}}}, 'categories': {'type': 'array', 'items': {'type': 'string'}}, 'empty_reason': {'type': 'string', 'description': 'Present ONLY on a zero-release window: "no_releases_in_window". The window was queried and nothing is scheduled â\x80\x94 this is an answer, not a failure.'}, 'release_count': {'type': 'number'}, 'releases_with_matched_markets': {'type': 'number'}}}

{'type': 'object', 'examples': [{'key': 'target_ticker', 'value': 'AAPL'}], 'required': ['key', 'value'], 'properties': {'k': {'type': 'string', 'description': 'Alias for key.'}, 'v': {'type': 'string', 'description': 'Alias for value.'}, 'key': {'type': 'string', 'description': 'Memory key (e.g., "subject_property", "target_ticker", "user_preference"). Accepts name, k, label as aliases.'}, 'data': {'type': 'string', 'description': 'Alias for value.'}, 'name': {'type': 'string', 'description': 'Alias for key.'}, 'text': {'type': 'string', 'description': 'Alias for value.'}, 'label': {'type': 'string', 'description': 'Alias for key.'}, 'value': {'type': 'string', 'description': 'Value to store (any text â\x80\x94 findings, addresses, preferences, notes). Accepts content, text, data, v as aliases; a non-string value is stored as JSON.'}, 'content': {'type': 'string', 'description': 'Alias for value.'}}}

{'type': 'object', 'examples': [{'venue': 'polymarket', 'market': 'bitcoin-above-70k-on-september-13-2026'}, {'venue': 'kalshi', 'market': 'KXBTCD-26SEP1317'}], 'required': ['venue', 'market'], 'properties': {'venue': {'enum': ['polymarket', 'kalshi'], 'type': 'string', 'description': 'Which venue to fetch the market from.'}, 'market': {'type': 'string', 'description': 'Polymarket market slug or URL, OR a Kalshi market ticker (preferred) or event ticker (falls back to a representative market under that event).'}}}

{'type': 'object', 'examples': [{'a': {'venue': 'polymarket', 'market': 'bitcoin-above-70k-on-september-13-2026'}, 'b': {'venue': 'kalshi', 'market': 'KXBTCD-26SEP1317'}}], 'required': ['a', 'b'], 'properties': {'a': {'type': 'object', 'required': ['venue', 'market'], 'properties': {'venue': {'enum': ['polymarket', 'kalshi'], 'type': 'string'}, 'market': {'type': 'string'}}, 'description': 'First market to compare.'}, 'b': {'type': 'object', 'required': ['venue', 'market'], 'properties': {'venue': {'enum': ['polymarket', 'kalshi'], 'type': 'string'}, 'market': {'type': 'string'}}, 'description': 'Second market to compare.'}}}

{'type': 'object', 'examples': [{'type': 'company', 'value': 'AAPL'}], 'required': ['type', 'value'], 'properties': {'type': {'enum': ['company', 'drug'], 'type': 'string', 'description': 'Entity type: "company" or "drug".'}, 'value': {'type': 'string', 'description': 'For company: ticker (AAPL), CIK (0000320193), or name. For drug: brand or generic name (e.g., "ozempic", "metformin"). Pass the ENTITY NAME ONLY â\x80\x94 for a bond that is the ISSUER exactly as printed ("NEW YORK ST DORM AUTH"), never the question\'s full noun phrase ("NEW YORK ST DORM AUTH revenue bonds"): the FIGI lookup matches instrument names, so trailing security-class words match nothing.'}}}

{'type': 'object', 'examples': [{'entities': ['Pipeworx', 'Zapier']}], 'required': ['entities'], 'properties': {'models': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Which models to probe. Supported: "workers-ai" (free default), "anthropic" (requires _apiKey). Omit for just workers-ai.'}, '_apiKey': {'type': 'string', 'description': 'Optional Anthropic API key â\x80\x94 only if "anthropic" is in models. Passed to api.anthropic.com per probe.'}, 'context': {'type': 'string', 'description': 'Optional shared context applied to every probe (e.g. "B2B SaaS", "Boston restaurant"). Disambiguates common names.'}, 'entities': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Array of 2-8 entities to compare (brand/business/product names). First entry treated as the "subject" for narrative; rest are competitors.'}}}

{'type': 'object', 'examples': [{'package': 'left-pad'}], 'required': ['package'], 'properties': {'package': {'type': 'string', 'description': 'npm package name. Scoped packages (e.g. "@types/node") are accepted.'}, 'version': {'type': 'string', 'description': 'Specific version to check (e.g., "18.3.1"). Defaults to the latest published version when omitted.'}}}

{'type': 'object', 'examples': [{'text': 'Apple Inc. reported fiscal 2023 revenue of $383.285 billion, driven by strong iPhone and Services growth. Net income was $96.995 billion. The company faced supply-chain risk in China during the quarter.', 'query': 'supply-chain risk'}], 'required': ['text', 'query'], 'properties': {'text': {'type': 'string', 'description': 'The document text to search inside (max ~200K chars).'}, 'limit': {'type': 'number', 'description': 'Max passages to return (1-20, default 5).'}, 'query': {'type': 'string', 'description': 'Natural-language query â\x80\x94 what passages do you want? E.g. "supply-chain risk", "fiscal year 2024 revenue", "drug interactions with warfarin".'}}}

{'type': 'object', 'examples': [{'sponsor': 'Merck Sharp and Dohme'}, {'sponsor': 'Lexeo Therapeutics'}], 'required': ['sponsor'], 'properties': {'sponsor': {'type': 'string', 'description': 'Organization name to resolve â\x80\x94 a trial sponsor, drug developer, or company name, e.g. "Merck Sharp and Dohme", "Lexeo Therapeutics", "Dizal Pharmaceuticals".'}}}

{'type': 'object', 'required': ['type', 'params'], 'properties': {'type': {'enum': ['sec_8k', 'polymarket_edge', 'fred_series', 'patent_grant', 'clinical_trial'], 'type': 'string', 'description': 'Subscription type.'}, 'params': {'type': 'object', 'description': 'Type-specific filter. sec_8k: {ticker:"AAPL", items?:["5.02","1.01"]}. polymarket_edge: {topic:"fed", min_spread_bps?:500}. fred_series: {series_id:"UNRATE"}. patent_grant: {applicant:"Apple Inc."}. clinical_trial: {sponsor?:"Pfizer", condition?:"lung cancer", phase?:"PHASE3"} (sponsor or condition required).'}, 'delivery': {'type': 'object', 'properties': {'sms': {'type': 'string', 'description': 'E.164 phone number, e.g. "+15551234567". Must match the account\'s verified phone.'}, 'email': {'type': 'string', 'description': 'Email address to deliver alerts to. Validated against a standard pattern.'}, 'webhook': {'type': 'string', 'description': 'HTTPS URL to POST fired events to. https only; localhost/private hosts rejected. Signing secret returned once at subscribe time.'}}, 'description': 'Optional delivery channels in addition to the always-on persistent feed. {email:"you@x.com"} sends a templated alert per fired event. {sms:"+15551234567"} sends an SMS per event â\x80\x94 must match the verified phone on the caller\'s account (verify at https://pipeworx.io/account first; 10/day cap). {webhook:"https://..."} POSTs each event JSON to your endpoint, HMAC-signed â\x80\x94 the response includes delivery.webhook_secret (whsec_â\x80¦) ONCE; verify X-Pipeworx-Signature = sha256 HMAC of "<X-Pipeworx-Timestamp>.<raw body>". Auto-disabled after 10 consecutive failing runs.'}}}

{'type': 'object', 'examples': [{'topic': 'finance'}], 'properties': {'topic': {'type': 'string', 'description': 'Optional focus area: finance | pharma | economics | real-estate | betting | weather | government | science | news. Omit for a cross-category spread.'}}}

{'type': 'object', 'required': ['id'], 'properties': {'id': {'type': 'string', 'description': 'Subscription id (uuid) returned by subscribe.'}}}

{'type': 'object', 'examples': [{'claim': "Apple's fiscal 2023 revenue was $383 billion"}], 'required': ['claim'], 'properties': {'claim': {'type': 'string', 'description': 'Natural-language factual claim, e.g., "Apple\'s FY2024 revenue was $400 billion" or "Microsoft made about $100B in profit last year".'}, 'tolerance_pct': {'type': 'number', 'description': 'Max percent deviation still graded approximately_correct (0.5â\x80\x9350). Overrides the tolerance implied by the claim wording â\x80\x94 set 1â\x80\x932 for hallucination detection where any material error must be refuted. Default: implied by wording, capped at 5.'}}}