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

AuthorizationBearer <token>

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

In: header

Path Parameters

projectId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/projects/string/authoring/conversation" \  -H "Content-Type: application/json" \  -d '{    "action": "start",    "goal": "string"  }'
{
  "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
}
Empty
Empty
Empty
Empty
Empty