openapi: 3.2.0
info:
  title: AutoGPT Agent Server Memory API
  summary: AutoGPT Agent Server
  description: This server is used to execute agents that are created by the AutoGPT system.
  version: '0.1'
tags:
- name: Memory
paths:
  /api/memory:
    delete:
      tags:
      - Memory
      summary: Erase My Memory
      description: Permanently erase the caller's entire account memory.
      operationId: erase_my_memory
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EraseMemoryResponse'
        '401':
          $ref: '#/components/responses/HTTP401NotAuthenticatedError'
      security:
      - HTTPBearerJWT: []
  /api/memory/experts/{expert_id}:
    delete:
      tags:
      - Memory
      summary: Erase My Expert Memory
      description: Permanently erase one expert's entire isolated memory.
      operationId: erase_my_expert_memory
      security:
      - HTTPBearerJWT: []
      parameters:
      - name: expert_id
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 128
          description: Expert id owned by the caller
          title: Expert Id
        description: Expert id owned by the caller
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EraseMemoryResponse'
        '401':
          $ref: '#/components/responses/HTTP401NotAuthenticatedError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/memory/experts/{expert_id}/facts:
    get:
      tags:
      - Memory
      summary: List My Expert Memory Facts
      description: Live facts in one expert's isolated memory, newest first.
      operationId: list_my_expert_memory_facts
      security:
      - HTTPBearerJWT: []
      parameters:
      - name: expert_id
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 128
          description: Expert id owned by the caller
          title: Expert Id
        description: Expert id owned by the caller
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          default: 50
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemoryFactListResponse'
        '401':
          $ref: '#/components/responses/HTTP401NotAuthenticatedError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/memory/experts/{expert_id}/facts/{fact_uuid}:
    delete:
      tags:
      - Memory
      summary: Forget My Expert Memory Fact
      description: Forget one fact from an expert's isolated memory.
      operationId: forget_my_expert_memory_fact
      security:
      - HTTPBearerJWT: []
      parameters:
      - name: expert_id
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 128
          description: Expert id owned by the caller
          title: Expert Id
        description: Expert id owned by the caller
      - name: fact_uuid
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 128
          description: Fact edge uuid
          title: Fact Uuid
        description: Fact edge uuid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForgetFactResponse'
        '401':
          $ref: '#/components/responses/HTTP401NotAuthenticatedError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/memory/experts/{expert_id}/overview:
    get:
      tags:
      - Memory
      summary: Get My Expert Memory Overview
      description: Counts for one of the caller's experts' isolated memory.
      operationId: get_my_expert_memory_overview
      security:
      - HTTPBearerJWT: []
      parameters:
      - name: expert_id
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 128
          description: Expert id owned by the caller
          title: Expert Id
        description: Expert id owned by the caller
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemoryScopeOverview'
        '401':
          $ref: '#/components/responses/HTTP401NotAuthenticatedError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/memory/facts:
    get:
      tags:
      - Memory
      summary: List My Memory Facts
      description: Live facts in the caller's account memory, newest first.
      operationId: list_my_memory_facts
      security:
      - HTTPBearerJWT: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          default: 50
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemoryFactListResponse'
        '401':
          $ref: '#/components/responses/HTTP401NotAuthenticatedError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/memory/facts/{fact_uuid}:
    delete:
      tags:
      - Memory
      summary: Forget My Memory Fact
      description: Forget one fact from the caller's account memory.
      operationId: forget_my_memory_fact
      security:
      - HTTPBearerJWT: []
      parameters:
      - name: fact_uuid
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 128
          description: Fact edge uuid
          title: Fact Uuid
        description: Fact edge uuid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForgetFactResponse'
        '401':
          $ref: '#/components/responses/HTTP401NotAuthenticatedError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/memory/overview:
    get:
      tags:
      - Memory
      summary: Get My Memory Overview
      description: Counts for the caller's account (AutoPilot) memory.
      operationId: get_my_memory_overview
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemoryScopeOverview'
        '401':
          $ref: '#/components/responses/HTTP401NotAuthenticatedError'
      security:
      - HTTPBearerJWT: []
components:
  responses:
    HTTP401NotAuthenticatedError:
      description: Authentication required
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: string
  schemas:
    EraseMemoryResponse:
      properties:
        expert_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Expert Id
        deleted_nodes:
          type: integer
          title: Deleted Nodes
        erased:
          type: boolean
          title: Erased
      type: object
      required:
      - deleted_nodes
      - erased
      title: EraseMemoryResponse
      description: 'Result of a scope wipe. ``deleted_nodes`` counts every node removed —

        entities, episodes (raw text included), and communities.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    MemoryFact:
      properties:
        uuid:
          type: string
          title: Uuid
        fact:
          anyOf:
          - type: string
          - type: 'null'
          title: Fact
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        source:
          type: string
          title: Source
        target:
          type: string
          title: Target
        created_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At
      type: object
      required:
      - uuid
      - source
      - target
      title: MemoryFact
      description: One live fact edge, as shown in the recent-memories list.
    MemoryScopeOverview:
      properties:
        expert_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Expert Id
        facts:
          type: integer
          title: Facts
        entities:
          type: integer
          title: Entities
        episodes:
          type: integer
          title: Episodes
      type: object
      required:
      - facts
      - entities
      - episodes
      title: MemoryScopeOverview
      description: 'Counts for one memory scope, shown on the settings page and in the

        erase-confirmation dialog.'
    MemoryFactListResponse:
      properties:
        expert_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Expert Id
        items:
          items:
            $ref: '#/components/schemas/MemoryFact'
          type: array
          title: Items
      type: object
      required:
      - items
      title: MemoryFactListResponse
    ForgetFactResponse:
      properties:
        uuid:
          type: string
          title: Uuid
        forgotten:
          type: boolean
          title: Forgotten
      type: object
      required:
      - uuid
      - forgotten
      title: ForgetFactResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    APIKeyAuthenticator-X-Postmark-Webhook-Token:
      type: apiKey
      in: header
      name: X-Postmark-Webhook-Token
    HTTPBearer:
      type: http
      scheme: bearer
    HTTPBearerJWT:
      type: http
      scheme: bearer
      bearerFormat: jwt