Skip to main content
POST
/
api
/
v1
/
runs
/
{id}
/
preview
Preview URL
curl --request POST \
  --url https://api.example.com/api/v1/runs/{id}/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "port": 3000,
  "expires_in_secs": 3600,
  "signed": false
}
'
{
  "url": "https://preview.example.com/sb-a1b2c3d4/3000",
  "token": "preview-token-123"
}

Authorizations

​
Authorization
string
header
required

Raw dev token passed as Authorization: Bearer fabro_dev_... when server.auth.methods includes dev-token.

Path Parameters

​
id
string
required

Unique run identifier (ULID).

Body

application/json

Request body for generating a preview URL from a sandbox port.

​
port
integer
required

Port number exposed by the sandbox.

Example:

3000

​
expires_in_secs
integer
required

Time-to-live for the preview URL in seconds.

Required range: 1 <= x <= 86400
Example:

3600

​
signed
boolean
default:false

When true, return a signed URL that does not require a preview token header.

Response

Preview URL created

Response containing the generated preview URL.

​
url
string
required

Preview URL.

Example:

"https://preview.example.com/sb-a1b2c3d4/3000"

​
token
string

Preview token header value for unsigned preview URLs.

Example:

"preview-token-123"