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

# Me

> Returns the workspace and environment bound to the API key.




## OpenAPI

````yaml /openapi.yaml get /me
openapi: 3.1.0
info:
  title: Keette API
  version: 1.0.0
  description: |
    Public HTTP API for Keette workspaces. One base URL — live vs sandbox is
    selected by your API key (`sk_live_…` / `sk_test_…`).

    Endpoints are added as each implementation phase ships.
  contact:
    name: Keette Support
    email: talk@keette.com
servers:
  - url: https://20b9-41-90-209-232.ngrok-free.app/v1
    description: Local (ngrok)
  - url: https://api.keette.com/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Account
    description: Identity for the authenticating API key
  - name: Balances
    description: Wallet books
  - name: Beneficiaries
    description: Payout recipients
  - name: Transactions
    description: Unified transaction index
  - name: FX
    description: Indicative rates and firm quotes
  - name: Catalog
    description: Payout corridors and relationships
  - name: Payouts
    description: Send money to a beneficiary
  - name: Payins
    description: Collect money into your books
  - name: Swaps
    description: FX between your own books
  - name: Events
    description: Durable event log for webhook polling
paths:
  /me:
    get:
      tags:
        - Account
      summary: Me
      description: |
        Returns the workspace and environment bound to the API key.
      operationId: getMe
      responses:
        '200':
          description: Key context
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Me'
              examples:
                sandbox:
                  value:
                    object: me
                    tenant_id: ten_01EXAMPLE
                    environment: sandbox
                    key:
                      id: key_01EXAMPLE
                      prefix: sk_test_19d0
                      expires_at: '2026-12-31T00:00:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    Me:
      type: object
      required:
        - object
        - tenant_id
        - environment
        - key
      properties:
        object:
          type: string
          enum:
            - me
          description: Object type discriminator.
        tenant_id:
          type: string
          description: Workspace id bound to this API key.
        environment:
          type: string
          enum:
            - live
            - sandbox
          description: Environment selected by the key (`sk_live_…` vs `sk_test_…`).
        key:
          type: object
          description: Non-secret metadata for the authenticating key.
          required:
            - id
            - prefix
            - expires_at
          properties:
            id:
              type: string
              description: Internal key id.
            prefix:
              type: string
              description: Non-secret key prefix shown in the dashboard.
            expires_at:
              type: string
              format: date-time
              description: When this key stops working (UTC).
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
          properties:
            type:
              type: string
              description: Broad error class for client handling.
              enum:
                - invalid_request
                - authentication_error
                - permission_error
                - rate_limit
                - api_error
            code:
              type: string
              description: Stable machine-readable code (e.g. `parameter_invalid`).
            message:
              type: string
              description: Human-readable explanation safe to show developers.
            param:
              type: string
              description: Request field that failed validation, when applicable.
            doc_url:
              type: string
              format: uri
              description: Optional link to docs for this error.
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: authentication_error
              code: invalid_api_key
              message: Invalid API key provided.
    Forbidden:
      description: API disabled for this tenant or globally
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: permission_error
              code: api_disabled
              message: Public API access is disabled for this workspace.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: |
        Secret API key from **Settings → Developers → API keys**.
        Example: `Authorization: Bearer sk_test_…`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.