Get AI entitlement state

GET/v1/ai/entitlement

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

allowedbooleanrequired

limitsAIEntitlementLimit[] | nullrequired

Show properties

Array of AIEntitlementLimit

keystringrequired

limitinteger<int64>required

remaininginteger<int64>required

usedinteger<int64>required

planstringrequired

reasonstringrequired

trial_activebooleanrequired

upgrade_requiredbooleanrequired

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/ai/entitlement"

const response = await fetch("/v1/ai/entitlement", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/ai/entitlement",
)

Response

{
  "allowed": true,
  "limits": [
    {
      "key": "string",
      "limit": 0,
      "remaining": 0,
      "used": 0
    }
  ],
  "plan": "string",
  "reason": "string",
  "trial_active": true,
  "upgrade_required": true
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}