Mark that you started watching

POST

/api/matches/{id}/playback-started

const url = 'https://foxleague.ai/api/matches/1/playback-started';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://foxleague.ai/api/matches/1/playback-started \
  --header 'Authorization: Bearer <token>'

Tells the server you started watching your ranked or casual match. The broadcast clock, which drives resume, the live banner and the moment the result applies, starts by itself the moment the match’s recording is ready, whether anyone watches or not; this call starts it only for a match whose clock is still missing then. A call made before the recording is ready changes nothing and answers {"ok": true, "started": false}: send it again in a few seconds. Once the clock runs, later calls change nothing. A match whose result is already applied is a replay and starts no clock; neither does a match whose broadcast has already ended.

Who: a signed-in player of the match.

Refusals:

You are not a participant in this match: no such match; you are not one of its two players; a tournament or challenge match (it always answers like an unknown id).

Authorizations

session

Parameters

Path Parameters

required

integer format: int32

The match id.

Responses

200

Success or a refusal: read success (the refusals are in the description).

application/json

object

code

A machine-readable reason next to error, set only where the caller must act differently. tx_pending: the payment was not refused but could not be verified yet; keep the transaction hash and confirm again with the same hash, never pay twice.

string | null

data

The answer. Present when success is true.

object

applied

Only on playback-done: false when this call did not apply the result.

boolean

required

Always true.

boolean

started

Only on playback-started: false when the match’s recording is not ready yet, so the broadcast clock did not start: send the call again in a few seconds. Absent once the clock runs and when it will not start.

boolean

error

Why the request was refused, in plain words. Present when success is false.

string | null

success

required

true when the request did what it asked. false is a refusal: read error.

boolean

Example

{
  "data": {
    "ok": true
  },
  "success": true
}

401

No valid session. The body is plain text: Missing Authorization header, Invalid Authorization format, Invalid session token or Session expired or invalid. Sign in again.

text/plain

string

Example

Session expired or invalid