Verify

The cost of this verification. This will be subtracted from the ratelimit. Use this if you need to ratelimit based on what the user is trying to access. For example, you may want to ratelimit a user based on the tokens they are using in the context of LLM APIs.

The id of the key you are verifying.

Whether or not this key is valid and has passed the ratelimit. If false you should not grant access to whatever the user is requesting

The name of the key you are verifying.

If you have set an ownerId on this key it is returned here. You can use this to clearly authenticate a user in your system.

This is the meta data you have set when creating the key.

Example:

{
  "billingTier": "PRO",
  "trialEnds": "2023-06-16T17:16:37.161Z"
}

The unix timestamp in milliseconds indicating when this key expires.

The current ratelimit state.

Shows how many more times this key may be verified before being invalidated. Only applies to keys where you have set a remaining count.

If the key is invalid this field will be set to the reason why it is invalid.

Possible values are:

• NOT_FOUND - The key does not exist
• FORBIDDEN - You are not allowed to verify this key. For example because of additional security checks like IP whitelists
• USAGE_EXCEEDED - The key has been used up and is no longer valid
• RATE_LIMITED - The verification has been blocked due to ratelimiting
• DISABLED - the key is disabled

Shows if the key is enabled or disabled.

A list of all the permissions this key is connected to.

The environment of the key, this is what what you set when you crated the key

The associated identity of this key.