v3

latestOpenAPI 3.1.0AGPL-3.0-or-later2026-07-311871891.1 MB
External engine

Acquire analysis request

Endpoint: https://engine.lichess.ovh/api/external-engine/work

Wait for an analysis requests to any of the external engines that have been registered with the given providerSecret. Uses long polling. After acquiring a request, the provider should immediately start streaming the results.

post/api/external-engine/work

Request body

providerSecretstring required

Example request

{
  "providerSecret": "Dee3uwieZei9ahpaici9bee2yahsai0K"
}

Response

Analysis has been requested

idstring required

Example response

{
  "id": "aingoohiJee2sius",
  "work": {
    "variant": "chess"
  },
  "engine": {
    "variants": [
      "chess"
    ]
  }
}