v1

latestOpenAPI 3.1.0MIT2026-07-17116965.4 KB

Performs an autocomplete search on a table

The method expects an object with the following mandatory properties:

the name of the table to search
the query string to autocomplete For details, see the documentation on Autocomplete An example: { "table":"table_name", "query":"query_beginning" } An example of the method's response:

[
  {
    "total": 3,
    "error": "",
    "warning": "",
    "columns": [
      {
        "query": {
          "type": "string"
        }
      }
    ],
    "data": [
      {
        "query": "hello"
      },
      {
        "query": "helio"
      },
      {
        "query": "hell"
      }
    ]
  }
]

For more detailed information about the autocomplete queries, please refer to the documentation here.

post/autocomplete

Request body

tablestring required

The table to perform the search on

querystring required

The beginning of the string to autocomplete

optionsobject

Autocomplete options

layouts: A comma-separated string of keyboard layout codes to validate and check for spell correction. Available options - us, ru, ua, se, pt, no, it, gr, uk, fr, es, dk, de, ch, br, bg, be. By default, all are enabled.
fuzziness: (0,1 or 2) Maximum Levenshtein distance for finding typos. Set to 0 to disable fuzzy matching. Default is 2
prepend: true/false If true, adds an asterisk before the last word for prefix expansion (e.g., *word )
append: true/false If true, adds an asterisk after the last word for prefix expansion (e.g., word* )
expansion_len: Number of characters to expand in the last word. Default is 10.

Example request

{
  "table": "test",
  "query": "Start",
  "options": {
    "layouts": "us,uk",
    "fuzziness": 0
  }
}

Response

object[] required