AgentMail inboxes > api-keys API
The inboxes > api-keys API from AgentMail — 2 operation(s) for inboxes > api-keys.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/agentmail-inboxes-api-keys-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
title: Reference inboxes > api-keys API
version: 1.0.0
servers:
- url: https://api.agentmail.to
description: prod
- url: https://x402.api.agentmail.to
description: prod-x402
- url: https://mpp.api.agentmail.to
description: prod-mpp
- url: https://api.agentmail.eu
description: eu-prod
tags:
- name: inboxes > api-keys
paths:
/v0/inboxes/{inbox_id}/api-keys:
get:
operationId: list
summary: List API Keys
description: '**CLI:**
```bash
agentmail inboxes:api-keys list --inbox-id <inbox_id>
```'
tags:
- inboxes > api-keys
parameters:
- name: inbox_id
in: path
required: true
schema:
$ref: '#/components/schemas/type_inboxes_InboxId'
- name: limit
in: query
required: false
schema:
$ref: '#/components/schemas/type__Limit'
- name: page_token
in: query
required: false
schema:
$ref: '#/components/schemas/type__PageToken'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_api-keys_ListApiKeysResponse'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type__ErrorResponse'
post:
operationId: create
summary: Create API Key
description: '**CLI:**
```bash
agentmail inboxes:api-keys create --inbox-id <inbox_id> --name "My Key"
```'
tags:
- inboxes > api-keys
parameters:
- name: inbox_id
in: path
required: true
schema:
$ref: '#/components/schemas/type_inboxes_InboxId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_api-keys_CreateApiKeyResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type__ValidationErrorResponse'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type__ErrorResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/type_api-keys_CreateApiKeyRequest'
/v0/inboxes/{inbox_id}/api-keys/{api_key_id}:
delete:
operationId: delete
summary: Delete API Key
description: '**CLI:**
```bash
agentmail inboxes:api-keys delete --inbox-id <inbox_id> --api-key-id <api_key_id>
```'
tags:
- inboxes > api-keys
parameters:
- name: inbox_id
in: path
required: true
schema:
$ref: '#/components/schemas/type_inboxes_InboxId'
- name: api_key_id
in: path
required: true
schema:
$ref: '#/components/schemas/type_api-keys_ApiKeyId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
responses:
'200':
description: Successful response
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type__ErrorResponse'
components:
schemas:
type_api-keys_CreateApiKeyRequest:
type: object
properties:
name:
$ref: '#/components/schemas/type_api-keys_Name'
permissions:
$ref: '#/components/schemas/type_api-keys_ApiKeyPermissions'
title: CreateApiKeyRequest
type__ErrorFix:
type: string
description: The concrete next action that resolves the error.
title: ErrorFix
type__Count:
type: integer
description: Number of items returned.
title: Count
type_api-keys_CreatedAt:
type: string
format: date-time
description: Time at which api key was created.
title: CreatedAt
type__ValidationErrorResponse:
type: object
properties:
name:
$ref: '#/components/schemas/type__ErrorName'
code:
$ref: '#/components/schemas/type__ErrorCode'
message:
$ref: '#/components/schemas/type__ErrorMessage'
errors:
description: Validation errors. Each entry has a path and a message identifying the invalid field.
fix:
$ref: '#/components/schemas/type__ErrorFix'
docs:
$ref: '#/components/schemas/type__ErrorDocs'
required:
- name
- errors
title: ValidationErrorResponse
type__ErrorName:
type: string
description: Name of error.
title: ErrorName
type__ErrorResponse:
type: object
properties:
name:
$ref: '#/components/schemas/type__ErrorName'
code:
$ref: '#/components/schemas/type__ErrorCode'
message:
$ref: '#/components/schemas/type__ErrorMessage'
fix:
$ref: '#/components/schemas/type__ErrorFix'
docs:
$ref: '#/components/schemas/type__ErrorDocs'
required:
- name
- message
title: ErrorResponse
type_api-keys_ApiKeyId:
type: string
description: ID of api key.
title: ApiKeyId
type__ErrorMessage:
type: string
description: Error message.
title: ErrorMessage
type_api-keys_Name:
type: string
description: Name of api key.
title: Name
type__PageToken:
type: string
description: Page token for pagination.
title: PageToken
type_api-keys_Prefix:
type: string
description: Prefix of api key.
title: Prefix
type__ErrorCode:
type: string
description: Stable, machine-readable error code in snake_case (for example, not_found or missing_permission). Branch on this rather than the message text.
title: ErrorCode
type__Limit:
type: integer
description: Limit of number of items returned.
title: Limit
type_api-keys_ApiKey:
type: object
properties:
api_key_id:
$ref: '#/components/schemas/type_api-keys_ApiKeyId'
prefix:
$ref: '#/components/schemas/type_api-keys_Prefix'
name:
$ref: '#/components/schemas/type_api-keys_Name'
pod_id:
type: string
description: Pod ID the api key is scoped to. If set, the key can only access resources within this pod.
inbox_id:
type: string
description: Inbox ID the api key is scoped to. If set, the key can only access resources within this inbox.
used_at:
type: string
format: date-time
description: Time at which api key was last used.
permissions:
$ref: '#/components/schemas/type_api-keys_ApiKeyPermissions'
created_at:
$ref: '#/components/schemas/type_api-keys_CreatedAt'
required:
- api_key_id
- prefix
- name
- created_at
title: ApiKey
type_inboxes_InboxId:
type: string
description: The ID of the inbox.
title: InboxId
type_api-keys_CreateApiKeyResponse:
type: object
properties:
api_key_id:
$ref: '#/components/schemas/type_api-keys_ApiKeyId'
api_key:
type: string
description: API key.
prefix:
$ref: '#/components/schemas/type_api-keys_Prefix'
name:
$ref: '#/components/schemas/type_api-keys_Name'
pod_id:
type: string
description: Pod ID the api key is scoped to.
inbox_id:
type: string
description: Inbox ID the api key is scoped to.
permissions:
$ref: '#/components/schemas/type_api-keys_ApiKeyPermissions'
created_at:
$ref: '#/components/schemas/type_api-keys_CreatedAt'
required:
- api_key_id
- api_key
- prefix
- name
- created_at
title: CreateApiKeyResponse
type_api-keys_ListApiKeysResponse:
type: object
properties:
count:
$ref: '#/components/schemas/type__Count'
next_page_token:
$ref: '#/components/schemas/type__PageToken'
api_keys:
type: array
items:
$ref: '#/components/schemas/type_api-keys_ApiKey'
description: Ordered by `created_at` descending.
required:
- count
- api_keys
title: ListApiKeysResponse
type_api-keys_ApiKeyPermissions:
type: object
properties:
inbox_read:
type: boolean
description: Read inbox details.
inbox_create:
type: boolean
description: Create new inboxes.
inbox_update:
type: boolean
description: Update inbox settings.
inbox_delete:
type: boolean
description: Delete inboxes.
thread_read:
type: boolean
description: Read threads.
thread_delete:
type: boolean
description: Delete threads.
message_read:
type: boolean
description: Read messages.
message_send:
type: boolean
description: Send messages.
message_update:
type: boolean
description: Update message labels.
label_spam_read:
type: boolean
description: Access messages labeled spam.
label_blocked_read:
type: boolean
description: Access messages labeled blocked.
label_trash_read:
type: boolean
description: Access messages labeled trash.
draft_read:
type: boolean
description: Read drafts.
draft_create:
type: boolean
description: Create drafts.
draft_update:
type: boolean
description: Update drafts.
draft_delete:
type: boolean
description: Delete drafts.
draft_send:
type: boolean
description: Send drafts.
webhook_read:
type: boolean
description: Read webhook configurations.
webhook_create:
type: boolean
description: Create webhooks.
webhook_update:
type: boolean
description: Update webhooks.
webhook_delete:
type: boolean
description: Delete webhooks.
domain_read:
type: boolean
description: Read domain details.
domain_create:
type: boolean
description: Create domains.
domain_update:
type: boolean
description: Update domains.
domain_delete:
type: boolean
description: Delete domains.
list_entry_read:
type: boolean
description: Read list entries.
list_entry_create:
type: boolean
description: Create list entries.
list_entry_delete:
type: boolean
description: Delete list entries.
metrics_read:
type: boolean
description: Read metrics.
api_key_read:
type: boolean
description: Read API keys.
api_key_create:
type: boolean
description: Create API keys.
api_key_delete:
type: boolean
description: Delete API keys.
pod_read:
type: boolean
description: Read pods.
pod_create:
type: boolean
description: Create pods.
pod_delete:
type: boolean
description: Delete pods.
description: Granular permissions for the API key. When ommitted all permissions are granted. Otherwise, only permissions set to true are granted.
title: ApiKeyPermissions
type__ErrorDocs:
type: string
description: Link to the error reference entry for this code.
title: ErrorDocs
securitySchemes:
Bearer:
type: http
scheme: bearer