API Reference
Interactive reference for every Rensei REST operation - schemas, auth, and a live "Test it" playground, generated from the OpenAPI spec.
One page per operation, grouped by tag. Each page renders the request/response
schemas from the platform-owned openapi/rensei-api.json copy plus an interactive playground. For
prose guides (auth modes, webhook signing, the worker protocol lifecycle), start
from the API overview.
A2 A
Agent-to-Agent discovery and dispatch listing. The .well-known routes
are fully unauthenticated; the dispatch listing requires a session cookie.
- A2A peer-discovery AgentCard
- A2A v1 JSON-RPC endpoint (SendMessage, GetTask, ListTasks, CancelTask).
- List registered A2A agents for the org
- Register a remote A2A agent
- Get a registered A2A agent
- Update agent trust level
- Delete a registered A2A agent
- Re-fetch AgentCard for an existing registration
- List open durable assignments for an A2A seat
- List A2A task dispatches for the authenticated org
Audit
Tamper-evident audit log. The events endpoint requires an rsk_ key or
session cookie. The .well-known/audit-keys JWKS is fully public.
- Per-workspace JWKS for audit signature verification.
- Account-free signed audit-entry verification sample.
- List tamper-evident audit events
- Retrieve an exact retained privileged-verification artifact.
Agent Cards
- List agent cards visible to the caller (system + org + optional project).
- Get one agent card, including editor-prefill content.
- Preview an effective Agent Card or review/apply project publication.
- Fork an installed reference agent card into a new owned identity.
- Get the marketplace pin and update state for an installed agent card.
- Preview the update from an installed agent-card pin to the current source version.
- Accept a current source version for an installed reference agent card.
Approvals
- List approval gates (pending-approvals feed) for the authenticated org.
- Create an approval gate for the authenticated organization.
- Submit a typed answer on a human_query gate.
- Submit an approve / reject / escalate decision on an approval gate.
- Apply one approve / reject decision to many approval gates.
Brand Assets
Capacity
- Re-converge a daemon projection with committed host authority.
- Update an organization execution pool.
- Read hourly fleet occupancy and admission wait.
C L I
- Ensure the signed-in user has a Codex OAuth requester identity.
- Read the Linear team and project catalog with credential visibility metadata.
- Proxy Linear GraphQL without alternate credential fallback.
- Look up agent sessions by Linear issue identifier.
- Resolve the authenticated org context for a CLI key or user token.
- List the organizations (workspaces) the authenticated principal belongs to.
Dispatch
- Submit an inbound BYOA agent-dispatch request.
- Get the assembled audit receipt for an inbound dispatch.
- Inspect typed delegation capability availability.
- Discover cards and their project workflow backing.
- Resolve workflow-admitted revision-pinned headless launch selections.
- Append an immutable configured HarnessConnection revision.
- Grant a configured HarnessConnection to one project.
- Promote immutable probe evidence for a configured connection.
- Author an org-scope harness compatibility declaration.
- List program-ledger records visible to the authenticated organization.
- Open a program-ledger record for an external key, idempotently.
- Read one program-ledger record.
- Read ordered structured-reference events for one program ledger.
- Read the unread mailbox records for one reader session.
- Mark program records read for one reader session.
- Read the append-only decision and handoff records for one program.
- Append one decision, handoff, checkpoint or note to a program.
- Read the current resumable topology for one program ledger.
- Read the structured program state, latest-wins per key.
- Compare-and-set write of one structured program state key.
- List typed session-ledger sessions for the authenticated organization.
- Request acknowledged cancellation of one admitted session.
- Read a session ledger bundle or computed dispatch receipt.
- Replay the ledger event channel for one admitted session.
- Read the last N lines of a session's terminal output.
- Stream ledger lifecycle events for one admitted session.
- Stream best-effort live execution events for a workflow instance.
Notifications
- Bind an app installation to the authenticated human.
- Replace or revoke an installation binding with proof rotation.
- Register or rotate an ActivityKit token under a current device binding.
- Register (or refresh) a push device token for the authenticated user.
- Revoke a push device token owned by the authenticated user.
- Return the VAPID public key for browser web-push subscription.
- Store a browser web-push subscription for the authenticated user.
M C P
JSON-RPC 2.0 over HTTP POST. Exposes per-session workflow tools, A2A peer agents, and agent memory (recall/remember) to running agent subprocesses.
- BYOA MCP facade (JSON-RPC 2.0)
- Per-session MCP tool surface (initialize, tools/list, tools/call) over JSON-RPC.
Performance
Workflows
- Validate and atomically create a project workflow draft.
- Validate or preview unsaved executable workflow content without writing or running it.
- List workflows in the authenticated org.
- Create a workflow.
- Get a workflow by id.
- Archive (soft-delete) a workflow.
- Save, publish or archive a canvas workflow (human member or management API key).
- Activate a saved workflow after resource and inbound mapping validation.
- Read inbound webhook configuration without secret material.
- Create an inbound webhook and reveal its signing secret once.
- Rotate the inbound signing secret, immediately invalidating the old secret.
- List runs (instances) of a workflow.
- Manually trigger a published workflow.
- Validate the current stored workflow without writing or executing it.
- List redacted model-profile launch options for one pinned workflow consumer input.
- Restore a workflow version while validating its inbound webhook mapping.
Collections
- List project collections
- Create a typed collection as an org admin
- Describe a collection and its current schema
- List live records with cursor pagination
- Read a live record
- Compare-and-set a shallow record patch
- Compare-and-set a record tombstone
- Compare-and-set a complete record
- Read immutable record history, newest first
- Append an immutable collection schema version
Worker Protocol
Endpoints used by the af / rensei-tui daemon to register workers,
heartbeat, poll for queued work, and report session lifecycle events.
Auth: runtime JWT (Bearer eyJ…) on all post-registration calls.
- Trigger credential rotation fan-out
- SSE stream for credential rotation events
- Resolve credential env map for a session
- Mint a short-lived GitHub installation token for a repo
- Post merge-queue landing verdict
- List daemon mutation history for a host
- Enqueue a daemon-config mutation
- Cancel an undelivered daemon mutation
- Upsert plugin verb option snapshots
- Publish a local plugin source version
- Fetch the bridge-adapter keyset, a current freshness statement, and the binary policy table.
- Acknowledge Donmai's durable privileged-verification claim
- Poll for a pending plugin verb invocation
- Post plugin verb invocation result
- Confirm Donmai terminal lease acknowledgement and authorize continuation
- Observe privileged-verification finalization status
- Get queued session detail for cloud runners
- Post agent activity (thought/action/response)
- Explicitly claim a pre-queued session
- Post completion summary
- Update Linear agent session with external URLs
- Check session file reservation conflicts
- Release specific file locks
- Release all file locks for a session
- Reserve file lock for a session
- ACK inbox message (Redis XACK)
- Refresh issue lock TTL
- Worker rejection of a pre-claimed session
- Post milestone progress message
- Record a routing observation (MAB reward)
- Sample MAB router for provider selection
- Post security scan event
- Read session state
- FSM status transition
- Lightweight step-level heartbeat
- Ingest batched interview token-delta frames
- Report tool execution error
- Transfer session to another worker
- Get worker detail
- Deregister a worker
- AF-compatible worker heartbeat
- Poll for queued work
- Refresh expired runtime JWT
- AF-compatible worker registration
Daemon
- Persist an exact host-level session restart fence.
- Atomically publish one complete per-org adoption batch before Ready.
- Read the opaque expected host adoption revision before batch publication.
- Persist exact replacement-controller adoption evidence.
- Prepare a strictly higher attach-v2 carrier epoch before Welcome.
- Resolve all five current proof-v2 readiness facts.
- Persist one positive terminal observation and resolve matching fences.
- Durably ingest normalized runtime events for one owned session.
Sessions
- Counts-only snapshot of in-flight execution shells for the page header.
- Snapshot of in-flight execution shells, urgency-ordered.
- Time-ordered conversation projection for one execution shell.
- Mark an execution shell handled (or un-handled) for the calling viewer.
- Count the inbox rows that need the calling viewer and are not handled.
- Subscribe to live Inbox updates across every member organization.
- Store exact relay-owned post-takeover snapshot proof.
- Read a session's sent and received a2a messages.
- Read durable execution events for one authorized session.
- Subscribe to the authenticated org's live session-event SSE stream.
- Read the agent topology cold snapshot (nodes, edges, counters).
Factory
- CI runs, re-runs and failures by head SHA for one repository.
- Seat scorecard by project, dispatch kind, card revision, model, profile, harness and effort.
Failure Signatures
- List failure signatures visible to the caller (org + system tier).
- Create an org-scoped failure signature (always tier='observed'). Requires the org admin role.
- Get a failure signature by id (org + system tier visibility).
Incidents
- List incidents for the authenticated org.
- Get incident summary counts (by status, by severity) and MTTR.
Integrations
- Start linking a human user’s Linear identity.
- Verify and link a human Linear identity.
- Exchange a Sentry public app installation grant
- Start a Sentry public app installation
- Delete this org’s Sentry public app installation credentials
Interactive sessions
- List interactive sessions visible to the caller.
- Launch a new interactive PTY-attach session.
- Get one interactive session's detail.
- Get durable A2A and host-heartbeat context for a live session.
- Re-bind a paused-but-alive interactive session back to active.
- Get exact installed-restart acceptance authority for one session.
- Cooperatively stop an interactive session.
- Mint a short-lived relay attach token (driver/viewer for users; host for the provisioning daemon) for an interactive session.
- List revision-pinned interactive-session launch choices for a project.
Marketplace
- List model catalog identities available for org adoption.
- Install a model card as an org model library entry.
Authentication
OAuth 2.0 M2M token endpoint and API key management.
Org
- List host binary consents in the org, and what each consentable binary requires (org admin, humans only).
- Consent one host to run one binary for the exact command set its accepted contracts need (org admin, humans only).
- Revoke a host binary consent (org admin, humans only).
- List pending org invites (org admin).
- Create an org invite (org admin).
- Open the SSO / Directory Sync Admin Portal (org owner/admin).
- Read the authenticated org's SSO status (org owner/admin).
- List the org's work types (built-in seed plus org-defined).
- Register an org-defined work type (org admin).
- Retire an org-defined work type (org admin; built-ins cannot be retired).
B Y O A
- List the agent cards an external-agent registration can allow (org admin).
- List BYOA requester registrations for the org.
- Create a requester registration and mint its bound dispatch key (token returned once).
Routing
- List hosted routing (placement) decision records for the org.
- Get one hosted routing (placement) decision's full stage walk and multi-hop linkage.
Organizations
Org Keys
- List API keys for the active org (metadata only).
- Create an org-scoped API key (full secret returned once). Deprecated - use POST /api/org/{orgId}/keys.
- Soft-delete (revoke) an org API key.
- Shrink-only narrowing of a key's project fence and/or scopes.
Organization
- Read the organization Sentry project map.
- Replace the organization Sentry project map.
- Get settings for the authenticated organization.
- Update settings for the authenticated organization.
Teams
Plugins
Policies
- List Cedar policies for the authenticated org.
- Create an active or draft Cedar policy with immutable version 1.
- Get one Cedar policy with its version history.
- Archive a Cedar policy. Hard deletion is retention-forbidden.
- Edit, change status, restore, or promote a Cedar policy version.
Projects
- List projects in the authenticated org (autocomplete-shaped options).
- Get project details.
- Update a project (rename / re-slug / describe).
- Soft-delete a project.
- Read a durable A2A stream without changing participant state.
- List durable A2A peers with liveness and delivery-capability truth.
- List durable A2A streams in a project without advancing cursors.
- Get the configured defaults for a project.
- Get effective project defaults and their resolution sources.
- Claim an issue for a stage, with the claim record as the atomic lock.
- List the claim history for an issue, newest first.
- Release the live claim on an issue for a stage.
- List workflow project-parameter recipient readiness for one project.
- Read one workflow recipient project-parameter editor projection.
- Atomically set or clear project parameter overrides with revision CAS.
Authoring
- Store a reviewed synthesis candidate as an isolated proposal.
- Advance a typed builder conversation without generating or writing.
- Simulate and explain a proposed new canvas against one exact Cedar policy revision.
- Read the current immutable version of a scoped authoring proposal.
- Reject a proposal or apply one to an existing draft workflow.
- Generate a validated workflow or agent-card draft for explicit review.
Memory
Models
Resources
- List a project's resource palette, grouped by kind.
- Declare a project's primary harness or sandbox provider.
Sessions ( Public)
Public session monitoring endpoints. Most require an rsk_ API key or
session cookie (authenticatePublicRequest). The per-session prompt/stop
actions accept the same auth.
- Platform-wide anonymised aggregate statistics
- Phase-level cycle time, cost, and rework aggregations
- MAB router performance posteriors and recent decisions
- Get session activity time-series
- List enriched sessions for the authenticated org
- Get enriched session detail
- Send a prompt to a running session
- Get Sentry issues linked to a session
- Stop a running session
- Real-time fleet statistics (org-scoped)
Security
Telemetry
Templates
Webhooks
Inbound webhook ingestion from Linear, GitHub, GitHub Actions, and Vercel.
Authenticated by HMAC signature. Responds with an immediate 200 ACK; all
processing is deferred via after().
API Overview
Auth mechanisms and route-group map.
A2A peer-discovery AgentCard
Fully unauthenticated (public) per the A2A v1 specification. Two modes: - No query param: platform-level AgentCard (`scope='system'` rows). - `?org=<slug>`: per-org AgentCard (`scope='org'` cards with `trust.publish_to_a2a=true`). Canonical discovery URI: `/.well-known/agent-card.json`. The historical `/.well-known/agent.json` spelling permanently redirects here. `Cache-Control: public, max-age=300` on successful responses.