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

# Get current user profile and balances

> Returns the authenticated user's profile and balances (credits_balance = runs remaining,
domains_balance = distinct primary domains allowed). Used for header display and gating the New Job flow.
Requires authentication (session or API key).




## OpenAPI

````yaml openapi.json get /api/v1/users/me
openapi: 3.1.0
info:
  title: SuprKeywords API
  version: 0.1.0
  description: >-
    API for keyword research jobs: create jobs, list results, fetch personas,
    keywords, clusters, and export CSV. Programmatic access is authenticated
    with API keys (Authorization: Bearer <key>). The dashboard uses session
    cookies when using the web app in a browser.
  contact:
    name: SuprKeywords Support
    url: https://www.suprkeywords.com
    email: support@suprkeywords.com
servers:
  - url: https://www.suprkeywords.com
    description: Production
  - url: http://localhost:4605
    description: Local (for testing against a local API)
security:
  - bearerAuth: []
  - SessionAuth: []
tags: []
paths:
  /api/v1/users/me:
    get:
      tags:
        - Users
      summary: Get current user profile and balances
      description: >
        Returns the authenticated user's profile and balances (credits_balance =
        runs remaining,

        domains_balance = distinct primary domains allowed). Used for header
        display and gating the New Job flow.

        Requires authentication (session or API key).
      responses:
        '200':
          description: Current user and balances
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  email:
                    type: string
                    format: email
                  credits_balance:
                    type: integer
                    description: Runs remaining
                  domains_balance:
                    type: integer
                    description: Max distinct primary domains allowed
                  can_create_api_keys:
                    type: boolean
                    description: Whether user can create API keys (Agency plan)
        '401':
          description: Unauthorized
        '404':
          description: User not found in database
        '500':
          description: Internal server error
      security:
        - bearerAuth: []
        - SessionAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        API key for programmatic access. Create keys in Settings (Agency plan).
        Send as Authorization: Bearer <your-api-key> or X-API-KEY:
        <your-api-key>. Unauthenticated requests return 401.
    SessionAuth:
      type: apiKey
      in: cookie
      name: __session
      description: >-
        Session cookie when using the dashboard in a browser. For scripts and
        server-to-server calls, use BearerAuth (API key) instead. Demo job
        access is allowed for GET job and sub-resources when applicable.

````