Docs ยท api

REST API

Conceptual REST API overview for LynxRelay.

The Godot SDK is the recommended integration path for early builds.

Health

GET /health

Read relay

GET /v1/relays/{relay_id}

Example relay state:

{
  "relay_id": "event.sunfall",
  "value": 206,
  "target": 220,
  "completion_version": 1,
  "previous_target": 100,
  "next_required": 120
}

Increment relay

POST /v1/relays/{relay_id}/increment

Sync relay

POST /v1/relays/{relay_id}/sync

Example claim response:

{
  "claim": {
    "available": true,
    "completion_count": 3,
    "from_version": 46,
    "to_version": 49
  }
}

Security note

Game keys identify a game and help prevent casual misuse, but they are not a substitute for deeper fraud prevention in high-stakes economies.