Overview

Endpoints, request format, and parameters common to all HTTP API commands.

The HTTP API uses a single endpoint.

It is not RESTful.

You control the API using the cmd parameter.

On this page

• API endpoint

• Request method

• cmd (command)

• Common parameters

  • serviceid

  • format

  • callback

  • short_answer

• Boolean parameter values

• Errors

API endpoint

Cloud

https://svc.webspellchecker.net/api

Pass parameters in the query string (GET) or request body (POST).

serviceid is required.

On-premises

Request method

Use GET or POST.

There is no functional difference.

• GET: parameters go in the URL query string.

• POST: parameters go in the request body.

  • Raw key=value&... parameters.

  • Or a JSON payload.

cmd (command)

cmd selects the operation to run.

Examples: check, autocorrect, autocomplete.

See command docs for the full parameter list per command.

• Check API

• Spelling autocorrect API

• Text autocomplete API

• Custom dictionary API

• User custom dictionary API

• Detect language API

• Auxiliary API commands

Common parameters

These parameters can be used with any cmd.

At a glance:

• serviceid: Cloud API key

• format: response format (json or xml)

• callback: JSONP wrapper (JSON only)

• short_answer: shorten JSON keys (true or false)

serviceid

Cloud only. Required for Cloud requests.

API key required to make requests.

format

Default: json.

Response format.

Supported values:

• json (default)

• xml

callback

Use it only with format=json.

Wraps the response as JSONP:

/**/<callback_value>(<actual_response>)

serviceid

Cloud only. Required for Cloud requests.

API key required to make requests.

short_answer (boolean)

JSON only. It does not affect XML output.

When true, shortens keys in the JSON response.

This reduces the response size.

Example (short_answer=false):

{
  "result": [
    {
      "matches": [
        {
          "type": "spelling",
          "offset": 0,
          "length": 4,
          "message": "Spelling mistake",
          "probability": 1,
          "suggestions": [
            "hello",
            "hole",
            "help"
          ]
        }
      ]
    }
  ]
}

Example (short_answer=true):

{
  "r": [
    {
      "m": [
        {
          "t": "spelling",
          "o": 0,
          "l": 4,
          "m": "Spelling mistake",
          "p": 1,
          "s": [
            "hello",
            "hole",
            "help"
          ]
        }
      ]
    }
  ]
}

Boolean parameter values

When a parameter is boolean, these values are accepted.

True values:

• yes

• y

• 1

• enable

• on

• true

• t

False values:

• no

• n

• 0

• disable

• off

• false

• f

Errors

See HTTP response status codes.

Errors across commands use the same response structure.

• error: always true for an error response

• message: human-readable description

Example:

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