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

# Read agent memory

> Browse or search the facts, episodes and playbooks agents have saved.



## OpenAPI

````yaml POST /operations/knowledge_read
openapi: 3.1.0
info:
  title: Whirl API
  version: 1.0.0
  description: >-
    Read and change Whirl workspaces, tasks, reminders, agents' instructions and
    approvals as the signed-in user. The same operations are available as tools
    on the MCP server at /mcp.
servers:
  - url: https://api.whirl.sh/api/v1
security:
  - oauth2: []
paths:
  /operations/knowledge_read:
    post:
      tags:
        - agents
      summary: Read agent memory
      description: >-
        Browse saved facts, episodes and playbooks, read an entry by id, or
        search them semantically. Requires organization-wide membership and an
        unrestricted connection. Use the dedicated handbook tools for
        instructions and sources.
      operationId: knowledge_read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                agentId:
                  type: string
                  minLength: 1
                  maxLength: 64
                  description: Agent whose memory to access.
                scope:
                  default: agent
                  type: string
                  enum:
                    - agent
                    - organization
                area:
                  type: string
                  enum:
                    - facts
                    - episodes
                    - playbooks
                id:
                  type: string
                query:
                  type: string
                  maxLength: 1000
                cursor:
                  type: string
              required:
                - agentId
                - area
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  entries:
                    maxItems: 20
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        area:
                          type: string
                          enum:
                            - facts
                            - episodes
                            - playbooks
                        title:
                          type: string
                        body:
                          type: string
                          maxLength: 100000
                        scope:
                          type: string
                        updatedAt:
                          type: number
                        whenToUse:
                          type: string
                        steps:
                          maxItems: 50
                          type: array
                          items:
                            type: string
                        cautions:
                          maxItems: 30
                          type: array
                          items:
                            type: string
                        lessons:
                          maxItems: 30
                          type: array
                          items:
                            type: string
                        outcomeSummary:
                          type: string
                      required:
                        - id
                        - area
                        - title
                        - body
                        - scope
                        - updatedAt
                      additionalProperties: false
                  cursor:
                    type: string
                required:
                  - entries
                additionalProperties: false
        '400':
          $ref: '#/components/responses/Problem'
        '401':
          $ref: '#/components/responses/Problem'
        '403':
          $ref: '#/components/responses/Problem'
        '404':
          $ref: '#/components/responses/Problem'
        '409':
          $ref: '#/components/responses/Problem'
        '422':
          $ref: '#/components/responses/Problem'
        '429':
          $ref: '#/components/responses/Problem'
      security:
        - oauth2:
            - agents:read
components:
  responses:
    Problem:
      description: RFC 9457 problem details
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  schemas:
    Problem:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        code:
          type: string
      required:
        - title
        - status
        - code
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://api.whirl.sh/oauth/authorize
          tokenUrl: https://api.whirl.sh/oauth/token
          refreshUrl: https://api.whirl.sh/oauth/token
          scopes:
            workspace:read: >-
              Workspaces, tasks, People, task context, notes, messages,
              reminders, and pending approvals.
            workspace:write: >-
              Create and update tasks, People, task context, notes, tags,
              reminders, and workspaces.
            agents:read: >-
              Agents, runs, configuration, handbook, memory, tone examples,
              scheduled tasks, and connected-service research.
            agents:write: >-
              Edit agent configuration, handbook, memory, tone examples, and
              schedules, and give agents tasks.
            approvals:write: Approve, reject, or edit actions agents want to take.
            offline_access: >-
              Keep access without asking you to sign in again, until you
              disconnect it.

````

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