List projects

GET /v1/projects

Returns all projects in your account.

Response:

{
  "data": [
    {
      "id": "proj_abc123",
      "name": "Clinic Booking System",
      "status": "live",
      "url": "https://clinic-booking.orchpad.app",
      "created_at": "2026-05-01T10:00:00Z"
    }
  ]
}

Create project

POST /v1/projects

Creates a new project and starts the build process.

Request body:

{
  "name": "My Project",
  "description": "A booking system for a physiotherapy clinic. Patients can see available slots and book appointments."
}

Response:

{
  "data": {
    "id": "proj_abc123",
    "name": "My Project",
    "status": "building",
    "created_at": "2026-05-29T12:00:00Z"
  }
}

Get project

GET /v1/projects/:id

Returns a single project by ID including current status and live URL (if deployed).

Response:

{
  "data": {
    "id": "proj_abc123",
    "name": "My Project",
    "status": "live",
    "url": "https://my-project.orchpad.app",
    "created_at": "2026-05-29T12:00:00Z",
    "deployed_at": "2026-05-29T12:34:00Z"
  }
}

Trigger deployment

POST /v1/projects/:id/deploy

Triggers a deployment for a project in review status. The project must have a completed build before it can be deployed.

Response:

{
  "data": {
    "id": "proj_abc123",
    "status": "deploying"
  }
}

Project status values