API Reference
Deployments
Deploy, rollback, check status, and manage project deployments.
Deployment API
Manage deployments for your projects.
Deploy / Redeploy
POST /api/v1/projects/{projectId}/deployRequest Body (optional):
{ "startOver": false }Triggers a new deployment. For failed deployments, the system automatically retries from the failed step. Set startOver: true to skip retry detection and run the full pipeline from scratch.
Response:
{
"data": {
"id": "deployment-uuid",
"version": 3,
"status": "queued",
"isRetry": false,
"queuePriority": 2
}
}Check Deployment Status
GET /api/v1/projects/{projectId}/statusReturns real-time deployment progress. Poll this endpoint to track deployment status.
{
"data": {
"step": 3,
"totalSteps": 6,
"status": "in_progress",
"message": "Building your app...",
"progress": 50
}
}Possible statuses: queued, in_progress, completed, failed, cancelled
Rollback
POST /api/v1/projects/{projectId}/rollback{ "targetDeploymentId": "deployment-uuid" }Reverts a project to a previous successful deployment. The target deployment must have a status of completed.
Cancel Deployment
POST /api/v1/projects/{projectId}/cancelCancels an in-progress deployment and resets the project to draft status. Only works when the project status is queued, generating, or deploying.
Reactivate Project
POST /api/v1/projects/{projectId}/reactivateReactivates a suspended project by creating a fresh deployment from the preserved code repository. Costs 1 credit.