Kagura AI Observation Credentials API

openapi: 3.2.0
info:
  title: Kagura Memory Cloud Observation Credentials API
  description: Universal AI Memory Platform - Remote MCP Server + Web Management
  version: 0.158.1
tags:
- name: observation-credentials
  description: Scoped read-only credentials for the observability API
paths:
  /api/v1/observation-credentials:
    post:
      tags:
      - observation-credentials
      summary: Create Observation Credential
      description: 'Issue a read-only observation credential for the current workspace.


        Raises:

        404: ``scope=resource`` names no resource of the current workspace.'
      operationId: create_observation_credential_api_v1_observation_credentials_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ObservationCredentialCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObservationCredentialCreateResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - observation-credentials
      summary: List Observation Credentials
      description: The current workspace's credentials, expired and revoked ones included.
      operationId: list_observation_credentials_api_v1_observation_credentials_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ObservationCredentialResponse'
                title: Response List Observation Credentials Api V1 Observation Credentials Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/observation-credentials/{credential_id}/rotate:
    post:
      tags:
      - observation-credentials
      summary: Rotate Observation Credential
      description: 'Replace a live credential with a new secret of the same binding.


        The new credential keeps the old one''s expiry; the old secret stops

        working after ``grace_seconds``.


        Raises:

        404: No live credential with this id in the current workspace, or

        it was already rotated.'
      operationId: rotate_observation_credential_api_v1_observation_credentials__credential_id__rotate_post
      parameters:
      - name: credential_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^obsk_[0-9A-Za-z]{22}$
          description: Public id of the observation credential (`obsk_` + 22 base62 characters).
          examples:
          - obsk_0000000000000000000000
          title: Credential Id
        description: Public id of the observation credential (`obsk_` + 22 base62 characters).
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: '#/components/schemas/ObservationCredentialRotate'
              - type: 'null'
              title: Body
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObservationCredentialCreateResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/observation-credentials/{credential_id}:
    delete:
      tags:
      - observation-credentials
      summary: Revoke Observation Credential
      description: 'Revoke a credential (revoking it again is a no-op).


        Raises:

        404: No credential with this id in the current workspace.'
      operationId: revoke_observation_credential_api_v1_observation_credentials__credential_id__delete
      parameters:
      - name: credential_id
        in: path
        required: true
        schema:
          type: string
          pattern: ^obsk_[0-9A-Za-z]{22}$
          description: Public id of the observation credential (`obsk_` + 22 base62 characters).
          examples:
          - obsk_0000000000000000000000
          title: Credential Id
        description: Public id of the observation credential (`obsk_` + 22 base62 characters).
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '204':
          description: Successful Response
        '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
    ObservationCredentialRotate:
      properties:
        grace_seconds:
          type: integer
          maximum: 86400.0
          minimum: 0.0
          title: Grace Seconds
          description: How long the old secret keeps working (0-86400 s, default 0)
          default: 0
      type: object
      title: ObservationCredentialRotate
      description: Request body for rotating a credential.
    ObservationCredentialCreate:
      properties:
        name:
          type: string
          maxLength: 100
          minLength: 1
          title: Name
        scope:
          type: string
          enum:
          - workspace
          - resource
          title: Scope
          description: '`workspace`: every resource of the current workspace; `resource`: the one resource named by `resource_id`'
          default: workspace
        resource_id:
          anyOf:
          - type: string
            maxLength: 255
            minLength: 1
          - type: 'null'
          title: Resource Id
          description: Resource slug; required for `scope=resource`, refused otherwise
        ttl_days:
          type: integer
          maximum: 365.0
          minimum: 1.0
          title: Ttl Days
          description: Lifetime in days (1-365, default 90); every credential expires
          default: 90
      type: object
      required:
      - name
      title: ObservationCredentialCreate
      description: Request body for issuing a credential.
    ObservationCredentialCreateResponse:
      properties:
        id:
          title: Id
          description: Public id (`obsk_` + 22 base62 characters)
        name:
          title: Name
        key_prefix:
          title: Key Prefix
          description: The secret's first 16 characters
        scope:
          title: Scope
        resource_id:
          title: Resource Id
          description: The bound resource's slug
        created_by:
          title: Created By
        created_at:
          title: Created At
        expires_at:
          title: Expires At
        last_used_at:
          title: Last Used At
        revoked_at:
          title: Revoked At
        rotated_from:
          title: Rotated From
          description: Public id of the credential it replaced
        status:
          title: Status
        secret:
          title: Secret
          description: The bearer secret (`kagura_obs_…`); shown only once
      type: object
      required:
      - id
      - name
      - key_prefix
      - scope
      - created_by
      - created_at
      - expires_at
      - status
      - secret
      title: ObservationCredentialCreateResponse
      description: A new credential with its secret, shown only in this response.
    ObservationCredentialResponse:
      properties:
        id:
          title: Id
          description: Public id (`obsk_` + 22 base62 characters)
        name:
          title: Name
        key_prefix:
          title: Key Prefix
          description: The secret's first 16 characters
        scope:
          title: Scope
        resource_id:
          title: Resource Id
          description: The bound resource's slug
        created_by:
          title: Created By
        created_at:
          title: Created At
        expires_at:
          title: Expires At
        last_used_at:
          title: Last Used At
        revoked_at:
          title: Revoked At
        rotated_from:
          title: Rotated From
          description: Public id of the credential it replaced
        status:
          title: Status
      type: object
      required:
      - id
      - name
      - key_prefix
      - scope
      - created_by
      - created_at
      - expires_at
      - status
      title: ObservationCredentialResponse
      description: A credential's metadata (never the secret).