crate.surfaces()
surfaces(opts?: RequestOptions): Promise<SurfaceIndexResponse>The generic surface registry — every queryable cluster-keyed producer surface crate exposes (cycle-096 / carrefour#135’s confirmed-cost corollary: one generic accessor, not a method per surface), with its shape: grain, key (column + keyspace + wire format), keyset (pagination seek columns; null for cluster-row grain), cap, liveness, and a coverage note. Read a row here before calling surface on its name — it’s the complete input contract for that call.
| Endpoint | GET /api/v2/surface |
| Auth | key |
| Returns | SurfaceIndexResponse |
| Retryable | yes |
| Idempotent | yes |
Example
Section titled “Example”const reg = await crate.surfaces();reg.surfaces.forEach((s) => console.log(s.name, s.key.keyspace, s.grain));Throws
Section titled “Throws”CrateAPIError— on a non-2xx response.