WebsiteDashboard
GETresults:read

List capabilities

List capabilities.

Request

GEThttps://api.cymatics.tech/v1/capabilities

Send your key as Authorization: Bearer cym_test_…. Requires the results:read scope. Test keys read the simulator; live keys read your paired Cymos.

device_idstringqueryDevice id
room_idstringqueryRoom id

Response

200 · application/json
{
  "data": [
    {
      "id": "id_01",
      "test_available": true,
      "live_available": true,
      "simulated": true,
      "max_stream_rate_hz": 1,
      "result_cadence": "result_cadence"
    }
  ],
  "meta": {
    "request_id": "req_01",
    "project_id": "proj_demo",
    "livemode": false,
    "generated_at": "2026-10-24T23:55:30.000Z"
  },
  "page": {
    "has_more": false,
    "next_cursor": "cur_01"
  }
}

Errors

  • 429rate_limit_exceeded: Too many requests this minute for the key (or twice that across the project), or too many open streams for the project. Retry after the seconds in Retry-After.quota_exceeded: A live key's project has used its monthly live-hour cap. There is no Retry-After. Don't retry; raise the live-hour cap in the dashboard. Headers: Retry-After, RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.
  • 503live_unavailable: This operation has no live data for this project yet (for example, no paired Cymo covers it). Don't retry the same request; pair a Cymo that covers it, or build against a test key.service_unavailable: A dependency, such as API key verification, is unreachable, or the project is busy with another write. Retry after the seconds in Retry-After, with backoff.
  • 4XXInvalid request, credential, permission or revision.
  • defaultError with a stable code and request ID.

Every error is a { error, meta } envelope with a stable code. See Errors for each code and whether to retry.

Call it

TypeScript · @cymos/sdk
import { Cymo } from "@cymos/sdk";

const cymo = new Cymo({ apiKey: process.env.CYMO_API_KEY! });

const { data, meta } = await cymo.capabilities.list({
  room_id: "room_bedroom"
});
terminal · cymatics CLI
$ cymatics capabilities list --room-id room_bedroom --json
curl
curl "https://api.cymatics.tech/v1/capabilities?room_id=room_bedroom" \
  -H "Authorization: Bearer $CYMO_API_KEY"
MCP tool
list_capabilities({ room_id: "room_bedroom" })

The MCP tool list_capabilities calls this operation with your key.

Try it

GEThttps://api.cymatics.tech/v1/capabilities?room_id=room_bedroom

Paste a test key and preview the response. Test keys read the simulator, so no device is needed.