Rensei docs
API ReferenceAuthoring

Store a reviewed synthesis candidate as an isolated proposal.

Revalidates typed, base, candidate, vocabulary, policy, and proposal-version digests before appending an immutable proposal version. This route never mutates runtime workflows or agent cards.

POST
/api/projects/{projectId}/authoring/apply

Authorization

headerAuthorizationBearer <rsk_live_*>

Rensei API key presented as Authorization: Bearer rsk_live_. Required API-key scopes are recorded per operation in x-rensei-required-scopes.

Path Parameters

projectId*string

Request Body

application/json
  1. body
target*string
workflowId?string
proposalId?string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
expectedProposalVersion?|
Range0 < value <= 9007199254740991
candidateDigest*string
Match^[a-f0-9]{64}$
baseDigest*|
Match^[a-f0-9]{64}$
vocabularyDigest*string
Match^[a-f0-9]{64}$
policyDigest*string
Match^[a-f0-9]{64}$
plan*

Response Body

Proposal created or versioned.

application/json
  1. response
applied*boolean
target*string
Value in"workflow""agent_card"
proposalId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
status*string
version*integer
Range0 < value <= 9007199254740991
auditPending*boolean
Example Request
curl -X POST 'https://app.rensei.ai/api/projects/string/authoring/apply' \  -H 'Content-Type: application/json' \  -d '{  "target": "workflow",  "candidateDigest": "string",  "baseDigest": "string",  "vocabularyDigest": "string",  "policyDigest": "string",  "plan": {    "name": "string",    "description": "string",    "nodes": [      {        "id": "string",        "nodeKey": "string",        "config": {          "property1": null,          "property2": null        }      }    ],    "edges": [      {        "source": "string",        "target": "string"      }    ]  }}'
Example Response
{  "applied": true,  "target": "workflow",  "proposalId": "9c0e116a-cd43-4035-9c2d-b9b55ce4f74b",  "status": "draft",  "version": 1,  "auditPending": true}

Atomically set or clear project parameter overrides with revision CAS.

Parameter readiness is limited to declared values and does not assert workflow activation or execution readiness. Machine principals receive a typed writer-principal refusal.

Advance a typed builder conversation without generating or writing.

Collects three bounded HumanQuery-compatible clarification rounds and returns the existing synthesis request shape. State is client-carried and strictly revalidated on every turn; this endpoint never invokes an LLM, dispatches work, or persists a proposal.