search.documents | Documentation

{
  "search": {
    "count": 1,
    "results": [
      {
        "boundingBoxes": [
          {
            "bottomRightX": 1.1,
            "bottomRightY": 1.1,
            "pageNumber": 1,
            "topLeftX": 1.1,
            "topLeftY": 1.1
          }
        ],
        "bucketId": 1,
        "chunkId": "string",
        "documentId": "string",
        "fileName": "string",
        "fileSummary": "string",
        "multimodalUrl": "string",
        "pageImages": [
          "string"
        ],
        "pages": [
          {
            "height": 1.1,
            "imageUrl": "string",
            "number": 1.1,
            "width": 1.1
          }
        ],
        "processId": "string",
        "score": 1.1,
        "searchData": {},
        "sectionSummary": "string",
        "sourceUrl": "string",
        "suggestedText": "string",
        "text": "string"
      }
    ],
    "query": "string",
    "score": 1.1,
    "searchQuery": "string",
    "text": "string",
    "nextToken": "string"
  }
}

Search the specified document IDs for information relevant to a query. Use result.search.text as context for a language model and result.search.results for matching text and citations.

Authentication

X-API-Keystring

API Key authentication via header

Query parameters

nintegerOptional1-100Defaults to 20

The maximum number of returned search results. Accepts 1-100 with a default of 20.

nextTokenstringOptional

Pass nextToken from the previous response to get the next page of up to n search results.

verbosityintegerOptional0-2

Response detail: 0 returns only recommended context; 1 adds search results without searchData; 2 includes searchData.

Request

This endpoint expects an object.

querystringRequiredDefaults to my search query

Search query.

documentIdslist of stringsRequired

An array of unique documentIds to be searched.

filterobjectOptional

Key-value metadata used to filter documents before searching.

relevancedoubleOptionalDefaults to 10

The minimum search relevance score required to include the result. By default, this is 10.0.

Response

Search query success

searchobject

Errors

400

Bad Request Error

401

Unauthorized Error