Rensei docs
API ReferenceProjects

Create a stage define or override at project or workflow scope (project admin).

Create a stage define or override at project or workflow scope (project admin). - Rensei REST API operation reference.

POST
/api/projects/{projectId}/stages

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

The project id.

Request Body

application/json
  1. body
key*string
Match^[a-z0-9]+(-[a-z0-9]+)*$
Length1 <= length <= 64
kind*string

define introduces the key and fixes its role; override changes an inherited stage.

Value in"define""override"
role?string

Required on a define; refused on an override.

Value in"hold""intake""inflight""review""rework""done""closed"
name?|

Display name; required on a define.

Length1 <= length <= 200
description?|
Lengthlength <= 2000
disabled?|

true hides an inherited stage; null inherits.

modelSelection?|||||

The stage default; a bare inherit is stored as null.

outcomes?|

Targets must be keys of the effective set of this scope, or stay.

retry?|null
policies?|null
workflowId?string

Write the workflow-scope row of this workflow (one of the project's).

Length1 <= length

Response Body

The project- or workflow-scope stage row.

application/json
  1. response
stage*
Example Request
curl -X POST 'https://app.rensei.ai/api/projects/string/stages' \  -H 'Content-Type: application/json' \  -d '{  "key": "string",  "kind": "define"}'
Example Response
{  "stage": {    "id": "string",    "scope": "system",    "scopeId": "string",    "key": "string",    "kind": "define",    "role": "hold",    "name": "string",    "description": "string",    "disabled": true,    "modelSelection": {      "mode": "inherit",      "effort": "low"    },    "outcomes": {      "start": {        "target": "string"      },      "success": {        "target": "stay"      },      "failure": {        "target": "stay"      },      "blocked": {        "target": "stay"      },      "close": {        "target": "stay"      }    },    "retry": {      "retries": 0,      "backoffSeconds": 0    },    "policies": {      "version": 1    },    "createdAt": "string",    "updatedAt": "string"  }}

The effective stage set of a project or one of its workflows, with provenance and the rows at that scope.

The effective stage set of a project or one of its workflows, with provenance and the rows at that scope. - Rensei REST API operation reference.

Edit the fields of the project- or workflow-scope stage row for a key (project admin).

Edit the fields of the project- or workflow-scope stage row for a key (project admin). - Rensei REST API operation reference.