For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
contact@agentmail.ccDiscord
DocumentationAPI ReferenceKnowledge BaseChangelog
DocumentationAPI ReferenceKnowledge BaseChangelog
  • API Reference
      • GETWho Am I
LogoLogo
contact@agentmail.ccDiscord
API ReferenceAuth

Who Am I

GET
/v0/auth/me
GET
/v0/auth/me
1from agentmail import AgentMail
2
3client = AgentMail(
4    api_key="YOUR_TOKEN_HERE",
5)
6
7client.auth.me()
200Retrieved
1{
2  "scope_type": "organization",
3  "scope_id": "scope_id",
4  "organization_id": "organization_id",
5  "pod_id": "pod_id",
6  "inbox_id": "inbox_id",
7  "api_key_id": "api_key_id"
8}
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 ```
Was this page helpful?
Previous
Built with

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:

$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.
Allowed values:
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.