> ## 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 feature flags

> Lists the feature flags the caller's clients read, each on or off, so a client shows only what the caller has.

Use this tool when you need to:
- Decide what to show the caller when their client starts

Examples:
- GET /user/flags

Hints:
- Takes no parameters. flags maps each flag's key to whether it is on.
- The keys are plain strings so the set can change: a key the client does not recognize is ignored.
- A flag only decides what a client shows: the API checks the same flag on the action itself.
- Any authenticated caller may read their own. Refused with 503 while the flags cannot be answered, rather than reading any flag as off.



## OpenAPI

````yaml api-reference/openapi.json GET /user/flags
openapi: 3.1.0
info:
  title: Aether API
  version: 0.1.0
servers:
  - url: https://api.runaether.dev
security:
  - bearerAuth: []
paths:
  /user/flags:
    get:
      tags:
        - user-flags
      summary: Get your feature flags
      description: >-
        Lists the feature flags the caller's clients read, each on or off, so a
        client shows only what the caller has.


        Use this tool when you need to:

        - Decide what to show the caller when their client starts


        Examples:

        - GET /user/flags


        Hints:

        - Takes no parameters. flags maps each flag's key to whether it is on.

        - The keys are plain strings so the set can change: a key the client
        does not recognize is ignored.

        - A flag only decides what a client shows: the API checks the same flag
        on the action itself.

        - Any authenticated caller may read their own. Refused with 503 while
        the flags cannot be answered, rather than reading any flag as off.
      operationId: getUserFlags
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserFlags'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserFlagsErrorResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserFlagsErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgAuthorizationErrorResponse'
          description: Forbidden
        '410':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserFlagsErrorResponse'
          description: Gone
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserFlagsErrorResponse'
          description: Internal Server Error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserFlagsErrorResponse'
          description: Service Unavailable
components:
  schemas:
    UserFlags:
      additionalProperties: false
      properties:
        flags:
          additionalProperties:
            type: boolean
          description: The caller's feature flags by key, each on or off.
          type: object
      required:
        - flags
      type: object
    UserFlagsErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - bad_gateway
            - bad_request
            - cli_upgrade_required
            - client_outdated
            - conflict
            - forbidden
            - gateway_timeout
            - gone
            - internal_error
            - method_not_allowed
            - not_acceptable
            - not_found
            - not_implemented
            - payment_required
            - precondition_failed
            - rate_limited
            - request_canceled
            - request_timeout
            - request_too_large
            - service_unavailable
            - unauthenticated
            - unsupported_media_type
            - validation_failed
          minLength: 1
          type: string
        error:
          minLength: 1
          type: string
        errors:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
      required:
        - error
        - code
      type: object
    OrgAuthorizationErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - org_membership_required
            - org_role_insufficient
            - org_suspended
            - account_deleting
            - agent_host_route_not_allowed
            - credential_kind_not_admitted
            - grant_scope_insufficient
          type: string
        error:
          minLength: 1
          type: string
      required:
        - error
        - code
      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.