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

# Get your agent

> Your personal agent: its state, settings and models, what it spent this month and its daily spend cap, in your timezone, and the balance that pays for it, your personal organization's Aether inference balance. 404 agent_not_found until you have one.



## OpenAPI

````yaml api-reference/openapi.account.json GET /agent
openapi: 3.1.0
info:
  title: Aether Account & Integrations API
  version: 0.1.0
  description: >-
    Account, billing, and integration-management endpoints used by the Aether
    web app and CLI. Root-mounted; NOT part of the versioned /v1 contract.
servers:
  - url: https://api.runaether.dev
security:
  - bearerAuth: []
paths:
  /agent:
    get:
      tags:
        - agent
      summary: Get your agent
      description: >-
        Your personal agent: its state, settings and models, what it spent this
        month and its daily spend cap, in your timezone, and the balance that
        pays for it, your personal organization's Aether inference balance. 404
        agent_not_found until you have one.
      operationId: getAgent
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentRead'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgAuthorizationErrorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
components:
  schemas:
    AgentRead:
      additionalProperties: false
      properties:
        balance:
          $ref: '#/components/schemas/AgentBalance'
        browser_tools:
          description: >-
            Whether your agent may drive a browser. Off by default; a change
            applies when Hermes next starts, which a running agent does at once.
          type: boolean
        conversation_model:
          description: The model your agent converses on.
          type: string
        created_at:
          format: date-time
          type: string
        cron_model:
          description: >-
            The model your agent's scheduled jobs run on, unless a job names
            another.
          type: string
        daily_cap:
          $ref: '#/components/schemas/AgentDailyCap'
        default_project_id:
          description: >-
            The project a task your agent starts runs on when it names no
            repository. Without it such a task is refused.
          format: uuid
          type: string
        id:
          format: uuid
          type: string
        last_used_at:
          description: >-
            When your agent was created or resumed, was sent a message, or last
            worked. Thirty days unused pauses it.
          format: date-time
          type: string
        state:
          description: >-
            The host's lifecycle state. running: Hermes takes messages now;
            suspending and idle: asleep, woken by the next message; waking,
            resuming: coming up for a message; provisioning and booting: being
            created; updating: moving onto a new image; pausing and paused:
            backed up after thirty days unused, or paused by you, and resumed by
            the next message or by you; lost: its machine is gone and only
            deleting it helps; destroying: being deleted.
          enum:
            - provisioning
            - booting
            - running
            - suspending
            - idle
            - waking
            - updating
            - pausing
            - paused
            - resuming
            - lost
            - destroying
            - destroyed
          type: string
        timezone:
          description: Your IANA timezone, in which the agent's days and months begin.
          type: string
        usage_this_month:
          $ref: '#/components/schemas/AgentUsage'
      required:
        - timezone
        - usage_this_month
        - daily_cap
        - balance
        - id
        - state
        - browser_tools
        - conversation_model
        - cron_model
        - last_used_at
        - created_at
      type: object
    ErrorResponse:
      additionalProperties: false
      properties:
        code:
          type: string
        error:
          minLength: 1
          type: string
        errors:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
      required:
        - error
      type: object
    OrgAuthorizationErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - org_membership_required
            - org_role_insufficient
            - org_suspended
            - account_deleting
          type: string
        error:
          minLength: 1
          type: string
      required:
        - error
        - code
      type: object
    AgentBalance:
      additionalProperties: false
      properties:
        exhausted:
          description: >-
            Whether the balance is used up: your agent's model calls are refused
            until you add funds.
          type: boolean
        microdollars:
          description: >-
            Your personal organization's Aether inference balance, in millionths
            of a US dollar; your agent's model calls are paid from it.
          format: int64
          type: integer
      required:
        - microdollars
        - exhausted
      type: object
    AgentDailyCap:
      additionalProperties: false
      properties:
        daily_cap_cents:
          description: >-
            The most the agent may spend on inference in a day, over every model
            call it makes, in US cents. A model call is refused (402
            agent_host_daily_cap_reached) once the day's settled spend plus what
            the agent's calls in flight hold reaches it, until midnight in the
            timezone, until calls in flight settle under it, or until the cap is
            raised past them.
          format: int32
          type: integer
        day:
          description: >-
            Today in the agent's timezone, as YYYY-MM-DD: the day
            spent_microdollars is for.
          pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
          type: string
        spent_microdollars:
          description: >-
            What the agent's model calls settled today, in millionths of a US
            dollar.
          format: int64
          type: integer
        timezone:
          description: The owner's IANA timezone, whose midnight starts the next day.
          type: string
      required:
        - daily_cap_cents
        - day
        - timezone
        - spent_microdollars
      type: object
    AgentUsage:
      additionalProperties: false
      properties:
        month:
          description: This month in your timezone, as YYYY-MM.
          pattern: ^[0-9]{4}-[0-9]{2}$
          type: string
        spent_microdollars:
          description: >-
            What your agent's model calls settled this month, in millionths of a
            US dollar, from your balance.
          format: int64
          type: integer
      required:
        - month
        - spent_microdollars
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http

````

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