Trigger preview deployment

POST

/requests/{id}/preview

Triggers a preview deployment for a request. The request must be in 'develop' or 'review' status and have a branch_name set from agent development.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Path Params

Responses

🟢201Created

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/preview' \
--header 'Authorization: Bearer <token>'

Response Example

201 - Example 1

{
    "data": {
        "deploymentId": "string",
        "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
        "branchName": "string",
        "status": "string",
        "triggeredAt": "string"
    }
}

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

Stream interview response

Get preview deployment info