Projects API
Manage Bootspring projects.
Endpoints#
| Method | Endpoint | Description |
|---|---|---|
GET | /projects | List all projects |
POST | /projects | Create a project |
GET | /projects/:id | Get a project |
PATCH | /projects/:id | Update a project |
DELETE | /projects/:id | Delete a project |
Project Object#
Loading code block...
List Projects#
Loading code block...
Query Parameters#
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number (default: 1) |
per_page | integer | Items per page (default: 20, max: 100) |
status | string | Filter by status: active, archived |
sort | string | Sort field: name, created_at, updated_at |
order | string | Sort order: asc, desc |
Example Request#
Loading code block...
Response#
Loading code block...
Create Project#
Loading code block...
Request Body#
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Project name (2-100 chars) |
description | string | No | Project description |
type | string | No | Project type (default: web) |
framework | string | No | Framework (e.g., nextjs, react) |
settings | object | No | Project settings |
Example Request#
Loading code block...
Response#
Loading code block...
Get Project#
Loading code block...
Example Request#
Loading code block...
Response#
Returns the full project object.
Update Project#
Loading code block...
Request Body#
All fields are optional. Only include fields you want to update.
| Field | Type | Description |
|---|---|---|
name | string | Project name |
description | string | Project description |
status | string | Status: active, archived |
settings | object | Project settings (merged) |
Example Request#
Loading code block...
Response#
Returns the updated project object.
Delete Project#
Loading code block...
Example Request#
Loading code block...
Response#
Loading code block...
Project Settings#
Available Settings#
| Setting | Type | Default | Description |
|---|---|---|---|
autoGenerateContext | boolean | true | Auto-generate CLAUDE.md |
defaultAgent | string | null | Default agent for invocations |
qualityGates | array | [] | Enabled quality gates |
notifications | object | {} | Notification preferences |
Example Settings#
Loading code block...
Project Types#
| Type | Description |
|---|---|
web | Web application |
api | API/Backend service |
mobile | Mobile application |
cli | Command-line tool |
library | Library/Package |
Frameworks#
| Framework | Description |
|---|---|
nextjs | Next.js |
react | React |
vue | Vue.js |
svelte | SvelteKit |
express | Express.js |
fastapi | FastAPI |
django | Django |
rails | Ruby on Rails |
Errors#
| Code | Description |
|---|---|
project_not_found | Project doesn't exist |
project_limit_exceeded | Plan project limit reached |
slug_taken | Project slug already exists |
invalid_framework | Unknown framework |