{"openapi":"3.1.0","info":{"title":"RevenueBase Velocity API","version":"0.1.0"},"paths":{"/health":{"get":{"summary":"Health","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Health Health Get"}}}}}}},"/columns":{"get":{"summary":"Get Columns","description":"The column catalog. ``?include=values`` embeds multiselect vocabularies.\n\nThe bulk form exists so a client can warm every filter picker in one request\ninstead of one request per column (issue #39): ~35 calls into a per-key rate\nbudget was 429ing the count/insights requests users were waiting on.","operationId":"get_columns_v1_columns_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"include","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Include"}},{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Columns V1 Columns Get"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}}}},"/columns/{column}/values":{"get":{"summary":"Get Column Values","description":"Distinct values for one column, if that column is enumerable.\n\nOmitting `limit` serves the column's own cap (`valueLimit` in `/v1/columns`),\nsized from its measured vocabulary plus a 100% growth buffer — so a\nmultiselect column comes back complete instead of clipped at a flat 1000.","operationId":"get_column_values_v1_columns__column__values_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"column","in":"path","required":true,"schema":{"type":"string","title":"Column"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"}},{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Column Values V1 Columns  Column  Values Get"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}}}},"/match-presets":{"get":{"summary":"Match Presets","description":"The named match presets for every smart-search filter, and the cosine\ndistance each one means per target.\n\nOne vocabulary (exact / similar / related / broad), one number-owner (the\nserver). Clients render the labels and send `match` on a semantic or\nlookalike node instead of hand-picking a `maxDistance`, so \"Similar\" means\nthe same measured thing everywhere.","operationId":"match_presets_v1_match_presets_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Match Presets V1 Match Presets Get"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/title-match":{"get":{"summary":"Title Match","description":"The named title-match presets (pre-unification endpoint; prefer\nGET /v1/match-presets, which also carries company and lookalike presets).","operationId":"title_match_v1_title_match_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Title Match V1 Title Match Get"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/stats":{"get":{"summary":"Stats","operationId":"stats_v1_stats_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Stats V1 Stats Get"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/credits/prices":{"get":{"summary":"Credit Prices","description":"The current per-unit credit prices (docs/credits-architecture.md).\n\nLets a client compute an exact cost for a set of rows it already has —\nan on-screen preview, a ticked selection — without a round trip and\nwithout hardcoding numbers that could silently drift from what actually\ngets charged. Same values `CreditPrices.from_settings` uses everywhere\nelse; not gated by entitlement or credits mode, since the numbers\nthemselves aren't sensitive and a client needs them regardless of\nwhether metering is currently enforced.","operationId":"credit_prices_v1_credits_prices_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"type":"integer"},"type":"object","title":"Response Credit Prices V1 Credits Prices Get"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/count":{"post":{"summary":"Count","operationId":"count_v1_count_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Count V1 Count Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/preview":{"post":{"summary":"Preview","description":"Fast inline rows (default 1000, max 50000). Unsorted.\n\nFor bigger pulls use the exports endpoint.","operationId":"preview_v1_preview_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreviewRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Preview V1 Preview Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/view":{"post":{"summary":"View","description":"Masked-browsing twin of /v1/preview (credits-implementation-plan.md\nPhase 1): EMAIL_ADDRESS_PER/CELLPHONE_PER always come back as hasEmail/\nhasMobile booleans, never priced, capped by a daily free-rows budget\ninstead of credits. Available to any authenticated account — an AYCE\naccount has no reason to call it (it already gets unmasked /preview for\nfree) but nothing here forbids it.","operationId":"view_v1_view_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response View V1 View Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/audience/normalize-simple-input":{"post":{"summary":"Normalize Simple Input","operationId":"normalize_simple_input_v1_audience_normalize_simple_input_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleInputRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Normalize Simple Input V1 Audience Normalize Simple Input Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/audience/normalize-location":{"post":{"summary":"Normalize Location","description":"Resolve a location to structured values without executing a search.","operationId":"normalize_location_v1_audience_normalize_location_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationNormalizeRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Normalize Location V1 Audience Normalize Location Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/audience/from-text":{"post":{"summary":"Audience From Text","description":"Translate one plain-language audience description into a filter tree.\n\nReturns the tree every other filter-taking endpoint accepts, plus the first\nrows when `preview` is true. `filter` is null when nothing in the sentence\nmaps to a real column — a 200 with an explanation, not an error, because\n\"we hold no data for that\" is an answer.","operationId":"audience_from_text_v1_audience_from_text_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NlSearchRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Audience From Text V1 Audience From Text Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/insights":{"post":{"summary":"Insights","operationId":"insights_v1_insights_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Insights V1 Insights Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/lookalike":{"post":{"summary":"Lookalike","description":"Similar companies by NAME-FREE description vector (ClickHouse only).\n\nResolves and hydrates from the org-grain companies table (a PK lookup, not\na scan of the person-grain table). `columns` picks the fields returned per\nmatch; [\"*\"] returns every company column.","operationId":"lookalike_v1_lookalike_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookalikeRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Lookalike V1 Lookalike Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"deprecated":true,"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/company/lookalike":{"post":{"summary":"Lookalike","description":"Similar companies by NAME-FREE description vector (ClickHouse only).\n\nResolves and hydrates from the org-grain companies table (a PK lookup, not\na scan of the person-grain table). `columns` picks the fields returned per\nmatch; [\"*\"] returns every company column.","operationId":"lookalike_v1_company_lookalike_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookalikeRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Lookalike V1 Company Lookalike Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/enrich":{"post":{"summary":"Enrich","operationId":"enrich_v1_enrich_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrichRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Enrich V1 Enrich Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/exports/quotes":{"post":{"summary":"Create Export Quote","description":"Queue one exact pricing aggregate; reveal/cap changes reuse the returned family.","operationId":"create_export_quote_v1_exports_quotes_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportRequest"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Create Export Quote V1 Exports Quotes Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/exports/quotes/{quote_id}":{"get":{"summary":"Export Quote Status","operationId":"export_quote_status_v1_exports_quotes__quote_id__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"quote_id","in":"path","required":true,"schema":{"type":"string","title":"Quote Id"}},{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Export Quote Status V1 Exports Quotes  Quote Id  Get"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}}}},"/exports/estimate":{"post":{"summary":"Estimate Export","description":"The required reserve for this request, without holding or charging.\n\nStart uses this same calculation. Whole audiences are priced exactly;\ncapped subsets use a safe upper bound, with unused credits refunded.\n\n`creditsEstimate: null` means this account isn't metered for exports at\nall right now (AYCE, no attributable user, or exports credits metering\nis off) — the same bypass `_prepare_export_credits` applies, so a client\nnever sees a number here that the real export wouldn't also charge for.","operationId":"estimate_export_v1_exports_estimate_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Estimate Export V1 Exports Estimate Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/exports":{"post":{"summary":"Start Export","operationId":"start_export_v1_exports_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportRequest"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Start Export V1 Exports Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/exports/{export_id}":{"get":{"summary":"Export Status","operationId":"export_status_v1_exports__export_id__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"export_id","in":"path","required":true,"schema":{"type":"string","title":"Export Id"}},{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Export Status V1 Exports  Export Id  Get"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}}},"delete":{"summary":"Cancel Export","description":"Request cancellation. QUEUED/PROCESSING -> CANCELLING (then CANCELLED); a finished\nexport returns its terminal status unchanged.","operationId":"cancel_export_v1_exports__export_id__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"export_id","in":"path","required":true,"schema":{"type":"string","title":"Export Id"}},{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Cancel Export V1 Exports  Export Id  Delete"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}}}},"/company/columns":{"get":{"summary":"Company Columns","description":"The company column catalog (org-grain only). ``?include=values`` embeds\nmultiselect vocabularies, built from the companies table itself (a 26M-row\nscan, cheap enough to build on demand and cache).","operationId":"company_columns_v1_company_columns_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"include","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Include"}},{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Company Columns V1 Company Columns Get"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}}}},"/company/columns/{column}/values":{"get":{"summary":"Company Column Values","description":"Distinct values for one enumerable company column (same gate as the\ncontact endpoint, served from the org-grain table).","operationId":"company_column_values_v1_company_columns__column__values_get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"column","in":"path","required":true,"schema":{"type":"string","title":"Column"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"}},{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Company Column Values V1 Company Columns  Column  Values Get"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}}}},"/company/stats":{"get":{"summary":"Company Stats","operationId":"company_stats_v1_company_stats_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Company Stats V1 Company Stats Get"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/company/count":{"post":{"summary":"Company Count","description":"Companies matching the filter (exact by construction; `mode` is accepted\nfor symmetry with /v1/count and ignored). Contact-field legs are allowed:\nthe count is then the companies of the contacts that filter matches.\nWith includeExportQuote, the exact count and export price share one async job.","operationId":"company_count_v1_company_count_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Company Count V1 Company Count Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/company/view":{"post":{"summary":"Company View","description":"Free company sample (up to 100 rows), sharing the daily preview allowance.","operationId":"company_view_v1_company_view_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyViewRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Company View V1 Company View Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/company/preview":{"post":{"summary":"Company Preview","description":"One row per company, unsorted (best-similarity-first with includeScores).\n\nPAYG shares 5,000 free rows per organization per UTC day with contact and\ncompany View. SmartSearch is included. Rows are limited to the remaining\nallowance; exhaustion returns 429 FREE_PREVIEW_CAP_REACHED without billing.\nAYCE retains unlimited retrieval within the per-request limit.","operationId":"company_preview_v1_company_preview_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreviewRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Company Preview V1 Company Preview Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/company/insights":{"post":{"summary":"Company Insights","description":"Company insights: `coverage` (group counts, default by employee range)\nand `fillRate`. The person sections have no company analogue.","operationId":"company_insights_v1_company_insights_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Company Insights V1 Company Insights Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/company/enrich":{"post":{"summary":"Company Enrich","description":"One company row per domain / company LinkedIn URL / RBID_ORG.","operationId":"company_enrich_v1_company_enrich_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyEnrichRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Company Enrich V1 Company Enrich Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/company/exports/quotes":{"post":{"summary":"Create Company Export Quote","operationId":"create_company_export_quote_v1_company_exports_quotes_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportRequest"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Create Company Export Quote V1 Company Exports Quotes Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/company/exports/estimate":{"post":{"summary":"Estimate Company Export","description":"What POST /v1/company/exports would hold for this body, without holding\nanything. `creditsEstimate: null` = this account isn't metered for exports\n(AYCE, no attributable user, or exports metering off).","operationId":"estimate_company_export_v1_company_exports_estimate_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Estimate Company Export V1 Company Exports Estimate Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/company/exports":{"post":{"summary":"Start Company Export","description":"Bulk company file (one row per company) -> presigned download URL.\n\nSame store, lifecycle and credit metering as /v1/exports — held up front\n(the same capped company count as the estimate endpoint;\n402 INSUFFICIENT_CREDITS when the balance can't cover it), and\nsettlement charges the rows actually written: one company_row each plus\nthe smart-field charge.\nCompany export ids resolve on either status path.\n\nThe filter may carry contact fields (job title, seniority, a semantic\n'title'): the file is then the companies of the contacts it matches --\nthe same companies the audience search returns.","operationId":"start_company_export_v1_company_exports_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportRequest"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Start Company Export V1 Company Exports Post"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}},"security":[{"APIKeyHeader":[]}],"parameters":[{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}]}},"/company/exports/{export_id}":{"get":{"summary":"Company Export Status","operationId":"company_export_status_v1_company_exports__export_id__get","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"export_id","in":"path","required":true,"schema":{"type":"string","title":"Export Id"}},{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Company Export Status V1 Company Exports  Export Id  Get"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}}},"delete":{"summary":"Cancel Company Export","operationId":"cancel_company_export_v1_company_exports__export_id__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"export_id","in":"path","required":true,"schema":{"type":"string","title":"Export Id"}},{"name":"X-RevenueBase-AI-Usage","in":"header","required":false,"schema":{"type":"string","enum":["1","2"]},"description":"Opt in to bounded provider-usage receipts. 1: base64url JSON v1; 2: z1. prefix + base64url zlib-compressed JSON v1. See docs/ai-usage.md. No prompts, records, vectors or credentials are included."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Cancel Company Export V1 Company Exports  Export Id  Delete"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{"X-RevenueBase-AI-Usage":{"schema":{"type":"string"},"description":"Present only when requested and telemetry is available. Actual OpenAI attempts and cache reuse for this request; partial or absent coverage is unknown, not zero. Costs are calculated by the client."}}}}}}},"components":{"schemas":{"CompanyEnrichRequest":{"properties":{"domains":{"items":{"type":"string"},"type":"array","title":"Domains"},"linkedinUrls":{"items":{"type":"string"},"type":"array","title":"Linkedinurls"},"rbidOrgs":{"items":{"type":"string"},"type":"array","title":"Rbidorgs"},"columns":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Columns"}},"type":"object","title":"CompanyEnrichRequest","description":"Company enrich keys: domains, company LinkedIn URLs and/or RBID_ORGs."},"CompanyViewRequest":{"properties":{"filter":{"anyOf":[{"$ref":"#/components/schemas/GroupNode"},{"type":"null"}]},"columns":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Columns"},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","default":10},"includeScores":{"type":"boolean","title":"Includescores","default":false}},"type":"object","title":"CompanyViewRequest","description":"Free company sample; bulk retrieval remains on /company/preview."},"ConditionNode":{"properties":{"type":{"type":"string","const":"condition","title":"Type"},"column":{"type":"string","title":"Column","default":""},"operator":{"type":"string","enum":["eq","ne","gt","gte","lt","lte","contains","startsWith","endsWith","isNull","isNotNull","in","notIn","between"],"title":"Operator"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"null"}],"title":"Value"},"value2":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"null"}],"title":"Value2"},"valueList":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Valuelist"},"joinWithPrevious":{"anyOf":[{"type":"string","enum":["AND","OR"]},{"type":"null"}],"title":"Joinwithprevious"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},"type":"object","required":["type","operator"],"title":"ConditionNode"},"CountRequest":{"properties":{"filter":{"anyOf":[{"$ref":"#/components/schemas/GroupNode"},{"type":"null"}]},"mode":{"type":"string","title":"Mode","default":"fast"},"includeExportQuote":{"type":"boolean","title":"Includeexportquote","default":false}},"type":"object","title":"CountRequest"},"EnrichRequest":{"properties":{"emails":{"items":{"type":"string"},"type":"array","title":"Emails"},"personIds":{"items":{"type":"string"},"type":"array","title":"Personids"},"columns":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Columns"},"companies":{"anyOf":[{"$ref":"#/components/schemas/EnrichmentCompanies"},{"type":"null"}]},"reveal":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Reveal"}},"type":"object","title":"EnrichRequest"},"EnrichmentCompanies":{"properties":{"domains":{"items":{"type":"string"},"type":"array","title":"Domains"},"linkedinUrls":{"items":{"type":"string"},"type":"array","title":"Linkedinurls"},"rbidOrgs":{"items":{"type":"string"},"type":"array","title":"Rbidorgs"},"columns":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Columns"},"includeSubdomains":{"type":"boolean","title":"Includesubdomains","default":false},"skipOverflowingIdentifiers":{"type":"boolean","title":"Skipoverflowingidentifiers","default":false},"maxMatches":{"type":"integer","maximum":10000.0,"minimum":1.0,"title":"Maxmatches","default":100}},"type":"object","title":"EnrichmentCompanies","description":"Independent organization lookup in the same contact enrichment request."},"ExportRequest":{"properties":{"quoteId":{"anyOf":[{"type":"string","pattern":"^eq_[0-9a-f]{32}$"},{"type":"null"}],"title":"Quoteid"},"quotedCredits":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Quotedcredits"},"filter":{"anyOf":[{"$ref":"#/components/schemas/GroupNode"},{"type":"null"}]},"columns":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Columns"},"format":{"type":"string","title":"Format","default":"json"},"compression":{"type":"string","title":"Compression","default":"gz"},"maxRows":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Maxrows"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filename"},"reveal":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Reveal"}},"type":"object","title":"ExportRequest"},"GroupNode":{"properties":{"type":{"type":"string","const":"group","title":"Type"},"op":{"type":"string","enum":["AND","OR"],"title":"Op","default":"AND"},"children":{"items":{"oneOf":[{"$ref":"#/components/schemas/ConditionNode"},{"$ref":"#/components/schemas/GroupNode"},{"$ref":"#/components/schemas/SemanticNode"},{"$ref":"#/components/schemas/LookalikeNode"}],"discriminator":{"propertyName":"type","mapping":{"condition":"#/components/schemas/ConditionNode","group":"#/components/schemas/GroupNode","lookalike":"#/components/schemas/LookalikeNode","semantic":"#/components/schemas/SemanticNode"}}},"type":"array","title":"Children"},"joinWithPrevious":{"anyOf":[{"type":"string","enum":["AND","OR"]},{"type":"null"}],"title":"Joinwithprevious"},"negate":{"type":"boolean","title":"Negate","default":false},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},"type":"object","required":["type"],"title":"GroupNode"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InsightsRequest":{"properties":{"filter":{"anyOf":[{"$ref":"#/components/schemas/GroupNode"},{"type":"null"}]},"section":{"type":"string","title":"Section"},"fields":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Fields"},"groupField":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Groupfield"}},"type":"object","required":["section"],"title":"InsightsRequest"},"LocationNormalizeRequest":{"properties":{"query":{"type":"string","maxLength":1000,"minLength":1,"title":"Query"},"target":{"type":"string","enum":["person","headquarters"],"title":"Target","default":"person"}},"type":"object","required":["query"],"title":"LocationNormalizeRequest"},"LookalikeNode":{"properties":{"type":{"type":"string","const":"lookalike","title":"Type"},"rbidOrg":{"type":"string","title":"Rbidorg","default":""},"domain":{"type":"string","title":"Domain","default":""},"maxDistance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Maxdistance"},"match":{"anyOf":[{"type":"string","enum":["exact","similar","related","broad","same"]},{"type":"null"}],"title":"Match"},"joinWithPrevious":{"anyOf":[{"type":"string","enum":["AND","OR"]},{"type":"null"}],"title":"Joinwithprevious"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"negate":{"type":"boolean","title":"Negate","default":false}},"type":"object","required":["type"],"title":"LookalikeNode","description":"Match people at companies whose NAME-FREE description vector is near the\ngiven company's vector (velocity.company_vec512_lookalike)."},"LookalikeRequest":{"properties":{"domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain"},"rbidOrg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rbidorg"},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"},"columns":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Columns"}},"type":"object","title":"LookalikeRequest"},"NlSearchRequest":{"properties":{"query":{"type":"string","maxLength":2000,"minLength":1,"title":"Query"},"preview":{"type":"boolean","title":"Preview","default":false},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"},"columns":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Columns"},"includeScores":{"type":"boolean","title":"Includescores","default":false}},"type":"object","required":["query"],"title":"NlSearchRequest","description":"One plain-language audience description (issue #94).\n\n`preview` is opt-in rather than the default: translating is one LLM call,\nwhile previewing adds a ClickHouse scan, and a caller that only wants the\nfilter (to edit, store, or run against /exports) should not pay for rows it\nthrows away."},"PreviewRequest":{"properties":{"filter":{"anyOf":[{"$ref":"#/components/schemas/GroupNode"},{"type":"null"}]},"columns":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Columns"},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"},"includeSql":{"type":"boolean","title":"Includesql","default":false},"includeScores":{"type":"boolean","title":"Includescores","default":false},"reveal":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Reveal"}},"type":"object","title":"PreviewRequest"},"SemanticNode":{"properties":{"type":{"type":"string","const":"semantic","title":"Type"},"on":{"type":"string","enum":["company","title"],"title":"On"},"text":{"type":"string","title":"Text","default":""},"maxDistance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Maxdistance"},"match":{"anyOf":[{"type":"string","enum":["exact","similar","related","broad","same"]},{"type":"null"}],"title":"Match"},"joinWithPrevious":{"anyOf":[{"type":"string","enum":["AND","OR"]},{"type":"null"}],"title":"Joinwithprevious"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"negate":{"type":"boolean","title":"Negate","default":false}},"type":"object","required":["type","on"],"title":"SemanticNode"},"SimpleInputRequest":{"properties":{"text":{"type":"string","maxLength":1000,"minLength":1,"title":"Text"},"kind":{"type":"string","enum":["title","company"],"title":"Kind"}},"type":"object","required":["text","kind"],"title":"SimpleInputRequest"},"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"},"ViewRequest":{"properties":{"filter":{"anyOf":[{"$ref":"#/components/schemas/GroupNode"},{"type":"null"}]},"columns":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Columns"},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"},"includeScores":{"type":"boolean","title":"Includescores","default":false},"includeExportQuote":{"type":"boolean","title":"Includeexportquote","default":false}},"type":"object","title":"ViewRequest","description":"POST /v1/view — masked-browsing twin of PreviewRequest. No `reveal`:\nEMAIL_ADDRESS_PER/CELLPHONE_PER always come back masked (hasEmail/\nhasMobile booleans), never priced. See services/view.py."}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-Key"}}},"servers":[{"url":"/v2/contact"}]}