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

# Check your account status: subscription tier plus monthly operations used and remaining.

> Check your SuperDocs account status: tier, monthly operations used/remaining, and (for agent accounts) whether a human has adopted it.

Call this with your `sk_` key. Useful before doing work (to confirm you have
operations left) and before signing up again (to reuse your account).

Nearing your monthly cap and need to keep going? Hand the account to a human:
POST /v1/agents/handoff with their email returns a one-time takeover code to
give them; they open the emailed link, enter the code, and adopt the account
in place (your work and this API key keep working) so they can upgrade and
pay. No human? POST /v1/agents/request-upgrade instead. Full flow:
https://docs.superdocs.app/introduction/agent-signup



## OpenAPI

````yaml /openapi.json get /v1/agents/whoami
openapi: 3.1.0
info:
  title: Universal Document AI API
  description: AI-powered document editing with multi-tenant organization support
  version: 2.0.0
servers:
  - url: https://api.superdocs.app
security: []
paths:
  /v1/agents/whoami:
    get:
      tags:
        - agents
        - mcp
      summary: >-
        Check your account status: subscription tier plus monthly operations
        used and remaining.
      description: >-
        Check your SuperDocs account status: tier, monthly operations
        used/remaining, and (for agent accounts) whether a human has adopted it.


        Call this with your `sk_` key. Useful before doing work (to confirm you
        have

        operations left) and before signing up again (to reuse your account).


        Nearing your monthly cap and need to keep going? Hand the account to a
        human:

        POST /v1/agents/handoff with their email returns a one-time takeover
        code to

        give them; they open the emailed link, enter the code, and adopt the
        account

        in place (your work and this API key keep working) so they can upgrade
        and

        pay. No human? POST /v1/agents/request-upgrade instead. Full flow:

        https://docs.superdocs.app/introduction/agent-signup
      operationId: get_account_status
      parameters:
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentWhoamiResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    AgentWhoamiResponse:
      properties:
        account_id:
          type: string
          title: Account Id
        tier:
          type: string
          title: Tier
        quota:
          $ref: '#/components/schemas/AgentQuota'
        is_agent_account:
          type: boolean
          title: Is Agent Account
        adopted:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Adopted
          description: >-
            For agent accounts: whether a human has adopted it yet. Null for
            regular accounts.
        hint:
          anyOf:
            - type: string
            - type: 'null'
          title: Hint
      type: object
      required:
        - account_id
        - tier
        - quota
        - is_agent_account
      title: AgentWhoamiResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AgentQuota:
      properties:
        tier:
          type: string
          title: Tier
        monthly_limit:
          type: integer
          title: Monthly Limit
        used:
          type: integer
          title: Used
        remaining:
          type: integer
          title: Remaining
        resets_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Resets At
      type: object
      required:
        - tier
        - monthly_limit
        - used
        - remaining
      title: AgentQuota
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

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