Trigger workflow transition

POST

/requests/{id}/transition

Triggers a workflow state transition. The transition is validated against the state machine to ensure it's a valid action from the current state.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Successful response

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/requests/123/transition' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "action": "create",
    "payload": {
        "type": "start_interview",
        "conversationId": "ee6e55e8-45fe-4a3e-9bc8-4669f9fdf77a",
        "gherkinCriteria": "string",
        "agentPrompt": "string",
        "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459",
        "branchName": "string",
        "commitSha": "string",
        "feedback": "string",
        "previewUrl": "http://example.com",
        "pullRequestUrl": "http://example.com",
        "workItemUrl": "http://example.com",
        "mergedAt": "string",
        "reason": "string"
    }
}'

Response Example

200 - Example 1

{
    "data": {
        "request": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
            "title": "string",
            "description": "string",
            "type": "feature",
            "priority": "low",
            "status": "create",
            "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
            "gherkin_criteria": "string",
            "agent_prompt": "string",
            "branch_name": "string",
            "pull_request_url": "http://example.com",
            "preview_url": "http://example.com",
            "created_at": "string",
            "updated_at": "string"
        },
        "previousState": "create",
        "newState": "create",
        "action": "create"
    }
}

Modified at 2026-02-08 16:57:15

Get available transitions

Get current user