Skip to main content
GET
/
projects
/
{id}
/
web
Get web deployment information of project
curl --request GET \
  --url https://api.workser.ai/projects/{id}/web \
  --header 'x-api-key: <api-key>'
{
  "project_id": "550e8400-e29b-41d4-a716-446655440000",
  "preview_url": "https://my-project.workser.app",
  "production_url": "my-app.workser.app",
  "deployment_status": "READY",
  "deployment_ready_status": "READY",
  "deployment_error_logs": "Error: Failed to build the project",
  "deployment_done_at": "2024-01-15T12:00:00.000Z",
  "latest_task_status": "completed"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Path Parameters

​
id
string
required

Project ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Web deployment information retrieved successfully

​
project_id
string
required

Project ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
preview_url
string

Preview URL

Example:

"https://my-project.workser.app"

​
production_url
string

Production URL: coming soon when we imlpement 2 environments.

Example:

"my-app.workser.app"

​
deployment_status
enum<string>

Deployment status

Available options:
success,
failed
Example:

"READY"

​
deployment_ready_status
enum<string>

Deployment ready status

Available options:
BUILDING,
READY,
ERROR,
QUEUED,
CANCELED
Example:

"READY"

​
deployment_error_logs
string

Deployment error logs

Example:

"Error: Failed to build the project"

​
deployment_done_at
string<date-time>

Deployment completion timestamp

Example:

"2024-01-15T12:00:00.000Z"

​
latest_task_status
string

Latest task status

Example:

"completed"