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

# Get API key details

> Inspect the calling key's masked value, expiry, monthly spending limit and month-to-date spend. rate_limits is the default text profile; each model's rate_limit can differ.



## OpenAPI

````yaml /openapi.json get /me
openapi: 3.0.3
info:
  title: NoMask API
  version: 1.0.0
  description: >-
    OpenAI-compatible text and image APIs with prepaid USD billing. Use a NoMask
    Bearer key and a current public model ID. Request examples contain
    placeholders; replace them before using Try it.


    The documentation playground sends requests through Mintlify's proxy. curl
    and SDK examples call NoMask directly. Only enter your own key and prompts
    you intend to send. Generation requests can incur charges; GET endpoints
    inspect account metadata without generating content.
  contact:
    name: NoMask Support
    email: support@nomask.ai
    url: https://docs.nomask.ai/support
servers:
  - url: https://api.nomask.ai/v1
    description: NoMask API
security:
  - bearerAuth: []
tags:
  - name: Chat
    description: Chat Completions with optional streaming, tools and multimodal inputs.
  - name: Images
    description: Synchronous image generation and editing.
  - name: Models
    description: Current model IDs, capabilities, limits and pricing.
  - name: Account
    description: Balance, usage and calling-key metadata.
paths:
  /me:
    get:
      tags:
        - Account
      summary: Get API key details
      description: >-
        Inspect the calling key's masked value, expiry, monthly spending limit
        and month-to-date spend. rate_limits is the default text profile; each
        model's rate_limit can differ.
      operationId: getApiKey
      responses:
        '200':
          description: Successful response. Example values are illustrative.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            X-RateLimit-Profile:
              $ref: '#/components/headers/XRateLimitProfile'
            X-RateLimit-Limit-Requests:
              $ref: '#/components/headers/XRateLimitLimitRequests'
            X-RateLimit-Remaining-Requests:
              $ref: '#/components/headers/XRateLimitRemainingRequests'
            X-RateLimit-Reset:
              $ref: '#/components/headers/XRateLimitReset'
            X-RateLimit-Limit-Tokens:
              $ref: '#/components/headers/XRateLimitLimitTokens'
            X-RateLimit-Remaining-Tokens:
              $ref: '#/components/headers/XRateLimitRemainingTokens'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyInfo'
        '401':
          $ref: '#/components/responses/Error401'
        '403':
          $ref: '#/components/responses/Error403'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
        '503':
          $ref: '#/components/responses/Error503'
components:
  headers:
    XRequestId:
      description: Request identifier for support and diagnostics.
      schema:
        type: string
    XRateLimitProfile:
      description: Applied public rate-limit profile.
      schema:
        type: string
    XRateLimitLimitRequests:
      description: Maximum requests in the minute window.
      schema:
        type: string
    XRateLimitRemainingRequests:
      description: Remaining requests in the minute window.
      schema:
        type: string
    XRateLimitReset:
      description: Seconds until the relevant allowance resets.
      schema:
        type: string
    XRateLimitLimitTokens:
      description: Maximum text tokens in the minute window.
      schema:
        type: string
    XRateLimitRemainingTokens:
      description: Remaining text tokens in the minute window.
      schema:
        type: string
    RetryAfter:
      description: Seconds to wait before retrying a rate-limited request, when supplied.
      schema:
        type: integer
  schemas:
    ApiKeyInfo:
      type: object
      properties:
        object:
          type: string
          enum:
            - api_key
        name:
          type: string
        key:
          type: string
          description: Masked key, never the full credential.
        created:
          type: integer
          description: Unix timestamp.
          format: int64
          nullable: true
        expiration_date:
          type: integer
          description: Unix timestamp, or null if no expiry.
          format: int64
          nullable: true
        has_monthly_limit:
          type: boolean
        monthly_usd_limit:
          type: number
          nullable: true
        month_to_date_usd:
          type: number
        rate_limits:
          $ref: '#/components/schemas/TextRateLimit'
        rate_limit_scope:
          type: string
          enum:
            - per_account
      required:
        - object
        - name
        - key
        - created
        - expiration_date
        - has_monthly_limit
        - monthly_usd_limit
        - month_to_date_usd
        - rate_limits
        - rate_limit_scope
    TextRateLimit:
      type: object
      properties:
        name:
          type: string
          description: Public profile name.
        requests_per_minute:
          type: integer
          description: Requests per minute.
        tokens_per_minute:
          type: integer
          description: Tokens per minute.
      required:
        - name
        - requests_per_minute
        - tokens_per_minute
      description: >-
        Current text rate-limit profile. Limits are shared per account, and a
        model may select a different profile.
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
              description: Human-readable error.
            type:
              type: string
              description: Error category.
            code:
              type: string
              description: Machine-readable NoMask error code.
            param:
              type: string
              description: The invalid parameter, if applicable.
              nullable: true
          required:
            - message
            - type
            - code
            - param
      required:
        - error
  responses:
    Error401:
      description: Missing, invalid, expired or revoked API key.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error403:
      description: Account restricted from API access.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error429:
      description: >-
        Account rate limit or key monthly spending limit exceeded. Observe
        Retry-After when supplied.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
        X-RateLimit-Profile:
          $ref: '#/components/headers/XRateLimitProfile'
        X-RateLimit-Limit-Requests:
          $ref: '#/components/headers/XRateLimitLimitRequests'
        X-RateLimit-Remaining-Requests:
          $ref: '#/components/headers/XRateLimitRemainingRequests'
        X-RateLimit-Reset:
          $ref: '#/components/headers/XRateLimitReset'
        X-RateLimit-Limit-Tokens:
          $ref: '#/components/headers/XRateLimitLimitTokens'
        X-RateLimit-Remaining-Tokens:
          $ref: '#/components/headers/XRateLimitRemainingTokens'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error500:
      description: Internal server error.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error503:
      description: Service unavailable or model at capacity.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: NoMask API key
      description: >-
        Create a NoMask API key at https://nomask.ai/api/keys. Keep it private;
        enter only your own key when sending a request.

````

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