Bandwise docs
API reference

Review

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/review

Authorization

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

Query Parameters

kind?string

Value in

  • "action"
  • "label"
status?string

Value in

  • "open"
  • "pending_confirmation"
  • "resolved"
  • "dismissed"
limit?integer
Range1 <= value <= 200
Default50
cursor?string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/review"
{  "data": [    null  ],  "nextCursor": "string"}

Assign a review item.

POST/api/v1/review/{id}/assign

Authorization

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

id*string
Formatuuid

Header Parameters

Idempotency-Key?string

Required for app and agent tokens on mutations. A replay within 24 hours returns the stored response.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/review/497f6eca-6276-4993-bfeb-53cbbbba6f08/assign" \  -H "Content-Type: application/json" \  -d '{    "property1": null,    "property2": null  }'
null
POST/api/v1/review/{id}/resolve

Authorization

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

id*string
Formatuuid

Header Parameters

Idempotency-Key?string

Required for app and agent tokens on mutations. A replay within 24 hours returns the stored response.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/review/497f6eca-6276-4993-bfeb-53cbbbba6f08/resolve" \  -H "Content-Type: application/json" \  -d '{    "resolution": "string"  }'
null

Dismiss a review item.

POST/api/v1/review/{id}/dismiss

Authorization

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

id*string
Formatuuid

Header Parameters

Idempotency-Key?string

Required for app and agent tokens on mutations. A replay within 24 hours returns the stored response.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/review/497f6eca-6276-4993-bfeb-53cbbbba6f08/dismiss" \  -H "Content-Type: application/json" \  -d '{    "property1": null,    "property2": null  }'
null
POST/api/v1/review/{id}/confirm

Authorization

consoleSession
session<token>

The console session cookie. Its real name comes from the auth library (ADR-002).

In: cookie

Path Parameters

id*string
Formatuuid

Header Parameters

Idempotency-Key?string

Required for app and agent tokens on mutations. A replay within 24 hours returns the stored response.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/review/497f6eca-6276-4993-bfeb-53cbbbba6f08/confirm" \  -H "Content-Type: application/json" \  -d '{}'
null

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.