Search Contract Document Action
Search the latest contract document version based on the user’s query.
This action is available in API version 64.0 and later.
To use this action, Contracts AI User permission set is required.
URI: /services/data/v68.0/actions/standard/searchContractDocument
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer TOKEN
| Input | Type | Description |
|---|---|---|
contractId | string | Required. ID of the contract record to use for the search. |
searchQuery | string | Required. Text-based query to use to search contract documents. |
resultLimit | string | Required. Maximum number of text segments that can be returned from the contract search. Each segment represents a relevant portion of a contract document. |
| Output | Type | Description |
|---|---|---|
searchResult | string | Concatenated content of the top segments that match a user query. |
POST
This sample request is for the Search Contract Document action.
This sample response is for the Search Contract Document action.