Skip to content
Open Markdown

Stop the caller's open sessions ​

POST /v1/me/sessions/stop

  • Operation ID: stopGameSessions
  • Tags: Game sessions
  • Base URL: http://localhost:8787

Idempotent. Returns stopped: false when the caller has no open session.

Workflow: Integration guide.

Authentication: Platform user Bearer JWT. Acts only on the caller's own data.

Authentication ​

  • Auth: Platform user Bearer JWT (Authorization: Bearer <access_token>).

Responses ​

200 ​

Result.

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object

FieldTypeRequiredDescription
stoppedbooleanyes-

Errors ​

401 ​

Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody)

FieldTypeRequiredDescription
errorstringyesStable machine-readable error code, e.g. forbidden, not_found.
detailsanynoOptional structured context. For 403 it is { perm }.

Error response

json
{
  "error": "missing_token"
}

500 ​

Unexpected server error (internal). No details are returned.

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

json
{
  "error": "internal"
}

503 ​

unavailable: the runtime could not stop the session; retry.

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

json
{
  "error": "unavailable"
}

Examples ​

curl ​

bash
curl -X POST 'http://localhost:8787/v1/me/sessions/stop' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

TypeScript ​

ts
const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/me/sessions/stop", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
  },
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();

Try this endpoint

Requests go directly from your browser to the API. Send request executes this endpoint against the selected server.

POST/v1/me/sessions/stop

Your token stays in this tab's memory and is sent only when you press Send request.

Built for developers. Ready for agents.