> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Whoami

> Return the caller's identity: organization, tier, key metadata, limits.

Works for every valid key. `/account` is an undocumented alias so both
natural spellings resolve.



## OpenAPI

````yaml get /v1/me
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security:
  - BearerAuth: []
paths:
  /v1/me:
    get:
      tags:
        - Account
      summary: Whoami
      description: |-
        Return the caller's identity: organization, tier, key metadata, limits.

        Works for every valid key. `/account` is an undocumented alias so both
        natural spellings resolve.
      operationId: whoami_v1_me_get
      parameters: []
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    MeResponse:
      properties:
        organization_id:
          type: string
          title: Organization Id
          description: User-facing organization id (safe to log).
        organization_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Organization Name
          description: The organization's display name.
        account_type:
          type: string
          title: Account Type
          description: Account tier (e.g. FREE, BUILD, SCALE).
        user_email:
          anyOf:
            - type: string
            - type: 'null'
          title: User Email
          description: Email of the user owning the API key.
        key:
          $ref: '#/components/schemas/MeKeyInfo'
          description: The requesting key's metadata.
        rate_limits:
          additionalProperties:
            type: integer
          type: object
          title: Rate Limits
          description: >-
            Effective per-minute rate limits by category
            (metadata/data/search/upload/compute) for this organization.
        principal_scoped:
          type: boolean
          title: Principal Scoped
          description: >-
            True when this key is end-user scoped (document ACL filtering
            applies to reads).
          default: false
      type: object
      required:
        - organization_id
        - account_type
        - key
      title: MeResponse
      description: |-
        Who am I? — the identity of the caller, discoverable with any valid key.

        Exists because tier/identity were previously discoverable only via
        /v1/organizations (its own permission surface, and more than identity):
        every agent/SDK session burned calls rediscovering who it was.
      examples:
        - account_type: BUILD
          key:
            key_type: SECRET
            name: backend-service
            permissions:
              - READ
              - WRITE
          organization_id: org_demo123
          organization_name: Acme Corporation
          principal_scoped: false
          rate_limits:
            compute: 15
            data: 120
            metadata: 120
            search: 300
            upload: 30
          user_email: alice@example.com
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    MeKeyInfo:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: The key's human-assigned name.
        key_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Key Type
          description: Key type (e.g. SECRET, SESSION, PUBLIC).
        permissions:
          items:
            type: string
          type: array
          title: Permissions
          description: Permissions granted to this key (READ/WRITE/DELETE/ADMIN).
        expires_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Expires At
          description: Key expiry, if the key expires.
      type: object
      title: MeKeyInfo
      description: Metadata of the API key that made this request. No key material.
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Mixpeek API key, sent as `Authorization: Bearer mxp_sk_...`. Create one
        in Studio under Settings → API Keys, or with an admin key via `POST
        /v1/organizations/users/{user_email}/api-keys`. A missing header returns
        403; an invalid or revoked key returns 401.

````