Rensei docs
API ReferenceProjects

Read one workflow recipient project-parameter editor projection.

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

GET
/api/projects/{projectId}/workflow-parameters/{workflowId}

Authorization

headerAuthorizationBearer <WorkOS user access token>

WorkOS user access token created by the Rensei CLI. The authenticated organization is resolved from membership and may be narrowed with X-Rensei-Org.

Path Parameters

projectId*string
workflowId*string

Response Body

Current editor projection after authorization and validation.

application/json
  1. response
workflow*
binding*
parameterReadiness*string
Value in"ready""missing""invalid"
parameters*array<>
retired*array<>
Example Request
curl -X GET 'https://app.rensei.ai/api/projects/string/workflow-parameters/string'
Example Response
{  "workflow": {    "id": "string",    "name": "string"  },  "binding": {    "declarationOwnerId": "string",    "workflowKey": "string",    "declarationDigest": "string"  },  "parameterReadiness": "ready",  "parameters": [    {      "declaration": {        "id": "string",        "key": "string",        "label": "string",        "description": "string",        "type": {          "kind": "string",          "schema": {            "property1": null,            "property2": null          },          "elementType": {            "property1": null,            "property2": null          },          "members": [            {              "property1": null,              "property2": null            }          ],          "nullable": true,          "structRef": {            "id": "string",            "name": "string",            "version": 0          }        },        "required": true,        "ui": {          "control": "text",          "options": [            "string"          ],          "placeholder": "string"        }      },      "source": "project-value",      "status": "ready",      "effectiveValue": null,      "workflowDefault": null,      "valueState": "set",      "valueVersion": 0,      "validatedDeclarationDigest": "string",      "reason": "WORKFLOW_PARAMETER_REQUIRED",      "resourceAuthorityDigest": "string"    }  ],  "retired": [    {      "parameterId": "string",      "state": "set",      "valueVersion": 1,      "validatedDeclarationDigest": "string"    }  ]}

List workflow project-parameter recipient readiness for one project.

Returns parameter-value readiness only. It does not assert workflow activation or execution readiness and contains no raw values.

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.