Mnemom Licensing API

License management.

GitHub OpenAPI

Operations 7

POST /deployments/heartbeat Self-hosted deployment heartbeat #
POST /license/validate Validate a license key (public) #
GET /orgs/{org_id}/deployments List self-hosted deployments for an org #
POST /orgs/{org_id}/deployments Register a new self-hosted deployment #
GET /orgs/{org_id}/deployments/{deployment_id} Get a self-hosted deployment #
PUT /orgs/{org_id}/deployments/{deployment_id} Update a self-hosted deployment #
DELETE /orgs/{org_id}/deployments/{deployment_id} Delete a self-hosted deployment #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/mnemom-ai:mnemom-ai-licensing-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

mnemom-ai-licensing-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Mnemom Licensing API
  description: Trust infrastructure for AI agents. Transparent alignment verification, behavioral drift detection, and accountability primitives.
  version: 1.0.0
  contact:
    name: Mnemom
    url: https://mnemom.ai
    email: support@mnemom.ai
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://api.mnemom.ai/v1
  description: Production
security:
- BearerAuth: []
- ApiKeyAuth: []
tags:
- name: Licensing
  description: License management.
paths:
  /deployments/heartbeat:
    post:
      operationId: deploymentHeartbeat
      summary: Self-hosted deployment heartbeat
      description: Called periodically by a self-hosted Mnemom instance to report liveness, version, and metadata back to the managed control plane. Uses a **License JWT** bearer token (not a user JWT) — the token is issued during license validation. The response includes `next_heartbeat_seconds` telling the instance when to call back.
      tags:
      - Licensing
      security:
      - LicenseJwtAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - deployment_id
              - instance_id
              properties:
                deployment_id:
                  type: string
                instance_id:
                  type: string
                version:
                  type: string
                heartbeat_data:
                  type: object
                  additionalProperties: true
                  description: Free-form liveness telemetry (uptime, resource usage, component versions …).
      responses:
        '200':
          description: Heartbeat accepted.
          content:
            application/json:
              schema:
                type: object
                required:
                - deployment_id
                - status
                - next_heartbeat_seconds
                - server_time
                properties:
                  deployment_id:
                    type: string
                  status:
                    type: string
                    enum:
                    - active
                    - inactive
                    - degraded
                  next_heartbeat_seconds:
                    type: integer
                    default: 300
                  server_time:
                    type: string
                    format: date-time
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/CrossOriginRejected'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /license/validate:
    post:
      operationId: validateLicense
      summary: Validate a license key (public)
      tags:
      - Licensing
      security:
      - {}
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - license
              - instance_id
              properties:
                license:
                  type: string
                  description: License JWT token
                instance_id:
                  type: string
                  description: Unique instance identifier
                instance_metadata:
                  type: object
                  additionalProperties: false
                  description: 'Optional: instance metadata (hostname, region, version only). No PII, API keys, or secrets allowed. Unknown fields are rejected.'
                  properties:
                    hostname:
                      type: string
                      maxLength: 255
                      description: Instance hostname (e.g. server-prod-01)
                    region:
                      type: string
                      pattern: ^[a-z0-9-]+$
                      maxLength: 64
                      description: Deployment region (e.g. us-1, eu-west, ap-southeast)
                    version:
                      type: string
                      pattern: ^[0-9]+\.[0-9]+\.[0-9]+$
                      description: Instance software version (e.g. 1.2.3)
      responses:
        '200':
          description: License valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  valid:
                    type: boolean
                  license_id:
                    type: string
                  plan_id:
                    type: string
                  feature_flags:
                    type: object
                    additionalProperties:
                      type: boolean
                  limits:
                    type: object
                  expires_at:
                    type: string
                    format: date-time
                  next_check_seconds:
                    type: integer
                  warning:
                    type:
                    - string
                    - 'null'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '410':
          description: License expired
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /orgs/{org_id}/deployments:
    get:
      operationId: listOrgDeployments
      summary: List self-hosted deployments for an org
      description: Any org member (owner / admin / member / viewer / auditor) may list deployments. Filter by `status` (`active`, `inactive`, `degraded`).
      tags:
      - Licensing
      security:
      - BearerAuth: []
      - ApiKeyAuth: []
      - CookieAuth: []
      parameters:
      - $ref: '#/components/parameters/OrgId'
      - name: status
        in: query
        required: false
        schema:
          type: string
          enum:
          - active
          - inactive
          - degraded
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 50
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          default: 0
      responses:
        '200':
          description: Deployment list.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                properties:
                  deployments:
                    type: array
                    items:
                      $ref: '#/components/schemas/SelfHostedDeployment'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
    post:
      operationId: registerOrgDeployment
      summary: Register a new self-hosted deployment
      description: Requires org `owner` or `admin`. The `license_id` must already exist and belong to this org (verified via `verify_org_license` RPC). The deployment starts in `active` status.
      tags:
      - Licensing
      security:
      - BearerAuth: []
      - ApiKeyAuth: []
      - CookieAuth: []
      parameters:
      - $ref: '#/components/parameters/OrgId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - instance_name
              - instance_id
              - license_id
              properties:
                instance_name:
                  type: string
                instance_id:
                  type: string
                license_id:
                  type: string
                region:
                  type:
                  - string
                  - 'null'
                version:
                  type:
                  - string
                  - 'null'
                instance_metadata:
                  type: object
                  additionalProperties: true
      responses:
        '201':
          description: Deployment registered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelfHostedDeployment'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /orgs/{org_id}/deployments/{deployment_id}:
    get:
      operationId: getOrgDeployment
      summary: Get a self-hosted deployment
      tags:
      - Licensing
      security:
      - BearerAuth: []
      - ApiKeyAuth: []
      - CookieAuth: []
      parameters:
      - $ref: '#/components/parameters/OrgId'
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Deployment detail.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelfHostedDeployment'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
    put:
      operationId: updateOrgDeployment
      summary: Update a self-hosted deployment
      description: 'Partial update. Requires org `owner` or `admin`. Allowed fields: `instance_name`, `region`, `status` (`active`/`inactive`/`degraded`), `version`, `instance_metadata`.'
      tags:
      - Licensing
      security:
      - BearerAuth: []
      - ApiKeyAuth: []
      - CookieAuth: []
      parameters:
      - $ref: '#/components/parameters/OrgId'
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              minProperties: 1
              properties:
                instance_name:
                  type: string
                region:
                  type:
                  - string
                  - 'null'
                status:
                  type: string
                  enum:
                  - active
                  - inactive
                  - degraded
                version:
                  type:
                  - string
                  - 'null'
                instance_metadata:
                  type: object
                  additionalProperties: true
      responses:
        '200':
          description: Update accepted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deployment_id:
                    type: string
                  updated:
                    type: boolean
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      operationId: deleteOrgDeployment
      summary: Delete a self-hosted deployment
      description: Requires org `owner` or `admin`. Hard-deletes the `self_hosted_deployments` row. The license remains valid — re-register to replace.
      tags:
      - Licensing
      security:
      - BearerAuth: []
      - ApiKeyAuth: []
      - CookieAuth: []
      parameters:
      - $ref: '#/components/parameters/OrgId'
      - name: deployment_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Deleted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deployment_id:
                    type: string
                  deleted:
                    type: boolean
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  responses:
    Conflict:
      description: Resource conflict — the request cannot proceed because of a current state conflict (e.g., resource already exists, version mismatch, in-flight idempotency key with a different body).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServiceUnavailable:
      description: An upstream dependency is currently unavailable. The request was not processed; retry after the cooldown window.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Server error — request was well-formed but the server failed to fulfill it. Typically a downstream dependency (DB / RPC / external API) returned an unexpected error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TooManyRequests:
      description: Rate-limit exceeded. The global per-IP limiter (100 requests/minute, applied to every `/v1/*` route) rejected this request. Back off until the window resets — `Retry-After` carries the cooldown in seconds and `X-RateLimit-Reset` the absolute reset time.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          description: Requests permitted per window.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests remaining in the current window (0 on a 429).
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Unix epoch seconds at which the current window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    CrossOriginRejected:
      description: Cross-origin write refused (`cross_origin_rejected`). A state-changing request that carries the browser session cookie must come from a first-party origin (`Origin`, or failing that `Referer`) and must not send a form-style body (text/plain, urlencoded, multipart) the operation does not declare. Bearer and API-key callers are never subject to this check.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    OrgId:
      name: org_id
      in: path
      required: true
      schema:
        type: string
      description: Organization identifier (e.g. org-abc12345)
  schemas:
    SelfHostedDeployment:
      type: object
      description: A self-hosted Mnemom deployment registered by an org.
      properties:
        deployment_id:
          type: string
          description: Prefixed `dep-…` identifier assigned on registration.
        org_id:
          type: string
        license_id:
          type: string
        instance_name:
          type: string
        instance_id:
          type: string
        region:
          type:
          - string
          - 'null'
        status:
          type: string
          enum:
          - active
          - inactive
          - degraded
        version:
          type:
          - string
          - 'null'
        heartbeat_data:
          type: object
          additionalProperties: true
        instance_metadata:
          type: object
          additionalProperties: true
        last_heartbeat_at:
          type:
          - string
          - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      description: Canonical error envelope (ADR-API-001 conv 1). `error` is always an object — never a bare string. Every 4xx/5xx response across the API conforms to this shape; the runtime helper is `src/http-errors.ts::buildErrorBody`.
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
              pattern: ^[a-z][a-z0-9_]*$
              description: 'Stable, machine-matchable failure identifier (lowercase snake_case). Clients may branch on this; the string is part of the contract.


                **Status-class defaults** — emitted when no caller code is supplied (`errorCodeForStatus(status)`): `bad_request` (400), `unauthorized` (401), `forbidden` (403), `not_found` (404), `method_not_allowed` (405), `conflict` (409), `gone` (410), `precondition_failed` (412), `payload_too_large` (413), `unsupported_media_type` (415), `unprocessable_entity` (422), `precondition_required` (428), `rate_limited` (429), `internal_error` (500), `not_implemented` (501), `bad_gateway` (502), `service_unavailable` (503), `gateway_timeout` (504). Fallback `error` for unmapped statuses.


                **Caller-supplied codes** — handlers may pass an explicit `code` for a specific failure class. Examples: `agent_not_found`, `invalid_hash_proof`, `already_linked`, `idempotency_conflict`, `feature_gated`, `schema_validation_failed`, `no_token`, `bad_canonical_payload`.


                **Care-framed sub-resource codes** — the cards-as-primitive surface passes its stable care code-string straight through as `error.code`. Examples: `if_match_absent`, `if_match_stale`, `if_match_malformed`, `primitive_validation_failed`.'
            message:
              type: string
              description: Human-readable, care-framed explanation of the failure.
            details:
              description: 'Optional structured context for the failure (any JSON value: object, array, or primitive). Common shapes: validation findings list, idempotency-conflict diff, `{presented_etag, current_etag}` on a stale `If-Match`, etc. Mirrors the helper''s `details?: unknown`.'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Supabase JWT token in Authorization: Bearer header'
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Mnemom-Api-Key
      description: Mnemom API key (mnm_... format)
    ServiceRole:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Supabase service role bearer JWT. Used by /blog admin operations that talk directly to Supabase. NOT used by /internal/* or /v1/arena/internal/* — those use the custom-header schemes below.
    InternalKeyAuth:
      type: apiKey
      in: header
      name: X-Internal-Key
      description: Internal service-to-service shared secret, timing-safe compared against INTERNAL_API_KEY. Used by /internal/* gateway routes (compose, agents, webhooks emit).
    ServiceKeyAuth:
      type: apiKey
      in: header
      name: X-Service-Key
      description: Service-to-service shared secret, timing-safe compared against MNEMOM_SERVICE_KEY. Used by /v1/arena/internal/*, /v1/on-chain/*, and the /v1/internal/* readers consumed by the reputation cron.
    CoherenceTokenAuth:
      type: http
      scheme: bearer
      description: Per-cell coherence bearer token. Provisioned in 1Password vault `mnemom-coherence` (one item per receiver). Value compared against COHERENCE_<NAME>_SERVICE_TOKEN_EXPECTED. Used by /v1/internal/coherence/* and /v1/internal/governance/dispatch.
    ArenaCandidateTokenAuth:
      type: http
      scheme: bearer
      description: Dedicated arena writer token (ADR-004 §"Arena dedicated writer token"). Compared against ARENA_RECIPE_CANDIDATE_TOKEN. The token's only capability is writing recipe candidates with writer_identity='arena-bypass' (stamped server-side). Used by POST /v1/internal/recipe-candidates.
    CustomerVoiceTokenAuth:
      type: http
      scheme: bearer
      description: Customer Voice API bearer token. Timing-safe compared against CUSTOMER_VOICE_API_TOKEN. Grants access to all /v1/internal/feedback/* endpoints (MNE-1876). No customer-facing or reporter-read capability.
    CookieAuth:
      type: apiKey
      in: cookie
      name: mnemom_session
      description: 'HttpOnly, Secure, SameSite=Lax cookie issued by /v1/auth/sign-in (or the SSO / email-callback flows). The value is an AES-256-GCM-encrypted blob of {access_token, refresh_token, issued_at, auth_method}. Browser clients include this automatically with `credentials: "include"`.'
    LicenseJwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: License JWT (HS256, HMAC-signed with LICENSE_SIGNING_SECRET). Used by self-hosted deployment instances to authenticate `/v1/deployments/heartbeat`. Not interchangeable with the Supabase user JWT.
    AgentAuth:
      type: apiKey
      in: header
      name: X-Mnemom-Agent-Proof
      description: 'Agent possession proof: the full SHA-256 hex digest of `${apiKey}|${agentName}` (or `${apiKey}` for an unnamed singleton agent) — the same `hash_proof` primitive used by POST /v1/agents claim, link-agent, and verify-binding. The server resolves the agent by `agent_hash = proof[:16]`. The agent''s *own* identity (ADR-API-001 third auth class) — distinct from ApiKeyAuth (`X-Mnemom-Api-Key`, which resolves a user/account, not an agent).'