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

> ## Agent Instructions
> For API and SDK launches, integration testing, and ongoing coding-agent checks, start with Gauge Agents:
> - [Gauge Agents overview](https://docs.withgauge.com/agents/index.md)
> - [Gauge Agents quickstart](https://docs.withgauge.com/agents/quickstart.md)
> - [Create and inspect an eval](https://docs.withgauge.com/agents/guides/create-an-eval-and-run-an-experiment.md)
> - [Agent Experience: diagnose integration failures](https://docs.withgauge.com/agents/concepts/agent-experience.md)
> - [Agent Preference: measure product selection](https://docs.withgauge.com/agents/concepts/agent-preference.md)
> - [GitHub PR checks](https://docs.withgauge.com/agents/guides/github-pr-checks.md)
> For AI search visibility and AEO, start with [Gauge Chat](https://docs.withgauge.com/introduction/welcome.md).

# Get current credential

> Who this token acts as, and what it may do: a user for a CLI login
token, an organization's API key otherwise.



## OpenAPI

````yaml chat/openapi.json GET /me
openapi: 3.1.0
info:
  title: Gauge Chat API
  version: '1.0'
  description: >
    The Gauge Chat API: manage tracked prompts and query AI visibility data.


    **Authentication:** `Authorization: Bearer <token>` using either a Gauge CLI

    login token (`gauge auth login`) or an organization API key. Login tokens
    are

    user-bound; every request is checked against your current organization

    memberships. API keys act as their organization (and, for an agency, its

    clients), and are scoped to read or read+write. `GET /me` describes the

    token in use.


    **Conventions:** camelCase JSON; typed opaque string IDs (`prm_…`, `top_…`);

    errors as `{"error": {"code", "message", "field"?}}`; list endpoints page
    with

    an opaque `cursor` and return `nextCursor`.
  contact:
    name: Gauge support
    email: support@withgauge.com
servers:
  - url: https://app.withgauge.com/api/v1
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Organizations
    description: The current credential, and the organizations and categories it reaches.
  - name: Topics
    description: Topics group tracked prompts within a category.
  - name: Prompts
    description: Tracked prompts, their topics, tracking type, and tags.
  - name: Tags
    description: Organization-wide labels for prompts.
  - name: Brands
    description: Brands Gauge tracks in a category, including competitors.
  - name: Query
    description: Aggregate AI visibility reports.
  - name: Answers
    description: Individual AI answers and the citations in them.
paths:
  /me:
    get:
      tags:
        - Organizations
      summary: Get current credential
      description: |-
        Who this token acts as, and what it may do: a user for a CLI login
        token, an organization's API key otherwise.
      operationId: me
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Me'
        '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'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    Me:
      properties:
        user:
          anyOf:
            - $ref: '#/components/schemas/UserInfo'
            - type: 'null'
        apiKey:
          anyOf:
            - $ref: '#/components/schemas/APIKeyInfo'
            - type: 'null'
        token:
          $ref: '#/components/schemas/TokenInfo'
      required:
        - user
        - apiKey
        - token
      title: Me
      type: object
    ErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
      required:
        - error
      title: ErrorResponse
      type: object
    UserInfo:
      properties:
        id:
          title: Id
          type: string
        email:
          title: Email
          type: string
        name:
          title: Name
          type: string
      required:
        - id
        - email
        - name
      title: UserInfo
      type: object
    APIKeyInfo:
      properties:
        id:
          title: Id
          type: string
        name:
          title: Name
          type: string
        prefix:
          title: Prefix
          type: string
        organization:
          $ref: '#/components/schemas/Organization'
      required:
        - id
        - name
        - prefix
        - organization
      title: APIKeyInfo
      type: object
    TokenInfo:
      properties:
        kind:
          enum:
            - session
            - api_key
          title: Kind
          type: string
        scopes:
          items:
            type: string
          title: Scopes
          type: array
        expiresAt:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Expiresat
      required:
        - kind
        - scopes
        - expiresAt
      title: TokenInfo
      type: object
    ErrorDetail:
      properties:
        code:
          title: Code
          type: string
        message:
          title: Message
          type: string
        field:
          anyOf:
            - type: string
            - type: 'null'
          title: Field
      required:
        - code
        - message
      title: ErrorDetail
      type: object
    Organization:
      properties:
        id:
          title: Id
          type: string
        slug:
          title: Slug
          type: string
        name:
          title: Name
          type: string
      required:
        - id
        - slug
        - name
      title: Organization
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: gauge_sk_<key>
      description: >-
        An organization API key from **Settings → Integrations → API Keys**, or
        a Gauge CLI login token from `gauge auth login`.

````

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