AppAIGatewayDocs
API referenceApplication

Get the current user's limits, spend and block state

GET
/v1/apps/{app}/me

On an App Attest application the request limits and, by default, the budget are the install's; install_id names it. Signed with X-AppAttest-Proof like every other request where the application verifies App Attest on every request.

Authorization

GatewayBearer
AuthorizationBearer <token>

A gateway access token, or an application API key for an issuer-less API-key app.

In: header

Path Parameters

app*string

Header Parameters

x-app-version?string

Required for gateway-token clients; optional for issuer-less API-key clients.

x-appattest-proof?string

Required on every request sent with the gateway token of an App Attest application whose authentication.app_attest.verify_on is every_request; ignored, and never forwarded, where verify_on is token_exchange and for API-key clients. Format v1.<timestamp>.<nonce>.<assertion>: decimal unix seconds from the device clock (signed, but not compared with the gateway's clock), 16 random bytes as base64url without padding, and the CBOR assertion from DCAppAttestService.generateAssertion as base64url without padding. The assertion's client data is the SHA-256 of these lines joined by \n with no trailing newline: appaigateway-request-v1, the app id, the upper-case HTTP method, the URL path and query exactly as sent, base64url(sha256(body bytes)) (an absent body hashes as empty), base64url(sha256(the bearer token)), the timestamp, and the nonce. Missing answers 401 assertion_required; refused answers 403 attest_failed. The AppAIGateway Swift package 1.4 or later computes it.

Match^v1\.[0-9]{1,12}\.[A-Za-z0-9_-]{22}\.[A-Za-z0-9_-]+$
x-end-user-id?string

Optional configured end-user identity for issuer-less API-key applications.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/apps/string/me"
{  "user_id": "string",  "install_id": "string",  "limits": {    "requests_today": 0,    "requests_remaining": 0,    "requests_per_minute": 0,    "requests_per_day": 0,    "monthly_cost_usd": 0,    "monthly_budget_usd": 0,    "blocked": true  }}