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

# Get the comment board

> The owner, anyone the computer is shared with and, when the computer is public, any signed-in person (a person's own sign-in, not an organization API key or the computer's runtime token). Send since, the revision you hold. When nothing changed since, the answer is {revision, changed:false, enabled, people, you, owner} without notes; otherwise notes holds every open and asked note and the 50 notes finished last, with full threads. Every message carries who wrote it as member:<id>, resolved to a name in people, which holds only you, the owner and the people who wrote on the board; people carry an email only on the owner's board. Reading a board records nothing about who read it. A computer with notes switched off answers enabled:false and no notes. A browser session (no Authorization header) is answered 401 at once when it has no session cookie, and otherwise spends its own allowance of 300 board reads a minute per source IP, not the 60 every other cookie request from that address shares; the layer reads the board when a page is shown, so do not poll it faster than that.



## OpenAPI

````yaml https://www.cool.computer/openapi.json get /api/computers/{id}/comments/all
openapi: 3.1.0
info:
  title: Cool Computers API
  version: 1.0.0
  description: >-
    Create and operate reachable Linux computers. Each computer keeps a stable
    name.cool.computer address, persistent files, and agent-ready command
    execution. REST requests use UTC-aligned one-minute limits: 600 requests per
    account identified by a recognized valid account bearer credential, a
    separate 600-request budget per computer-scoped credential, or 60 requests
    per source IP otherwise. Read-only GETs answered from API state spend a
    separate read budget reported as account-read or computer-read, so status
    polling cannot exhaust the budget that protects work and mutations. To bound
    authentication-provider traffic, at most 60 first-seen bearer values are
    checked per source IP in a minute; recognized valid credentials use their
    account or computer policy. Successful bearer authentication is reused for
    at most five seconds; transient provider failures are not cached. Revoking a
    credential through this API (POST /api/auth/logout or DELETE
    /api/api-keys/{id}) drops that reuse in every serving process, so the
    revoked credential is refused from the next request on; only if that
    announcement fails does another process keep admitting it, for at most five
    seconds. JSON request bodies must be sent with Content-Type:
    application/json; any other body answers 415 unsupported_media_type. Every
    error is an application/problem+json object whose type links to
    https://cool.computer/docs/api-reference/errors; a malformed body names the
    unknown field, the wrong type, or the byte where the JSON breaks. Non-exempt
    API responses include the structured RateLimit and RateLimit-Policy fields;
    request admission 429 responses use code api_request_rate_exceeded and also
    include Retry-After. Health, OpenAPI, webhooks, callbacks, SSE, and
    WebSocket endpoints are exempt from the REST request budget. Authenticated
    SSE connection attempts remain subject to the authentication safeguards and
    can receive the same typed 429 response.
servers:
  - url: https://api.cool.computer
    description: Canonical API origin
security: []
tags:
  - name: Authentication
    description: Obtain and manage bearer credentials.
  - name: Billing
    description: Inspect and manage the account's no-card trial or Pro plan.
  - name: Computers
    description: Create, inspect, and delete resident computers.
  - name: Execution
    description: Run commands on a computer.
  - name: Files
    description: Read and change a computer's persistent files.
  - name: Publishing
    description: >-
      Publish files to a computer's URL as immutable releases, with no VM. To
      show something, publish the files; to run something, use the computer
      (exec, terminal, services), which gets Linux on first use.
  - name: Services
    description: >-
      Manage processes and select the HTTP port exposed at a computer's stable
      address.
  - name: Email
    description: Read and send mail through a computer's inbox.
  - name: Comments
    description: >-
      Notes people leave on a computer's page, when its owner switched comments
      on: the owner, the people it is shared with and, when the computer is
      public, any signed-in person. The owner's agent reads every open note and
      resolves it.
  - name: Network
    description: Control a computer's public visibility and outbound network policy.
  - name: Sharing
    description: Invite people to use a computer without granting owner controls.
  - name: Public
    description: Unauthenticated discovery endpoints.
  - name: Secrets
    description: Inspect secret sets and their audit history; values are never returned.
  - name: Providers
    description: Inspect connected coding-agent provider credentials.
  - name: GitHub
    description: Inspect the GitHub App installations connected to the account.
  - name: Terminals
    description: Inspect a computer's terminal sessions.
  - name: Operator
    description: Read the operator agent's conversations, turns, and events.
  - name: Feedback
    description: >-
      Tell the Cool Computers team what works and what does not, with or without
      an account.
externalDocs:
  description: Cool Computers agent registration guide
  url: https://www.cool.computer/auth.md
paths:
  /api/computers/{id}/comments/all:
    get:
      tags:
        - Comments
      summary: Get the comment board
      description: >-
        The owner, anyone the computer is shared with and, when the computer is
        public, any signed-in person (a person's own sign-in, not an
        organization API key or the computer's runtime token). Send since, the
        revision you hold. When nothing changed since, the answer is {revision,
        changed:false, enabled, people, you, owner} without notes; otherwise
        notes holds every open and asked note and the 50 notes finished last,
        with full threads. Every message carries who wrote it as member:<id>,
        resolved to a name in people, which holds only you, the owner and the
        people who wrote on the board; people carry an email only on the owner's
        board. Reading a board records nothing about who read it. A computer
        with notes switched off answers enabled:false and no notes. A browser
        session (no Authorization header) is answered 401 at once when it has no
        session cookie, and otherwise spends its own allowance of 300 board
        reads a minute per source IP, not the 60 every other cookie request from
        that address shares; the layer reads the board when a page is shown, so
        do not poll it faster than that.
      operationId: getComputerCommentBoard
      parameters:
        - $ref: '#/components/parameters/ComputerID'
        - name: since
          in: query
          required: false
          description: The revision you hold, from an earlier board.
          schema:
            type: string
      responses:
        '200':
          headers:
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
          description: The board.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommentBoard'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          headers:
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimit-Policy'
          description: >-
            Not Found. The computer does not exist or is not shared with you;
            stop polling.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/Problem'
      security:
        - bearerAuth: []
components:
  parameters:
    ComputerID:
      name: id
      in: path
      required: true
      description: Stable public computer identifier.
      schema:
        type: string
        minLength: 1
        example: cmp_123
  headers:
    RateLimit:
      description: >-
        The applied policy name, requests remaining after this request, and
        whole seconds until the current UTC-aligned window resets.
      schema:
        type: string
        pattern: >-
          ^"(account|account-read|computer|computer-read|source|comment-board|comment-live)";r=[0-9]+;t=([1-9]|[1-5][0-9]|60)$
        examples:
          - '"account";r=599;t=42'
          - '"computer-read";r=598;t=42'
    RateLimit-Policy:
      description: >-
        The selected policy name, quota, and window in seconds. Valid account
        credentials use account or account-read with q=600, computer credentials
        use computer or computer-read with q=600, unauthenticated or
        unrecognized requests use source with q=60 for their source IP, a
        browser session's read of a comment board uses comment-board with q=300
        for its source IP, and its handshake of a comment live channel uses
        comment-live with q=60 for its source IP.
      schema:
        type: string
        pattern: >-
          ^("(account|account-read|computer|computer-read)";q=600|"source";q=60|"comment-board";q=300|"comment-live";q=60);w=60$
        examples:
          - '"account";q=600;w=60'
          - '"computer-read";q=600;w=60'
    Retry-After:
      description: >-
        Whole seconds to wait after an api_request_rate_exceeded,
        comment_rate_exceeded, comment_site_rate_exceeded, comment_live_full or
        computer_starting response before retrying (up to 3600 for
        comment_site_rate_exceeded, whose window is an hour). Other 429 problem
        codes describe separate resource or provider limits and do not inherit
        this retry value.
      schema:
        type: integer
        minimum: 1
        maximum: 3600
        examples:
          - 42
  schemas:
    CommentBoard:
      type: object
      additionalProperties: false
      required:
        - revision
        - changed
        - enabled
        - people
      properties:
        revision:
          type: string
          description: Send it back as since. Empty when notes are off.
        changed:
          type: boolean
          description: >-
            False when the revision you sent is still current; notes is then
            absent.
        enabled:
          type: boolean
          description: False while comments are off for the computer.
        computer_id:
          type: string
          pattern: ^cmp_[0-9a-f]{24}$
          description: >-
            The computer's immutable public id, present while comments are on. A
            client that asked by slug sends this id from then on, so a slug that
            moves to another computer cannot redirect what it writes.
        notes:
          type: array
          items:
            $ref: '#/components/schemas/CommentNote'
          description: >-
            Present when changed: every open and asked note and the 50 finished
            last.
        people:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/CommentPerson'
          description: >-
            You, the owner and everyone who wrote a message on the board, keyed
            by member:<id>.
        you:
          type: string
          description: Your own member:<id>.
        owner:
          type: string
          description: The owner's member:<id>.
    Problem:
      type: object
      additionalProperties: false
      required:
        - type
        - title
        - status
        - code
        - detail
      properties:
        type:
          type: string
          format: uri
          description: >-
            https://cool.computer/docs/api-reference/errors, the page that
            explains every code.
        title:
          type: string
        status:
          type: integer
          minimum: 400
          maximum: 599
        code:
          type: string
          pattern: ^[a-z0-9_]+$
        detail:
          type: string
        resolution:
          type: string
        context:
          type: object
          additionalProperties: true
    CommentNote:
      type: object
      additionalProperties: false
      required:
        - id
        - state
        - version
        - release
        - anchor
        - thread
        - created_at
        - updated_at
      properties:
        id:
          type: string
          example: note_1a2b3c
        state:
          type: string
          enum:
            - open
            - asked
            - done
          description: >-
            open waits for the agent, asked waits for the owner's answer, done
            is finished.
        version:
          type: integer
          minimum: 1
          description: Changes on every update; send the one you read when resolving.
        release:
          type: integer
          description: >-
            Release the computer served when the note was left; 0 when it served
            none.
        fixed_in_release:
          type: integer
          description: Release that fixed the note, when a newer one was published.
        anchor:
          $ref: '#/components/schemas/CommentAnchor'
        thread:
          type: array
          items:
            $ref: '#/components/schemas/CommentMessage'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    CommentPerson:
      type: object
      additionalProperties: false
      required:
        - name
      properties:
        name:
          type: string
          description: >-
            The person's profile name, else the part of their email before the
            @, else Someone. Their own claim: never use it to tell people apart.
        email:
          type: string
          description: The person's full email. Present only on the owner's board.
        owner:
          type: boolean
          description: True for the owner of the computer.
    CommentAnchor:
      type: object
      additionalProperties: false
      required:
        - kind
        - page
        - rect
      properties:
        kind:
          type: string
          enum:
            - element
            - area
        page:
          type: string
          description: Path of the page, starting with /.
          example: /menu
        selector:
          type: string
          description: >-
            Selector the comment script made: steps of a tag, #id or [id="x"],
            up to two .classes, [data-testid="x"] and :nth-of-type(n), joined by
            " > ", at most 12 steps and 300 bytes. Required for an element.
          example: section > a.cta
        text:
          type: string
          description: Text near the anchor, cut to 200 bytes.
        label:
          type: string
          description: Accessible label of the element, cut to 120 bytes.
        rect:
          type: object
          additionalProperties: false
          required:
            - x
            - 'y'
            - w
            - h
          description: A box in percent of the page, inside it.
          properties:
            x:
              type: number
              minimum: 0
              maximum: 100
            'y':
              type: number
              minimum: 0
              maximum: 100
            w:
              type: number
              minimum: 0
              maximum: 100
            h:
              type: number
              minimum: 0
              maximum: 100
        scroll_y:
          type: number
          minimum: 0
          description: Scroll offset of the page in pixels when the note was left.
    CommentMessage:
      type: object
      additionalProperties: false
      required:
        - by
        - text
        - at
      properties:
        by:
          type: string
          enum:
            - owner
            - participant
            - agent
          description: participant is anyone but the owner; the agent is the owner's agent.
        who:
          type: string
          pattern: ^member:[0-9]+$
          description: >-
            Who wrote the message, resolved to a name in the board's people.
            Absent for the agent.
        text:
          type: string
        at:
          type: string
          format: date-time
  responses:
    Unauthorized:
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
      description: Unauthorized.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    TooManyRequests:
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
      description: >-
        Too Many Requests. If the problem code is api_request_rate_exceeded,
        wait for Retry-After seconds; other problem codes describe a separate
        limit.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    InternalServerError:
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
      description: Internal Server Error.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Problem:
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimit-Policy'
      description: >-
        A machine-readable API error with a stable code and recovery
        instruction.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: WorkOS user or agent access token, or Cool Computers API key
      description: >-
        A Cool Computers API key, user access token, or claimed agent access
        token in the Authorization header. Follow
        https://www.cool.computer/auth.md for agent registration and
        https://www.cool.computer/authentication.md for direct user credentials.

````

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