Skip to main content
GET
/
document
/
search
Search Documents
curl --request GET \
  --url https://api.stax.ai/document/search \
  --cookie authToken=
{
  "success": true,
  "total": 123,
  "hits": [
    {
      "_id": "<string>",
      "_score": 123,
      "_source": {
        "_id": "<string>",
        "team": "<string>",
        "stack": "<string>",
        "name": "<string>",
        "originalName": "<string>",
        "format": "<string>",
        "download": "<string>",
        "thumbnail": "<string>",
        "source": "<string>",
        "sourceUrl": "<string>",
        "provider": {},
        "importKey": "<string>",
        "pages": [
          "<string>"
        ],
        "rotations": {},
        "aspects": {},
        "job": {
          "upload": "<string>",
          "working": true,
          "worker": "<string>",
          "status": "<string>",
          "success": true,
          "error": "<string>",
          "read": {
            "operationUrls": [
              "<string>"
            ],
            "fetchTime": "2023-11-07T05:31:56Z"
          },
          "rc": {
            "preproc": "<string>",
            "sort": "<string>",
            "postproc": "<string>"
          }
        },
        "urgent": true,
        "deadline": "2023-11-07T05:31:56Z",
        "flagged": true,
        "pinned": true,
        "flags": [
          {
            "timestamp": "2023-11-07T05:31:56Z",
            "title": "<string>",
            "description": "<string>",
            "level": "info",
            "pages": [
              123
            ]
          }
        ],
        "reviewed": true,
        "archived": true,
        "assignee": "<string>",
        "sharing": {
          "public": true,
          "protected": {
            "emails": [
              "<string>"
            ],
            "teams": [
              "<string>"
            ],
            "password": "<string>"
          },
          "access": [
            {
              "email": "<string>",
              "usage": 123
            }
          ]
        },
        "checksum": "<string>",
        "metadata": [
          {
            "key": "<string>",
            "value": "<string>",
            "expression": "<string>",
            "class": "<string>",
            "tags": [
              123
            ],
            "pages": [
              123
            ],
            "ref": "<string>",
            "confidence": 123
          }
        ],
        "fillable": {
          "enabled": true,
          "fields": [
            {
              "key": "<string>",
              "required": true,
              "hint": "<string>",
              "dataType": "textbox",
              "fontSize": 123,
              "page": 123,
              "x": 123,
              "y": 123,
              "width": 123,
              "height": 123
            }
          ],
          "recipients": [
            {
              "document": "<string>",
              "email": "<string>",
              "name": "<string>",
              "sentOn": "2023-11-07T05:31:56Z",
              "viewedOn": "2023-11-07T05:31:56Z",
              "filledOn": "2023-11-07T05:31:56Z"
            }
          ]
        },
        "keywords": [
          "<string>"
        ],
        "bounds": [
          {
            "label": "<string>",
            "data": {},
            "page": 123,
            "x": 123,
            "y": 123,
            "width": 123,
            "height": 123
          }
        ],
        "tables": [
          {
            "raw": true,
            "title": "<string>",
            "lastModified": "2023-11-07T05:31:56Z",
            "createdON": "2023-11-07T05:31:56Z",
            "page": 123,
            "x": 123,
            "y": 123,
            "width": 123,
            "height": 123,
            "headers": [
              "<string>"
            ],
            "tags": [
              {
                "row": 123,
                "col": 123,
                "key": "<string>"
              }
            ],
            "rows": [
              {
                "x": 123,
                "y": 123,
                "width": 123,
                "height": 123,
                "page": 123,
                "cells": [
                  {
                    "x": 123,
                    "y": 123,
                    "width": 123,
                    "height": 123,
                    "text": "<string>",
                    "confidence": 123
                  }
                ],
                "class": "<string>",
                "classConfidence": 123
              }
            ]
          }
        ],
        "split": [
          {
            "pages": [
              123
            ],
            "toNext": true,
            "name": "<string>"
          }
        ],
        "notes": [
          {
            "page": 123,
            "thread": [
              {
                "text": "<string>",
                "user": "<string>",
                "timestamp": "2023-11-07T05:31:56Z"
              }
            ],
            "tags": [
              "<string>"
            ],
            "x": 123,
            "y": 123
          }
        ],
        "canvas": {},
        "bulk": true,
        "original": "<string>",
        "splitFrom": "<string>",
        "attachments": [
          {
            "filename": "<string>",
            "document": "<string>",
            "filepath": "<string>"
          }
        ],
        "time": [
          {
            "event": "<string>",
            "stamp": "2023-11-07T05:31:56Z",
            "user": "<string>"
          }
        ],
        "viewed": {},
        "sync": [
          {
            "user": "<string>",
            "key": "<string>",
            "path": "<string>",
            "override": true,
            "error": "<string>",
            "step": "<string>",
            "job": "<string>",
            "isSynced": true,
            "queuedOn": "2023-11-07T05:31:56Z",
            "syncedOn": "2023-11-07T05:31:56Z"
          }
        ],
        "receivedOn": "2023-11-07T05:31:56Z",
        "lastModified": "2023-11-07T05:31:56Z",
        "nextStack": "<string>",
        "sender": "<string>"
      },
      "highlight": {}
    }
  ]
}

Authorizations

authToken
string
cookie
required

Cookie-based authentication using userId and authToken cookies

Query Parameters

searchQuery
string
required

Search query (minimum 3 characters)

Minimum string length: 3
searchOffset
number
default:0
Required range: x >= 0
searchLimit
number
default:10
Required range: 1 <= x <= 100
stackId
string

Filter by stack ID or special values: urgent, mine, unclassified, unread, archives, shared, flagged, recent

format
string

Filter by document format

field
string

Metadata field to filter by

value
string

Metadata value to filter by (use 'unset' to find documents without this field)

sortBy
enum<string>
Available options:
recent

Response

Search results

success
boolean
total
number
hits
object[]