API reference
Versions
Available from Phase 3
The HTTP API is not live yet. These endpoints are the planned contract, generated from the same schema the server will use. Paths and fields can still change before they ship.
GET
/api/v1/sets/{ref}/versionsAuthorizationBearer <token>
An app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Path Parameters
ref*string
Length
1 <= lengthQuery Parameters
limit?integer
Range
1 <= value <= 200Default
50cursor?string
Length
1 <= lengthResponse Body
application/json
application/json
curl -X GET "https://example.com/api/v1/sets/string/versions"{ "data": [ null ], "nextCursor": "string"}GET
/api/v1/sets/{ref}/versions/{n}AuthorizationBearer <token>
An app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Path Parameters
ref*string
Length
1 <= lengthn*integer
Range
0 < value <= 9007199254740991Response Body
application/json
application/json
curl -X GET "https://example.com/api/v1/sets/string/versions/1"nullGET
/api/v1/sets/{ref}/diffAuthorizationBearer <token>
An app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Path Parameters
ref*string
Length
1 <= lengthQuery Parameters
from*string||
to*string||
Response Body
application/json
application/json
curl -X GET "https://example.com/api/v1/sets/string/diff?from=draft&to=draft"{ "from": "string", "to": "string", "changes": [ { "path": "string", "op": "add", "before": "string", "after": "string" } ], "interface": { "breaking": [ "string" ], "additive": [ "string" ] }}Bandwise is an independent product built on TypeSafe's System One models. It is not TypeSafe's documentation. For the System One models themselves, see docs.typesafe.ai.