LIlichess
External engine

Get external engine

Get properties and credentials of an external engine.

get/api/external-engine/{id}

Request

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

Response

A 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.