ContextDB Meta API

openapi: 3.2.0
info:
  title: ContextDB Cloud data-plane Meta API
  version: 1.0.0-alpha.1
  description: 'The ContextDB Cloud data plane (hosted alpha). Managed, decision-safe

    agent memory: remember with provenance, recall for grounding, and

    recall_for_action before consequential actions.


    Authentication: `Authorization: Bearer cdb_…` is a project-wide server

    credential. The key determines org and project; requests supply only

    `user_id`, which is a partition key, not end-user authentication.


    This surface is the complete alpha allowlist. Shipped `/v1/forget`

    supports scoped deletion of one memory, one stable entity-and-attribute

    slot, or one verified user partition. Partition erasure requires

    `erase_partition=true`, typed `confirmation` equal to `user_id`, and an

    `Idempotency-Key`. Scoped ID checks make a foreign memory ID

    indistinguishable from a missing one.


    `/mcp` is a Hosted Alpha stateless JSON-RPC 2.0 endpoint over Streamable

    HTTP. Trusted backends may use a project key. Marketplace clients use

    OAuth 2.1 authorization code with S256 PKCE, refresh-token rotation, and a

    server-bound user partition. It exposes tools only, with no sessions, SSE,

    resumability, or server-initiated messages.


    Not production-ready. No SLA.'
  contact:
    name: Atoms AI
    email: gaurav@saaslabs.co
  license:
    name: Proprietary, hosted alpha
    identifier: LicenseRef-Proprietary
servers:
- url: https://api.contextdb.ai
  description: Hosted alpha
security:
- ProjectKey: []
tags:
- name: Meta
  description: Public process health and dependency readiness
paths:
  /health:
    get:
      tags:
      - Meta
      summary: Liveness with no auth or dependency checks
      operationId: health
      security: []
      responses:
        '200':
          description: Process is alive
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '429':
          $ref: '#/components/responses/RateLimited'
  /.well-known/contextdb-audit-keys.json:
    get:
      tags:
      - Meta
      summary: Public keys for offline audit-export verification
      operationId: auditVerificationKeys
      security: []
      responses:
        '200':
          description: Active audit signing keys
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditPublicKeys'
        '429':
          $ref: '#/components/responses/RateLimited'
  /ready:
    get:
      tags:
      - Meta
      summary: Readiness for metadata, memory, connector, and formation stores plus PII key
      operationId: ready
      security: []
      responses:
        '200':
          description: All checks pass
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadyResponse'
        '503':
          description: At least one check fails
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadyResponse'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    ReadyResponse:
      type: object
      required:
      - ready
      - checks
      properties:
        ready:
          type: boolean
        checks:
          type: object
          required:
          - metadata_store
          - memory_store
          - connector_store
          - formation_store
          - pii_key
          properties:
            metadata_store:
              type: boolean
            memory_store:
              type: boolean
            connector_store:
              type: boolean
            formation_store:
              type: boolean
            pii_key:
              type: boolean
          additionalProperties: false
      additionalProperties: false
    Error:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: Machine-readable error code
        message:
          type: string
          description: Human-readable message; never a stack trace
        request_id:
          type:
          - string
          - 'null'
      additionalProperties: false
    AuditPublicKeys:
      type: object
      required:
      - schema_version
      - keys
      properties:
        schema_version:
          type: integer
          const: 1
        keys:
          type: array
          items:
            type: object
            required:
            - kid
            - alg
            - public_key
            - status
            properties:
              kid:
                type: string
                minLength: 16
                maxLength: 16
              alg:
                type: string
                const: Ed25519
              public_key:
                type: string
              status:
                type: string
                const: active
            additionalProperties: false
      additionalProperties: false
    HealthResponse:
      type: object
      required:
      - ok
      - service
      properties:
        ok:
          type: boolean
        service:
          type: string
        sdk_pin:
          type: string
      additionalProperties: true
  responses:
    RateLimited:
      description: 'The client IP/project exceeded its request rate, or the project''s

        idempotency retention capacity is full until older keys expire.

        '
      headers:
        Retry-After:
          description: Seconds until a request is likely to be accepted
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          description: Sustained requests allowed per minute
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Remaining:
          description: Requests remaining in the current burst bucket
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Scope:
          description: Limiting identity (`ip` or `project`)
          schema:
            type: string
            enum:
            - ip
            - project
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ProjectKey:
      type: http
      scheme: bearer
      description: Project-wide server credential (`cdb_…`). Never in browsers.
    McpOAuth:
      type: oauth2
      description: User-bound marketplace connector grant (`cmo_…`).
      flows:
        authorizationCode:
          authorizationUrl: https://app.contextdb.ai/oauth/authorize
          tokenUrl: https://api.contextdb.ai/oauth/token
          refreshUrl: https://api.contextdb.ai/oauth/token
          scopes:
            memory:read: Recall memory and evaluate evidence before actions
            memory:write: Remember, confirm, and forget memory
            offline_access: Rotate a refresh token for continued access