AIStoryHub Memory API

openapi: 3.2.0
info:
  title: AIStoryHub Memory API
  version: 1.0.0
  description: A REST API for reading and creating stories and chapters on AIStoryHub outside the app. Authenticate with a scoped bearer token created under Settings, Developer API. Scopes are explicit, so write access does not imply read access.
  contact:
    url: https://aistoryhub.co/developers
  termsOfService: https://aistoryhub.co/terms
servers:
- url: https://aistoryhub.co/api/v1
security:
- bearerAuth: []
tags:
- name: Memory
  description: Durable memories (preference/feedback/context/reference) that persist across sessions.
paths:
  /memory:
    get:
      operationId: listMemories
      tags:
      - Memory
      summary: List durable memories
      description: Account-scoped memories, plus a story's own if story_id is given.
      x-required-scope: memory:read
      parameters:
      - name: story_id
        in: query
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Saved memories.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Memory'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
    post:
      operationId: saveMemory
      tags:
      - Memory
      summary: Save or update a memory by name
      description: Reusing an existing name overwrites it instead of creating a duplicate.
      x-required-scope: memory:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - type
              - name
              - description
              - content
              properties:
                type:
                  type: string
                  enum:
                  - preference
                  - feedback
                  - context
                  - reference
                name:
                  type: string
                  description: Short slug identifying this memory. Reusing an existing name overwrites it.
                description:
                  type: string
                  description: One-line summary shown in every future briefing.
                content:
                  type: string
                scope:
                  type: string
                  enum:
                  - story
                  - account
                  default: story
                story_id:
                  type: string
                  format: uuid
                  description: Required when scope is "story".
      responses:
        '200':
          description: The saved memory.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Memory'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
  /memory/{name}:
    delete:
      operationId: forgetMemory
      tags:
      - Memory
      summary: Delete a memory by name
      x-required-scope: memory:write
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - name: story_id
        in: query
        schema:
          type: string
          format: uuid
        description: Required when the memory was saved with scope "story".
      responses:
        '200':
          description: Deleted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    Memory:
      type: object
      properties:
        name:
          type: string
        type:
          type: string
          enum:
          - preference
          - feedback
          - context
          - reference
        description:
          type: string
        content:
          type: string
        scope:
          type: string
          enum:
          - story
          - account
        story_id:
          type:
          - string
          - 'null'
          format: uuid
        updated_at:
          type:
          - string
          - 'null'
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
              - unauthorized
              - forbidden
              - invalid_request
              - not_found
              - rate_limited
              - internal_error
            message:
              type: string
  responses:
    InvalidRequest:
      description: The request body or parameters are invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: The token lacks the scope this endpoint requires.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing, malformed, invalid, revoked, or expired token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Too many requests. Retry after the delay in the `Retry-After` header.
      headers:
        Retry-After:
          schema:
            type: integer
          description: Seconds to wait before retrying.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The resource does not exist or you do not own it.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: ash_...
      description: 'Create a token under Settings, Developer API and send it as `Authorization: Bearer ash_...`. Each endpoint requires one scope, listed per-operation via the `x-required-scope` extension; see https://aistoryhub.co/developers for the full scope list.'