Mnemom Onboarding API
Onboarding guidance generation (MNE-5508) — LLM-driven step guidance + bounded action suggestions for customers completing onboarding checklists.
Onboarding guidance generation (MNE-5508) — LLM-driven step guidance + bounded action suggestions for customers completing onboarding checklists.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/mnemom-ai:mnemom-ai-onboarding-api"
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.
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: 3.2.0
info:
title: Mnemom Onboarding 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: Onboarding
description: Onboarding guidance generation (MNE-5508) — LLM-driven step guidance + bounded action suggestions for customers completing onboarding checklists.
paths:
/onboarding/guide:
post:
operationId: generateOnboardingGuide
summary: Generate guidance for an onboarding checklist step
description: 'MNE-5508: Accepts a checklist item ID and user context; generates LLM-driven guidance narration and a bounded action suggestion. Gated behind `ONBOARDING_GUIDE_ENABLED` (dark by default) and `ONBOARDING_GUIDE_ALLOWLIST` (defaults to @mnemom.ai). Requires authentication.'
tags:
- Onboarding
security:
- BearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- checklist_item_id
- user_role
properties:
checklist_item_id:
type: string
description: The ID of the onboarding checklist item (e.g., 'org.create', 'agent.alignment-card').
user_role:
type: string
description: The user's role (e.g., 'organization_owner', 'developer', 'security_lead', 'compliance_officer').
facts:
type: object
additionalProperties: true
description: 'Optional contextual facts about the user''s state (e.g., org_exists: true, first_agent_chosen: false).'
completed_steps:
type: array
items:
type: string
description: Optional array of checklist item IDs the user has already completed.
user_goal:
type: string
description: Optional user-provided goal or context (e.g., 'Build a support bot', 'Set up trusted governance').
org_id:
type: string
description: Optional organization ID for multi-tenant context.
user_id:
type: string
description: Optional user ID (can be overridden from auth context).
responses:
'200':
description: Guidance generated successfully. Returns narration, suggested action, next step, and session correlation ID.
content:
application/json:
schema:
type: object
required:
- narration
- session_id
- fallback
properties:
narration:
type: string
description: The LLM-generated guidance narration for this step.
action:
type: object
properties:
type:
type: string
enum:
- navigate
- click
- fill-form
- wait-for-element
- read-text
description: The type of action to suggest.
params:
type: object
additionalProperties: true
description: Action-specific parameters (e.g., url for navigate, selector for click).
description: The suggested bounded action the user should take.
next_step:
type: object
properties:
item_id:
type: string
description: The ID of the next onboarding step.
estimated_time:
type: string
description: Estimated time to complete the step (e.g., '~2 min', '~5-10 min').
description: Metadata about the current step and estimated time.
session_id:
type: string
description: Correlation ID for this guidance session (for telemetry).
fallback:
type: boolean
description: True if the response is a fallback (LLM service unavailable or validation error).
error:
type: string
description: 'Optional error message (only if fallback: true).'
'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'
'503':
description: Service temporarily unavailable (LLM service down). Returns fallback guidance.
content:
application/json:
schema:
type: object
properties:
narration:
type: string
action:
type: object
properties:
type:
type: string
enum:
- navigate
- click
- fill-form
- wait-for-element
- read-text
description: The type of action to suggest.
params:
type: object
additionalProperties: true
description: Action-specific parameters (e.g., url for navigate, selector for click).
next_step:
type: object
properties:
item_id:
type: string
description: The ID of the next onboarding step.
estimated_time:
type: string
description: Estimated time to complete the step (e.g., '~2 min', '~5-10 min').
session_id:
type: string
fallback:
type: boolean
enum:
- true
error:
type: string
components:
responses:
Unauthorized:
description: Authentication required
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'
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'
schemas:
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).'