LIlichess
External engine

Create external engine

Registers a new external engine for the user. It can then be selected and used on the analysis board. After registering, the provider should start waiting for analyis requests.

post/api/external-engine

Request

  • Base URL
    https://lichess.org
  • URL
    https://lichess.org/api/external-engine
  • Auth
    OAuth 2
    Authorization code: https://lichess.org/oauth
    Token URL: https://lichess.org/api/token scopes: engine:write

Request body

namestring required

Display name of the engine.

maxThreadsinteger required

Maximum number of available threads.

maxHashinteger required

Maximum available hash table size, in MiB.

variantsUciVariant[]

Optional list of supported chess variants.

providerSecretstring required

A random token that can be used to wait for analysis requests and provide analysis.

The engine provider should securely generate a random string.

The token will not be readable again, even by the user.

The analysis provider can register multiple engines with the same token, even for different users, and wait for analysis requests from any of them. In this case, the request must not be made via CORS, so that the token is not revealed to any of the users.

providerDatastring

Arbitrary data that the engine provider can use for identification or bookkeeping.

Users can read this information, but updating it requires knowing or changing the providerSecret.

Example request

{
  "name": "Stockfish 15",
  "maxThreads": 8,
  "maxHash": 2048,
  "providerSecret": "Dee3uwieZei9ahpaici9bee2yahsai0K"
}

Response

The registered engine.

idstring required

Unique engine registration ID.

namestring required

Display name of the engine.

clientSecretstring required

A secret token that can be used to request analysis from this external engine.

userIdstring required

The user this engine has been registered for.

maxThreadsinteger required

Maximum number of available threads.

maxHashinteger required

Maximum available hash table size, in MiB.

variantsUciVariant[] required

List of supported chess variants.

providerDatastring nullable

Arbitrary data that the engine provider can use for identification or bookkeeping.

Users can read this information, but updating it requires knowing or changing the providerSecret.

Changes

No recorded changes to this operation across all 16 revisions of this API.