Get current quota

Read current rolling compute use and remaining headroom.

GET /api/v1/users/{user_id}/quota

Get current quota

cURL

curl --request GET \
  --url https://sprites-gateway.api.synthlabs.ai/api/v1/users/{user_id}/quota \
  --header 'Authorization: Bearer <token>'

200

{
  "max_compute_seconds": 123,
  "quota_exhausted": true,
  "remaining_compute_seconds": 1,
  "used_compute_seconds": 1,
  "utilization_pct": 50,
  "window_end": "2023-11-07T05:31:56Z",
  "window_seconds": 123,
  "window_start": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Synth customer access token for the current user and organization.

Path Parameters

user_id · string<uuid> · required

Response

200

application/json

Current rolling-window quota state for the user.

Current quota status for a user within the rolling window.

max_compute_seconds · number · required

quota_exhausted · boolean · required

remaining_compute_seconds · number · required

Required range: x >= 0

used_compute_seconds · number · required

Required range: x >= 0

utilization_pct · number · required

Required range: 0 <= x <= 100

window_end · string<date-time> · required

End of current rolling window (now)

window_seconds · integer · required

Rolling window size in seconds (e.g. 18000 = 5h)

window_start · string<date-time> · required

Start of current rolling window