ai

Whether the current user can use AI right now, and if not, why

Changed on
get/v1/org/{orgId}/ai/status

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/ai/status
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

Response

successful operation

state'OK' | 'LIMIT_REACHED' | 'DISABLED' required

whether the user can use AI right now

reason'ORG_DISABLED' | 'USER_DISABLED' | 'ORG_CAP' | 'USER_LIMIT'

why AI is unavailable; absent when state is OK

resetDatestring date required

first day of next month, when monthly limits reset

usednumber

credits the user has used this month; present only when a per-user monthly limit applies

limitinteger

the user's monthly credit limit; present only when one applies

Changes