v3

OpenAPI 3.1.0AGPL-3.0-or-later2026-07-311871891.1 MB

Challenges

Open-ended challenge

Create a challenge that any 2 players can join. Share the URL of the challenge. the first 2 players to click it will be paired for a game. The response body also contains whiteUrl and blackUrl. You can control which color each player gets by giving them these URLs, instead of the main challenge URL. Open challenges expire after 24h. If the challenge creation is authenticated with OAuth2, then you can use the challenge cancel endpoint to cancel it. To directly pair 2 known players, use this endpoint instead.

post/api/challenge/open

Response

The challenge was successfully created.

idstring required

urlstring uri required

status'created' | 'offline' | 'canceled' | 'declined' | 'accepted' required

{"stackTrail":"components:schemas:ChallengeOpenJson:properties:challenger","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:ChallengeOpenJson:properties:destUser","oasType":"schema","type":"unknown"}

ratedboolean required

color'white' | 'black' | 'random' required

finalColor'white' | 'black'

initialFenstring

urlWhitestring uri required

urlBlackstring uri required

Example response

{
  "variant": {
    "key": "standard"
  },
  "timeControl": {
    "show": "5+2"
  }
}