Kagura AI Resource Indexer API

openapi: 3.2.0
info:
  title: Kagura Memory Cloud Resource Indexer API
  description: Universal AI Memory Platform - Remote MCP Server + Web Management
  version: 0.158.1
tags:
- name: resource-indexer
  description: Resource indexer runtime state
paths:
  /api/v1/resources/{resource_id}/indexer-status:
    get:
      tags:
      - resource-indexer
      summary: Get Indexer Status
      description: 'Return indexer state and recent ingest events for a resource.


        The ``resource_id`` URL path parameter accepts the human-readable slug

        (e.g. ``my-github-repo``), not an internal UUID. The slug is resolved to

        the caller''s workspace-scoped resource via

        ``PermissionService.resolve_resource_by_slug``. This backward-compatible

        contract is maintained so existing integrations continue to work without

        modification after the v0.12.0 UUID FK migration.


        Owner-only (#389): ``WorkspaceOwner`` rejects non-owners with 403

        (``resource_token`` write-scoped credentials are rejected by the same

        dependency — pinned by isolation tests); ``resolve_resource_by_slug``

        returns 404 (CWE-639 / OWASP A01) on cross-workspace probes so

        existence does not leak.'
      operationId: get_indexer_status_api_v1_resources__resource_id__indexer_status_get
      parameters:
      - name: resource_id
        in: path
        required: true
        schema:
          type: string
          title: Resource Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexerStatusResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
    IndexerState:
      properties:
        job_status:
          type: string
          enum:
          - idle
          - queued
          - running
          - failed
          title: Job Status
        last_run_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Run At
          description: ISO-8601 UTC timestamp of the most recent run
        next_run_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Run At
          description: ISO-8601 UTC timestamp of the next scheduled run
        active_version:
          type: integer
          title: Active Version
          description: Active Qdrant collection version (blue/green); used for rollout coordination.
        last_offset:
          type: integer
          title: Last Offset
          description: Highest resource_events.id processed so far. Monotonically increasing; compare against ResourceEvent.id to estimate lag.
        lag_seconds:
          anyOf:
          - type: number
          - type: 'null'
          title: Lag Seconds
          description: Server-computed (now - last_run_at). ``None`` when the indexer has never run. The UI uses this for health thresholds only — display a human relative time from ``last_run_at`` directly to avoid value drift while the tab is open.
        metrics:
          $ref: '#/components/schemas/IndexerStateMetrics'
      type: object
      required:
      - job_status
      - active_version
      - last_offset
      - metrics
      title: IndexerState
      description: Indexer state snapshot for one resource/context.
    IndexerStateMetrics:
      properties:
        applied_upserts:
          type: integer
          title: Applied Upserts
          description: Upsert events applied in the last run
          default: 0
        applied_deletes:
          type: integer
          title: Applied Deletes
          description: Delete events applied in the last run
          default: 0
        errors:
          type: integer
          title: Errors
          description: Errors observed in the last run
          default: 0
        failed_events:
          type: integer
          title: Failed Events
          description: 'Events that failed and were not run again or cleared by an operator since, capped at 20. One below ``last_offset`` is not retried: the IDs are in ``indexer_state.metrics.failed_events`` for an operator rewind.'
          default: 0
        skipped_reason:
          anyOf:
          - type: string
            enum:
            - no_pending_events
            - schema_not_found
            - context_not_found
            - empty_valid_points
            - resource_entity_missing
            - memories_per_day_exceeded
            - plan_suspended
            - memory_limit_exceeded
          - type: 'null'
          title: Skipped Reason
          description: Present only when the last run was skipped. Surfacing a stale reason after a successful run is a UI bug we explicitly avoid.
      type: object
      title: IndexerStateMetrics
      description: Per-run indexer metrics, flattened from the JSONB column.
    ResourceEventItem:
      properties:
        id:
          type: integer
          title: Id
          description: Event sequence id (stable ordering)
        op:
          type: string
          enum:
          - upsert
          - delete
          title: Op
          description: Event operation
        doc_id:
          type: string
          title: Doc Id
          description: Document identifier (stable across versions)
        version:
          anyOf:
          - type: integer
          - type: 'null'
          title: Version
          description: 'Document version. NULL is a legitimate value for a delete-all-versions op (Issue #262).'
        created_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Created At
          description: ISO-8601 UTC creation timestamp
      type: object
      required:
      - id
      - op
      - doc_id
      title: ResourceEventItem
      description: Single row in the recent ingest events list.
    IndexerStatusResponse:
      properties:
        resource_id:
          type: string
          title: Resource Id
          description: Echo of the requested slug
        state:
          anyOf:
          - $ref: '#/components/schemas/IndexerState'
          - type: 'null'
          description: Indexer state row, or ``None`` when the indexer has never run against this resource/context. The 2-value model is intentional so the UI branches on ``state is None`` rather than inferring emptiness from individual field values.
        recent_events:
          items:
            $ref: '#/components/schemas/ResourceEventItem'
          type: array
          title: Recent Events
          description: Latest ingest events, newest first. Capped server-side at 5 — there is no client-tunable limit on this endpoint by design; a cursor-paginated timeline belongs on a dedicated endpoint.
      type: object
      required:
      - resource_id
      title: IndexerStatusResponse
      description: Response body for ``GET /api/v1/resources/{resource_id}/indexer-status``.