API ReferenceAuth

Who Am I

Returns the identity and scope of the authenticated credential. Useful when a client holds a pod-scoped or inbox-scoped API key and needs to discover the parent organization, pod, or inbox without prior knowledge. **CLI:** ```bash agentmail auth me ```

Authentication

AuthorizationBearer

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

Response

This endpoint returns an object.
scope_typeenum
The scope tier the authenticated credential is bound to.
scope_idstring

ID of the most specific scope the credential is bound to. Equals inbox_id when scope_type is inbox, pod_id when pod, organization_id when organization.

organization_idstring
ID of organization.
pod_idstring

ID of the pod the credential is scoped to. Present when scope_type is pod or inbox.

inbox_idstring

ID of the inbox the credential is scoped to. Present when scope_type is inbox.

api_key_idstring
ID of the API key used to authenticate. Absent for JWT and proxy credentials.