Rensei docs
API ReferenceAuthoring

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.

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

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
action*string
goal*string
Length3 <= length <= 4000
target?string
Default"workflow"
Value in"workflow""agent_card"
workflowId?string
Length1 <= length <= 120
agentCardId?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

Response Body

Next typed query or completed synthesis request.

application/json
  1. response
status*string
Value in"question""ready"
state*
query?unknown
synthesisRequest?unknown
conversation?unknown
Example Request
curl -X POST 'https://app.rensei.ai/api/projects/string/authoring/conversation' \  -H 'Content-Type: application/json' \  -d '{  "action": "start",  "goal": "string"}'
Example Response
{  "status": "question",  "state": {    "kind": "builder-conversation",    "schemaVersion": "1",    "goal": "string",    "target": "workflow",    "workflowId": "string",    "agentCardId": "2a5965de-58ff-478a-b9b7-851d0b90b5c2",    "nextRound": "outcome",    "turns": [      {        "round": "outcome",        "prompt": "string",        "answer": {          "property1": null,          "property2": null        },        "answeredAt": "2019-08-24T14:15:22Z"      }    ]  },  "query": null,  "synthesisRequest": null,  "conversation": null}