This page provides an overview of search-related APIs.

Lexi provides a powerful simple and advanced search facility enabling you to rapidly identify documents of interest. To submit a search request, call POST /v1.0/tenants/[tenant-guid]/collections/[collection-guid]/documents?search with the following request body.

{
    "MaxResults": 10,
    "ContinuationToken": "",
    "Ordering": "CreatedDescending",
    "Filter": {
        "CreatedAfter": "2024-01-01 00:00:00.000000",
        "CreatedBefore": "2025-01-01 00:00:00.000000",
        "Terms": [
            "... term 1 ..."
        ],
        "MimeTypes": [
            "... mime-type 1 ..."
        ],
        "Prefixes": [
            "... prefix 1 ..."
        ],
        "Suffixes": [
            "... suffix 1 ..."
        ],
        "SchemaFilters": [
        ]
    }
}

The response body containing the result will appear as follows:

{
    "Success": true,
    "Timestamp": {
        "Start": "2024-10-27T06:17:03.661120Z",
        "TotalMs": 426.02,
        "Messages": {
            ... log messages ...
        }
    },
    "EndOfResults": false,
    "ContinuationToken": "45c243e5-fe52-42b0-8380-caa59477135a",
    "RecordsRemaining": 28,
    "Documents": [
        {
            "GUID": "9ff39098-fdeb-46b5-9768-92ac1c2675bc",
            "TenantGUID": "default",
            "BucketGUID": "example-data-bucket",
            "CollectionGUID": "default",
            "ObjectGUID": "50af223a-e7f5-406a-88cd-26d7d3f1c3b6",
            "ObjectKey": "3.pdf",
            "ObjectVersion": "2",
            "ContentType": "application/pdf",
            "DocumentType": "Pdf",
            "SourceUrl": "http://dcc249eaaf06:8001/v1.0/tenants/default/buckets/example-data-bucket/objects/3.pdf",
            "ContentLength": 1086643,
            "MD5Hash": "",
            "CreatedUtc": "2024-10-25T15:50:18.000000Z"
        },
        { ... }
    ]
}