Create preview deployment

Create a preview deployment from a Git branch to preview documentation changes before merging.

POST /project/{projectId}/preview

Create preview deployment

cURL

curl --request POST \
  --url https://api.mintlify.com/v1/project/{projectId}/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "branch": "feature/my-branch"
}
'

202

{
  "statusId": "<string>",
  "previewDeploymentId": "<string>",
  "subdomain": "<string>",
  "previewUrl": "<string>"
}

Authorizations

Authorization · string · header · required

The Authorization header expects a Bearer token. Use an admin API key (prefixed with mint_). This is a server-side secret key. Generate one on the API keys page in your dashboard.

Path Parameters

projectId · string · required

Your project ID. Can be copied from the API keys page in your dashboard.

Body

application/json

branch · string · required

The Git branch to create a preview deployment from.

Example:

"feature/my-branch"

Response

202

application/json

Preview deployment creation has been queued.

statusId · string

The status ID to poll for build progress.

previewDeploymentId · string

The unique identifier of the created preview deployment.

subdomain · string

The subdomain assigned to the preview deployment.

previewUrl · string

The URL where the preview deployment is accessible.