Skip to main content
GET
Delete API Key

Request contract

Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

Cost and request rules

Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.
  • Default request reference estimate (USD): 0.012
  • Cost contract: explicit_zero
  • Settlement evidence source: request_snapshot

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

api_key_id
string
required

ID of api key.

Response

Response with status 200

An API key presented as a bearer token in the Authorization header.

api_key_id
string
required

ID of api key.

created_at
string<date-time>
required

Time at which api key was created.

name
string
required

Name of api key.

prefix
string
required

Prefix of api key.

type
enum<string>
required
Available options:
bearer
updated_at
string<date-time>
required

Time at which api key was last updated.

expires_at
string<date-time>

Time at which api key expires. Omitted when it does not expire.

inbox_id
string

Inbox ID the api key is scoped to. If set, the key can only access resources within this inbox.

permissions
ApiKeyPermissions · object

Granular permissions for the API key. When ommitted all permissions are granted. Otherwise, only permissions set to true are granted.

pod_id
string

Pod ID the api key is scoped to. If set, the key can only access resources within this pod.

used_at
string<date-time>

Time at which api key was last used.