Reference
API reference
The OpenAPI document is the list, generated from the routes that are served.
The OpenAPI document is generated from the route table, so it cannot describe a path that does not exist. Each operation is named for the command that reaches it, and both the TypeScript and Python clients take their method names from that: models.add is seams models add is seams.models.add().
cli
https://api.ourseams.com/v1/openapi.jsonEvery operation, with the command and the route that reach it, is on the Every operation page. That table is generated from this document, so the two cannot disagree.
A few you will reach for first
| Method | Path | Operation |
|---|---|---|
| GET | /v1/usage | usage |
| GET | /v1/end-users | users.list |
| POST | /v1/keys | keys.mint |
| POST | /v1/portal-sessions | portal.link |
| PUT | /v1/providers/{label} | providers.connect |
Conventions
| Auth | authorization: Bearer sk_… on every route; there is no unauthenticated read |
| Ids | ULID, prefixed by type: org_, eu_, key_, wal_, led_, crd_, req_ |
| Money | Integer micro-dollars as a string; 1000000 is $1.00 |
| Times | ISO 8601, always UTC |
| Errors | A stable code, an HTTP status, and never internal detail |