AGagentmail-to
pods > api-keys

Create API Key

Changed on

CLI:

agentmail pods api-keys create --pod-id <pod_id> --name "My Key"
post/v0/pods/{pod_id}/api-keys

Request

  • Base URL
    https://api.agentmail.to
  • URL
    https://api.agentmail.to/v0/pods/{pod_id}/api-keys
  • Auth
    HTTP bearer

Path parameters

pod_idstring required

ID of pod.

Request body

OR

Response

Response with status 200

api_key_idstring required

ID of api key.

api_keystring required

API key.

prefixstring required

Prefix of api key.

namestring required

Name of api key.

pod_idstring

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

inbox_idstring

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

created_atstring date-time required

Time at which api key was created.

expires_atstring date-time

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

Changes

  • 3f5c7830c952Revision changes
    • breaking

      the request's body type changed from object to no type

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      the endpoint scheme security Bearer was added to the API

    • info

      the endpoint scheme security BearerAuth was removed from the API

    • info

      api tag pods > api-keys added

    • info

      api tag PodsApiKeys removed

    • info

      request body became optional

    • info

      added to the request body oneOf list

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 394ddcdd9c29Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status