List And Create Inbox API Keys

Retrieve a list of API keys for a specific inbox or create a new API key with optional permissions and name. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->

GET https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/api-keys

List And Create Inbox API Keys

cURL

curl --request GET \
  --url https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/api-keys \
  --header 'Authorization: Bearer <token>'

200

{
  "api_keys": [
    {
      "api_key_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "prefix": "<string>",
      "type": "bearer",
      "updated_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z",
      "inbox_id": "<string>",
      "permissions": {
        "account_update": true,
        "api_key_create": true,
        "api_key_delete": true,
        "api_key_read": true,
        "api_key_update": true,
        "app_connect": true,
        "app_share_owner": true,
        "calendar_event_create": true,
        "calendar_event_delete": true,
        "calendar_event_read": true,
        "calendar_event_update": true,
        "calendar_read": true,
        "calendar_update": true,
        "domain_create": true,
        "domain_delete": true,
        "domain_read": true,
        "domain_update": true,
        "draft_create": true,
        "draft_delete": true,
        "draft_read": true,
        "draft_send": true,
        "draft_update": true,
        "inbox_create": true,
        "inbox_delete": true,
        "inbox_read": true,
        "inbox_update": true,
        "label_blocked_read": true,
        "label_spam_read": true,
        "label_trash_read": true,
        "label_unauthenticated_read": true,
        "list_entry_create": true,
        "list_entry_delete": true,
        "list_entry_read": true,
        "message_delete": true,
        "message_read": true,
        "message_reply": true,
        "message_send": true,
        "message_update": true,
        "metrics_read": true,
        "pod_create": true,
        "pod_delete": true,
        "pod_read": true,
        "pod_update": true,
        "webhook_create": true,
        "webhook_delete": true,
        "webhook_read": true,
        "webhook_update": true
      },
      "pod_id": "<string>",
      "used_at": "2023-11-07T05:31:56Z"
    }
  ],
  "count": 123,
  "next_page_token": "<string>"
}

Request contract

• Method and path: GET /apis/v1/agentmail/inboxes/{inbox_id}/api-keys
• Availability: enabled
• Request URL template: https://api.aisa.one/apis/v1/agentmail/inboxes/&#123;inbox&#95;id&#125;/api-keys
• inbox_id: path; required
• limit: query; optional
• page_token: query; optional
• Runtime facts: 18a04e28941fae19674c11246b677373368b6bd927b7c146220cec1f168f4639

Complete OpenAPI definition

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

{
  "operationId": "get_any_agentmail_apis_v1_agentmail_inboxes_inbox_81bd1e",
  "method": "GET",
  "path": "/apis/v1/agentmail/inboxes/{inbox_id}/api-keys",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [
    {
      "in": "path",
      "name": "inbox_id",
      "required": true,
      "schema": {
        "description": "The ID of the inbox.",
        "title": "InboxId",
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "limit",
      "required": false,
      "schema": {
        "description": "Limit of number of items returned.",
        "title": "Limit",
        "type": "integer"
      }
    },
    {
      "in": "query",
      "name": "page_token",
      "required": false,
      "schema": {
        "description": "Page token for pagination.",
        "title": "PageToken",
        "type": "string"
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "x-aisa-status": "enabled",
  "x-aisa-pricing": {
    "cost_contract": "explicit_zero",
    "customer_pricing": "fixed_success",
    "default_request_estimate_usd": 0.012,
    "estimate_source": "profile_seed",
    "evidence_source": "request_snapshot"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}

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

inbox_id · string · required

The ID of the inbox.

Query Parameters

limit · integer

Limit of number of items returned.

page_token · string

Page token for pagination.

Response

200

application/json

Response with status 200

api_keys · (BearerApiKey · object | PublicKeyCredential · object)[] · required

Every credential family, ordered by created_at. type restricts to one family.

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

BearerApiKey

PublicKeyCredential

Show child attributes

count · integer · required

Number of items returned.

next_page_token · string

Page token for pagination.