Text autocomplete API

autocomplete takes input text and returns possible completions.

Command name: autocomplete Success status: 200 OK

On this page

• Common parameters

• Parameters

• Request examples

• Response schema

• Errors

Related: Overview, Supported languages

Common parameters

cmd selects the command to run.

Name	Type	Required	Description
cmd	string	Yes	Must be autocomplete.

These parameters work with any cmd.

Name	Type	Required	Description
serviceid	string	Cloud only	Cloud API key. Required for Cloud requests. Not used on-premises.
short_answer	boolean	No	JSON only. When true, shortens JSON keys to reduce payload size.

See Overview for details.

Parameters

These are parameters specific to cmd=autocomplete.

Name	Type	Required	Description
text	string	Yes	Text to complete. The completion is returned as a suffix string. It can start with whitespace.
lang	string	Yes	Language code. Use a language where autocomplete is enabled. See Supported languages.

Request examples

Example: completion found

Request:

GET

GET https://endpoint/api?cmd=autocomplete&lang=en_US&text=Welcome%20to

POST

POST https://endpoint/api
Content-Type: application/json

{
  "cmd": "autocomplete",
  "lang": "en_US",
  "text": "Welcome to"
}

Response (200 OK):

JSON

Use defaults: format=json, short_answer=false.

{
  "result": {
    "suggestions": [
      " the"
    ]
  }
}

Short JSON

Add short_answer=true.

{
  "r": {
    "s": [
      " the"
    ]
  }
}

Example: no suggestions

Request:

GET

GET https://endpoint/api?cmd=autocomplete&lang=en_US&text=Thank%20you

POST

POST https://endpoint/api
Content-Type: application/json

{
  "cmd": "autocomplete",
  "lang": "en_US",
  "text": "Thank you"
}

Response (200 OK):

JSON

{
  "result": {
    "suggestions": []
  }
}

Short JSON

{
  "r": {
    "s": []
  }
}

Response schema

The response is always an object with a single result.

JSON (short_answer=false)

{
  "result": {
    "suggestions": [
      " the"
    ]
  }
}

• result (object) Always present.

• result.suggestions (array of strings) May be empty. Each item is a completion suffix to append to text.

Short JSON (short_answer=true)

Key mapping:

• result → r

• suggestions → s

Errors

Errors use the shared error format from Overview.

Language code not found (400 Bad Request)

{
  "error": true,
  "message": "Language code not found."
}

Language has no autocomplete support (403 Forbidden)

{
  "error": true,
  "message": "Command 'autocomplete' for language 'es_ES' is not enabled or unsupported."
}