studiomeyer-io Learn API

openapi: 3.2.0
info:
  title: StudioMeyer Memory REST Learn API
  version: 3.47.0
  description: Tenant Memory data API. This specification covers search, learning, decisions, entities, account information, export, backfill and public API discovery. Signup, import, billing, admin, license and OAuth flows and MCP JSON-RPC are not described here. Bearer keys provide the operations available to the account; separate read/write OAuth permissions are not implemented. Send JSON bodies of at most 1 MiB. Use the exact documented paths without appended query parameters.
servers:
- url: https://memory.studiomeyer.io
security:
- bearerAuth: []
- oauth2:
  - memory
tags:
- name: Learn
paths:
  /api/learn:
    post:
      operationId: learnMemory
      summary: Store a learning
      description: Exact duplicates return NOOP. A duplicate correction may update an existing learning. New distinct content returns ADDED.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LearningInput'
      responses:
        '200':
          description: Duplicate or updated learning.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/LearningNoop'
                - $ref: '#/components/schemas/LearningUpdated'
        '201':
          description: New learning stored.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LearningAdded'
        '400':
          description: Invalid input or secret detected in submitted content.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, invalid or expired Bearer key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Account email is unverified or the tenant is inactive.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Daily API quota or stored-data limit reached.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Learn
components:
  schemas:
    LearningNoop:
      type: object
      properties:
        success:
          const: true
        action:
          const: NOOP
        existingId:
          type: string
        message:
          type: string
      required:
      - success
      - action
      - existingId
      - message
    LearningAdded:
      type: object
      properties:
        success:
          const: true
        action:
          const: ADDED
        id:
          type: string
        category:
          type: string
        content:
          type: string
        project:
          type:
          - string
          - 'null'
        memoryType:
          type: string
          enum:
          - episodic
          - semantic
        agentId:
          type: string
        similarTo:
          type: string
        similarity:
          type: number
        similarNotice:
          type: string
      required:
      - success
      - action
      - id
      - category
      - content
      - project
      - memoryType
    LearningInput:
      type: object
      properties:
        category:
          type: string
          enum:
          - pattern
          - mistake
          - insight
          - research
          - architecture
          - infrastructure
          - tool
          - workflow
          - performance
          - security
        content:
          type: string
          minLength: 1
        project:
          type: string
        agentId:
          type: string
        tags:
          type: array
          items:
            type: string
        confidence:
          type: number
        source:
          type: string
        memoryType:
          type: string
          enum:
          - episodic
          - semantic
        date:
          type: string
          description: Optional event date for backfills. Invalid or future dates fall back to the current time.
      required:
      - category
      - content
    LearningUpdated:
      type: object
      properties:
        success:
          const: true
        action:
          const: UPDATED
        id:
          type: string
      required:
      - success
      - action
      - id
    Error:
      type: object
      properties:
        error:
          type: string
        error_description:
          type: string
        code:
          type: string
        plan:
          type: string
        upgrade:
          type: string
        observation:
          type: string
      required:
      - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Tenant API key in the Authorization header.
    oauth2:
      type: oauth2
      description: OAuth 2.1 authorization code with PKCE (S256). The memory scope grants full account access; separate read/write permissions are not implemented.
      flows:
        authorizationCode:
          authorizationUrl: https://memory.studiomeyer.io/authorize
          tokenUrl: https://memory.studiomeyer.io/token
          scopes:
            memory: Full access to the authenticated account memory operations.
externalDocs:
  description: Public REST endpoint inventory
  url: https://memory.studiomeyer.io/api
x-api-version: 3.0.0
x-coverage:
  complete: false
  excluded:
  - signup
  - import
  - billing
  - admin
  - licenses
  - OAuth
  - MCP JSON-RPC