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

# Aggregated Agent Floor state (teams, agents, members)

> Single-shot read for the Agent Floor 3D scene: your company's teams (with org-chart positions), non-completed agents (with a derived managerHumanId), and members. Open to any company member — admin and member get the exact same shape. 404 (not 403) both when you have no company and when the Agent Floor gate (AGENT_FLOOR_ENABLED + company.allowAgentFloor) is off, so the route is invisible rather than merely blocked.



## OpenAPI

````yaml /api-reference/openapi.json get /floor/state
openapi: 3.1.0
info:
  title: Atako API
  version: 0.1.0
  description: >-
    The Atako customer API — manage AI agents, their files, integrations,
    billing, and your company/team, programmatically.


    ## Authentication


    Every non-public endpoint takes a Bearer token that is either:

    - a **programmatic API key** (`aik_…`) — create one at
    [app.atako.ai](https://app.atako.ai) → Settings → API keys (company-admin
    only), or

    - a **Supabase session JWT** — what the web app itself sends; not practical
    to obtain outside a browser session.


    ```bash

    curl https://api.atako.ai/agents -H "Authorization: Bearer aik_..."

    ```


    An API key acts as its owning user, with all of that user's permissions —
    there is no separate key scope in this release.


    ## Other Atako HTTP surfaces (not covered by this spec)


    - **Atako MCP server** — `POST /mcp` (auth: same Bearer token as above)
    exposes a read-only Model Context Protocol tool catalogue for AI clients
    (Claude Code, Claude Desktop, Cursor, ChatGPT). See
    [docs.atako.ai/developers/mcp/overview](https://docs.atako.ai/developers/mcp/overview).

    - **Content API** (`cak_…` key, `/content/*`) — a separate, more restricted
    key type for headless CMS-style access to blog/news/use-case content. Not
    documented here.


    ## Errors


    Errors use a JSON envelope: `{ "error": string, "code"?: string }`. `error`
    is either a short human-readable message or a SCREAMING_SNAKE_CASE code,
    depending on the route — treat it as an opaque string to match against, not
    a stable enum across the whole API.


    ## Rate limits


    Authenticated routes: 6000 requests/min per user (`authRateLimit`). Public
    GET routes: 60/min per IP. A handful of sensitive public POST routes
    (newsletter signup, email-exists, invitation preview) are limited to 10
    requests / 15 min per IP.


    ## Pagination


    List endpoints use either simple `limit`/`offset` query params (marketing
    content — a plain JSON array response, capped at the documented max) or
    `page`/`limit` (credit transactions). Neither returns a total count today;
    fetch until a page comes back shorter than `limit`.
servers:
  - url: https://api.atako.ai
    description: Production
security: []
tags:
  - name: Agents
  - name: Messages
  - name: Activity
  - name: Agent Options
  - name: API Keys
  - name: Files
  - name: Cron Jobs
  - name: Sub-Agents
  - name: Interagent Messages
  - name: Integrations
  - name: Subscriptions
  - name: Users
  - name: Company
  - name: Teams
  - name: Floor
  - name: Public
  - name: Marketing Content
paths:
  /floor/state:
    get:
      tags:
        - Floor
      summary: Aggregated Agent Floor state (teams, agents, members)
      description: >-
        Single-shot read for the Agent Floor 3D scene: your company's teams
        (with org-chart positions), non-completed agents (with a derived
        managerHumanId), and members. Open to any company member — admin and
        member get the exact same shape. 404 (not 403) both when you have no
        company and when the Agent Floor gate (AGENT_FLOOR_ENABLED +
        company.allowAgentFloor) is off, so the route is invisible rather than
        merely blocked.
      operationId: getFloorState
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FloorState'
        '401':
          description: Missing, malformed, or invalid bearer token / API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found, or the caller is not authorized to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    FloorState:
      type: object
      description: >-
        GET /floor/state — single-shot aggregated read for the Agent Floor 3D
        scene. Nothing stored anew: teams/positions and members come from
        getTeamsByCompanyId/listCompanyMembers, agents from a floor-specific
        minimal query.
      properties:
        teams:
          type: array
          items:
            $ref: '#/components/schemas/FloorTeam'
        agents:
          type: array
          items:
            $ref: '#/components/schemas/FloorAgent'
        members:
          type: array
          items:
            $ref: '#/components/schemas/FloorMember'
      required:
        - teams
        - agents
        - members
    Error:
      type: object
      description: >-
        Atako's standard error envelope. `error` is either a short
        human-readable message or a SCREAMING_SNAKE_CASE code (routes are
        inconsistent about which — treat it as an opaque string and match on it
        exactly if you need to branch on error type). Some routes add extra
        fields alongside `error` (see the operation's own error responses).
      properties:
        error:
          type: string
        code:
          type: string
          description: >-
            Present on some routes; a stable machine-readable code duplicating
            or refining `error`.
      required:
        - error
      additionalProperties: true
    FloorTeam:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        parentId:
          type: string
          format: uuid
          nullable: true
        companyId:
          type: string
          format: uuid
          nullable: true
      required:
        - id
        - name
        - parentId
        - companyId
    FloorAgent:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        status:
          type: string
          enum:
            - active
            - completed
            - paused
            - provisioning
            - unresponsive
            - failed
        teamId:
          type: string
          format: uuid
          nullable: true
        avatarSeed:
          type: string
          description: agents.image — mascot filename in apps/web/public/aiygents.
        createdAt:
          type: string
          format: date-time
        lastActivityAt:
          type: string
          format: date-time
          nullable: true
          description: agents.lastHeartbeatAt.
        clientId:
          type: string
          format: uuid
          description: Owner — needed client-side to gate the Retry action to the owner.
        managerHumanId:
          type: string
          format: uuid
          nullable: true
          description: >-
            Unique human holder of the parent teamPositions row of this agent's
            own position; null when the agent holds 0 or several positions, its
            position is a root, or its parent is vacant/agent-held.
      required:
        - id
        - name
        - status
        - teamId
        - avatarSeed
        - createdAt
        - lastActivityAt
        - clientId
        - managerHumanId
    FloorMember:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        title:
          type: string
          nullable: true
        teamId:
          type: string
          format: uuid
          nullable: true
        positions:
          type: array
          items:
            $ref: '#/components/schemas/FloorPosition'
          description: >-
            Every position this member holds (a member may hold several, unlike
            an agent).
      required:
        - id
        - name
        - title
        - teamId
        - positions
    FloorPosition:
      type: object
      properties:
        teamId:
          type: string
          format: uuid
        positionId:
          type: string
          format: uuid
        title:
          type: string
      required:
        - teamId
        - positionId
        - title
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An `aik_…` programmatic API key (app.atako.ai → Settings → API keys) or
        a Supabase session JWT.

````