Check whether the current user can use a service or feature

POST

/v1/entitlements/check

请求参数

Body 参数application/json必填

示例

{
    "service": "ai.refine",
    "feature": "electron.hotkey.dictation",
    "workflow": "string",
    "estimatedMetrics": {
        "inputChars": 0,
        "outputChars": 0,
        "audioSeconds": 0,
        "inputTokens": 0,
        "outputTokens": 0,
        "totalTokens": 0,
        "requestCount": 1
    }
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/v1/entitlements/check' \
--header 'Content-Type: application/json' \
--data '{
    "service": "ai.refine",
    "feature": "electron.hotkey.dictation",
    "workflow": "string",
    "estimatedMetrics": {
        "inputChars": 0,
        "outputChars": 0,
        "audioSeconds": 0,
        "inputTokens": 0,
        "outputTokens": 0,
        "totalTokens": 0,
        "requestCount": 1
    }
}'

返回响应

🟢200成功

application/json

Entitlement decision returned.

Bodyapplication/json

示例

{
    "endpoint": "POST /v1/entitlements/check",
    "allowed": true,
    "reason": "string",
    "entitlement": {
        "userId": "string",
        "planId": "string",
        "features": {
            "property1": true,
            "property2": true
        },
        "periodStart": "2019-08-24T14:15:22.123Z",
        "periodEnd": "2019-08-24T14:15:22.123Z",
        "expiresAt": "2019-08-24T14:15:22.123Z",
        "source": "string",
        "readAt": "2019-08-24T14:15:22.123Z"
    },
    "quota": {
        "state": "available",
        "usedChars": 0,
        "reservedChars": 0,
        "limitChars": 0,
        "remainingChars": 0,
        "periodStart": "2019-08-24T14:15:22.123Z",
        "resetsAt": "2019-08-24T14:15:22.123Z"
    }
}

修改于 2026-08-26 04:04:36

Ingest a usage event

Atomically reserve weekly input-character quota before a billable provider action