v3

latestOpenAPI 3.1.02026-08-08123192255.1 KB

api-v1-deals1

api-v1-users4

api-v2-be-policies1

api-v2-deal-data1

api-v2-docgen2

api-v2-email-actions4

api-v2-emails1

api-v2-push-notifications2

api-v2-schema3

api-v2-webhooks13

external-v2-account1

external-v2-api-keys3

external-v2-auth1

external-v2-billing2

external-v2-checklists4

external-v2-companies4

external-v2-contacts5

external-v2-deals18

external-v2-documents4

external-v2-health1

external-v2-lenders3

external-v2-market2

external-v2-mcp1

external-v2-me3

external-v2-notes20

external-v2-pipelines3

external-v2-placements4

external-v2-term-sheets5

mailbox1

mobile1

public-health2

service-auth3

external-v2-deals

Search Deal Index

Search canonical indexed deal facts by natural-language context.

This is a read/enrichment endpoint over Metric SOT. It complements the structured deal detail endpoints by returning ranked facts plus source metadata such as document file name and pages.

post/api/external/v2/deals/{deal_id}/index/search

Path parameters

deal_idinteger required

Request body

contextstring required

Natural-language deal-data search context.

min_scorenumber

Minimum cosine similarity threshold (0-1).

limitinteger

Maximum ranked facts to return (1-200, clamped).

include_signed_urlsboolean

When true, include time-limited signed URLs for document-backed source attachments.

Response

Successful Response

request_idstring required

timestampstring required

{"stackTrail":"components:schemas:DealIndexSearchListResponse:properties:pagination","oasType":"schema","type":"unknown","title":"Pagination"}