Grepr Agent Memory API

openapi: 3.2.0
info:
  title: Grepr Agent Memory API
  version: 1.0.0
  description: 'Operations tagged Agent Memory across 2 of this provider''s published API definitions: grepr-openapi.json, grepr.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Agent Memory
paths:
  /v1/agent-memory:
    get:
      operationId: list_5
      parameters:
      - in: query
        name: tag
        schema:
          items:
            type: string
          type: array
      - in: query
        name: agentId
        schema:
          type: string
      - in: query
        name: significance
        schema:
          items:
            enum:
            - INCIDENT
            - OBSERVATION
            - INCONCLUSIVE
            - BENIGN
            type: string
          type: array
      - in: query
        name: verdict
        schema:
          enum:
          - WRONG
          - NONE
          type: string
      - in: query
        name: q
        schema:
          type: string
      - in: query
        name: pageSize
        schema:
          default: 25
          format: int32
          maximum: 100
          minimum: 1
          type: integer
      - in: query
        name: after
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemoryListResponse'
          description: One page of memories
      summary: List this organization's investigation memories, most recently seen first…
      tags:
      - Agent Memory
  /v1/agent-memory/search:
    post:
      operationId: search
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemorySearchRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemorySearchResponse'
          description: Search results
      summary: Search past investigation memories for the closest CANDIDATES — for the agent…
      tags:
      - Agent Memory
  /v1/agent-memory/tags:
    get:
      operationId: tags
      parameters:
      - in: query
        name: agentId
        schema:
          type: string
      - in: query
        name: key
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemoryTagCounts'
          description: The counts
      summary: Count the tag keys in use in this organization's memories, or one key's values…
      tags:
      - Agent Memory
  /v1/agent-memory/{investigationId}/link/{memoryId}:
    post:
      operationId: link
      parameters:
      - in: path
        name: investigationId
        required: true
        schema:
          type: string
      - in: path
        name: memoryId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkMemoryRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkMemoryResponse'
          description: The link was applied
      summary: Record that this investigation is another occurrence of a memory you already…
      tags:
      - Agent Memory
  /v1/agent-memory/{investigationId}/record:
    post:
      operationId: record
      parameters:
      - in: path
        name: investigationId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecordMemoryRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordMemoryResponse'
          description: The recorded memory's id and a nearest-neighbour hint
      summary: Record what this investigation concluded.
      tags:
      - Agent Memory
  /v1/agent-memory/{memoryId}:
    delete:
      operationId: delete_3
      parameters:
      - in: path
        name: memoryId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Deleted
      summary: Delete a memory and the recurrence links pointing at it.
      tags:
      - Agent Memory
    get:
      operationId: get_5
      parameters:
      - in: path
        name: memoryId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemoryDetail'
          description: The memory and its recurrences
      summary: Read one memory in full by its id (its investigation id), with the…
      tags:
      - Agent Memory
    put:
      operationId: edit
      parameters:
      - in: path
        name: memoryId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HumanMemoryEdit'
        required: true
      responses:
        '204':
          description: Edited
      summary: Edit a memory as a person.
      tags:
      - Agent Memory
  /v1/agent-memory/{memoryId}/verdict:
    delete:
      operationId: clearVerdict
      parameters:
      - in: path
        name: memoryId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Verdict lifted
      summary: Lift a person's verdict that a memory is wrong
      tags:
      - Agent Memory
    put:
      operationId: setVerdict
      parameters:
      - in: path
        name: memoryId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemoryVerdictRequest'
        required: true
      responses:
        '204':
          description: Marked wrong
      summary: Mark a memory's conclusion wrong.
      tags:
      - Agent Memory
components:
  schemas:
    MemorySearchResult:
      properties:
        ageDays:
          format: int64
          type: integer
        agentId:
          type: string
        investigationId:
          type: string
        lastSeenAt:
          format: date-time
          type: string
        lastSeenDays:
          format: int64
          type: integer
        matchedOn:
          enum:
          - SEMANTIC
          - TEXT
          - TIMELINE
          - LOOKUP
          type: string
        recencyLabel:
          enum:
          - ACTIVE
          - RECENT
          - HISTORICAL
          type: string
        recordedAt:
          format: date-time
          type: string
        recurrenceCount:
          format: int32
          type: integer
        resolution:
          type: string
        review:
          $ref: '#/components/schemas/MemoryReview'
        rootCause:
          type: string
        rootCauseConfidence:
          enum:
          - CONFIRMED
          - SUSPECTED
          - UNKNOWN
          type: string
        ruledOut:
          type: string
        score:
          format: double
          type: number
        significance:
          enum:
          - INCIDENT
          - OBSERVATION
          - INCONCLUSIVE
          - BENIGN
          type: string
        symptoms:
          type: string
        tags:
          additionalProperties:
            type: string
          type: object
        title:
          type: string
      type: object
    MemoryDetail:
      properties:
        contentRevision:
          format: int32
          type: integer
        linkCount:
          format: int64
          type: integer
        lockedTagKeys:
          items:
            type: string
          type: array
        memory:
          $ref: '#/components/schemas/MemorySearchResult'
        recurrences:
          items:
            $ref: '#/components/schemas/RecurrenceLink'
          type: array
      type: object
    MemorySearchResponse:
      properties:
        entityTagVocabulary:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
        hasMore:
          type: boolean
        note:
          type: string
        preamble:
          type: string
        results:
          items:
            $ref: '#/components/schemas/MemorySearchResult'
          type: array
        semanticSearchUnavailable:
          type: boolean
        verbosity:
          enum:
          - COMPACT
          - FULL
          type: string
      type: object
    MemorySearchRequest:
      properties:
        agentId:
          type: string
        entityTags:
          additionalProperties:
            type: string
          default: {}
          type: object
        includeVocabulary:
          default: false
          type: boolean
        limit:
          default: 3
          format: int32
          maximum: 50
          minimum: 1
          type: integer
        mode:
          description: 'The retrieval strategy. Leave it out for the server to pick: SEMANTIC when the agent searched has a semantic-search store and TEXT when it has none.'
          enum:
          - SEMANTIC
          - TEXT
          - TIMELINE
          type: string
        query:
          type: string
        recordedAfter:
          format: date-time
          type: string
        significances:
          default: []
          items:
            enum:
            - INCIDENT
            - OBSERVATION
            - INCONCLUSIVE
            - BENIGN
            type: string
          type: array
          uniqueItems: true
        verbosity:
          enum:
          - COMPACT
          - FULL
          type: string
      required:
      - significances
      type: object
    HumanMemoryEdit:
      properties:
        entityTags:
          additionalProperties:
            type: string
          type: object
        expectedRevision:
          format: int32
          type: integer
        resolution:
          type: string
        rootCause:
          type: string
        rootCauseConfidence:
          enum:
          - CONFIRMED
          - SUSPECTED
          - UNKNOWN
          type: string
        ruledOut:
          type: string
        significance:
          enum:
          - INCIDENT
          - OBSERVATION
          - INCONCLUSIVE
          - BENIGN
          type: string
        symptoms:
          type: string
        title:
          type: string
      required:
      - entityTags
      - expectedRevision
      - significance
      - title
      type: object
    MemoryListResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/MemorySearchResult'
          type: array
        nextCursor:
          type: string
      type: object
    RecurrenceLink:
      properties:
        investigationId:
          type: string
        linkedAt:
          format: date-time
          type: string
      type: object
    MemoryTagCounts:
      properties:
        items:
          items:
            $ref: '#/components/schemas/TagCountItem'
          type: array
      type: object
    MemoryVerdictRequest:
      properties:
        note:
          maxLength: 2000
          minLength: 0
          type: string
      required:
      - note
      type: object
    RecordMemoryRequest:
      properties:
        clear:
          items:
            description: A previously recorded field to retract, leaving it empty.
            enum:
            - SYMPTOMS
            - ROOT_CAUSE
            - RULED_OUT
            - RESOLUTION
            - ENTITY_TAGS
            type: string
          type: array
          uniqueItems: true
        entityTags:
          additionalProperties:
            type: string
          type: object
        resolution:
          type: string
        rootCause:
          type: string
        rootCauseConfidence:
          enum:
          - CONFIRMED
          - SUSPECTED
          - UNKNOWN
          type: string
        ruledOut:
          type: string
        searchableBySimilarity:
          type: boolean
        significance:
          enum:
          - INCIDENT
          - OBSERVATION
          - INCONCLUSIVE
          - BENIGN
          type: string
        symptoms:
          type: string
        title:
          type: string
      required:
      - significance
      - title
      type: object
    LinkMemoryResponse:
      properties:
        textMerged:
          type: boolean
      type: object
    MemoryReview:
      properties:
        editedAt:
          format: date-time
          type: string
        verdictAt:
          format: date-time
          type: string
        verdictNote:
          type: string
      type: object
    RecordMemoryResponse:
      properties:
        alreadyRecorded:
          type: boolean
        memoryId:
          type: string
        nearestMemoryId:
          type: string
        nearestSimilarity:
          format: double
          type: number
        review:
          $ref: '#/components/schemas/MemoryReview'
      type: object
    LinkMemoryRequest:
      properties:
        resolution:
          type: string
        rootCause:
          type: string
        rootCauseConfidence:
          enum:
          - CONFIRMED
          - SUSPECTED
          - UNKNOWN
          type: string
        ruledOut:
          type: string
        symptoms:
          type: string
      type: object
    TagCountItem:
      properties:
        count:
          format: int64
          type: integer
        name:
          type: string
      type: object
  securitySchemes:
    grepr-api-key:
      in: header
      name: GREPR-API-KEY
      type: apiKey
    grepr-oidc:
      bearerFormat: JWT
      openIdConnectUrl: https://grepr-prod.us.auth0.com/.well-known/openid-configuration
      type: openIdConnect
x-refined-from:
- grepr-openapi.json
- grepr.json
x-tagGroups:
- name: Integrations
  tags:
  - Grepr-hosted Data Warehouse Integration
  - External S3 Data Warehouse Integration
  - Datadog Integration
  - New Relic Integration
  - Splunk Integration
  - Sumo Logic Integration
  - OpenTelemetry Integration
- name: Pipelines
  tags:
  - Jobs
  - Templates
  - Datasets
  - Status Metrics
  - External Triggers
  - Job Actions
  - Triggers
- name: Pipeline Components
  tags:
  - Operations
  - Transforms
  - Sources
  - Sinks
- name: Administration
  tags:
  - Users
  - Teams
  - Roles
  - Permission
  - Invitations
  - Activity Logs
- name: Organization
  tags:
  - Organizations
  - Access Configuration
  - Grepr API Key
  - Service Accounts
  - Signup
- name: Query & Analysis
  tags:
  - Job Anomalies
  - Grok Parsing
  - Query Parsing
  - Validation
- name: System
  tags:
  - Manifest