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

# Retrieve your account

> The account behind the presented API key. This is an explicit
whitelist projection — it never includes your email address
(register and manage that from the dashboard).




## OpenAPI

````yaml /openapi.yaml get /v1/me
openapi: 3.1.0
info:
  title: Square1 API
  version: 1.0.0
  description: |
    OpenAI-compatible LLM gateway API.

    All endpoints live on `https://inference.square1.dev` and require a
    Square1 API key (`sq-arca-...`, or a legacy `ws-...` key) sent as a
    Bearer token.

    The wire format follows the OpenAI Chat Completions / Embeddings /
    Models conventions, with a small set of documented vendor extensions:
    the `reasoning_effort` request field, the `reasoning` delta/message
    field, and the `wellspring` quota-receipt block on chat responses.
servers:
  - url: https://inference.square1.dev
security:
  - bearerAuth: []
tags:
  - name: Chat
    description: OpenAI-compatible chat completions.
  - name: Embeddings
    description: OpenAI-compatible embeddings.
  - name: Models
    description: The model catalog as visible to your key.
  - name: Account
    description: Read-only introspection for the authenticated key.
  - name: Illustration
    description: NovelAI-compatible synchronous image generation.
paths:
  /v1/me:
    get:
      tags:
        - Account
      summary: Retrieve your account
      description: |
        The account behind the presented API key. This is an explicit
        whitelist projection — it never includes your email address
        (register and manage that from the dashboard).
      operationId: retrieveAccount
      responses:
        '200':
          description: Account info.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    Account:
      type: object
      required:
        - object
        - id
        - display_id
        - display_name
        - username
        - is_legacy
        - is_admin
        - key_label
        - created_at
        - last_rotated_at
        - email_registered
      properties:
        object:
          const: account
        id:
          type: string
          description: Community account identifier.
        display_id:
          type:
            - integer
            - 'null'
        display_name:
          type:
            - string
            - 'null'
        username:
          type:
            - string
            - 'null'
        is_legacy:
          type: boolean
        is_admin:
          type: boolean
        key_label:
          type:
            - string
            - 'null'
          description: The label of the key used for this request.
        created_at:
          type: integer
          description: Epoch milliseconds.
        last_rotated_at:
          type:
            - integer
            - 'null'
          description: Epoch milliseconds of the last key rotation.
        email_registered:
          type: boolean
          description: >
            Whether a verified email is on file (the address itself is never
            returned here).
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - type
          properties:
            message:
              type: string
              description: |
                Human-readable description. User-facing messages are in Korean.
            type:
              type: string
              description: >
                Error family, e.g. `invalid_request_error`, `rate_limit_error`,
                `quota_exceeded`, `access_denied`, `overloaded_error`,
                `server_error`, `service_unavailable`.
            code:
              type: string
              description: Machine-readable code (see the Errors guide).
            resets_at:
              type: string
              format: date-time
              description: >
                Present on `session_exhausted`, `weekly_exhausted`, and
                `abuse_cooldown` so clients can render a countdown.
  responses:
    Unauthorized:
      description: '`invalid_api_key` — missing, malformed, or revoked key.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: >
        Access denied. Codes include `geo_restricted` (service is
        region-locked), `account_unlinked` (community re-verification required —
        visit the dashboard), `legacy_account_upgrade_required` (finish the
        account upgrade in the dashboard), `guest_expired`, and `email_required`
        (when email enforcement is enabled).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        A Square1 API key: `Authorization: Bearer sq-arca-...` (legacy `ws-...`
        keys remain valid). Create and rotate keys from the dashboard.

````