suitcaseProjects

The Projects API allows you to manage the high-level containers for all project artifacts. A project contains the original prompt, AI-generated summary, and acts as the parent for personas, features, and other assets.

The Project Object

Field
Type
Description

id

UUID

Unique identifier for the project.

name

string

The name of the project.

original_prompt

string

The initial prompt used to create the project.

current_prompt

string

The current version of the project prompt.

model

string

The AI model ID used for generation (e.g., gpt-4o).

status

string

One of draft, active, archived.

app_architecture_prefs

array

List of selected technical preferences (e.g., Next.js, Supabase).

created_at

string

ISO 8601 timestamp of creation.

updated_at

string

ISO 8601 timestamp of last update.

List Projects

GET /crud/projects

Retrieve a paginated list of your projects.

Query Parameters

Parameter
Type
Default
Description

limit

integer

100

Number of records to return.

offset

integer

0

Number of records to skip.

status

string

-

Filter by status (draft, active, archived).

search

string

-

Search term for project name or description.

Example Request

Get a Project

GET /crud/projects?id={projectId}

Retrieve details for a specific project.

Query Parameters

Parameter
Type
Description

id

UUID

Required. The unique ID of the project.

includeAnalysis

boolean

If true, returns associated features, personas, and schema summary in an analysis field.

Example Request

Create a Project

POST /crud/projects

Create a new project.

Request Body

Example Request

Update a Project

PUT /crud/projects?id={projectId}

Update an existing project.

Example Request

Delete a Project

DELETE /crud/projects?id={projectId}

Delete a specific project and all its associated artifacts.

Example Request

Batch Operations

The Projects API supports batch creation, updates, and deletions.

Batch Create

POST /crud/projects

Batch Update

PUT /crud/projects

Batch Delete

DELETE /crud/projects

Last updated

Was this helpful?