putty
API ReferenceEngine

Create a project

Creates a project from a pinned catalog template version. The template is not started here: the first `POST /projects/{id}/runs` is what materialises the sandbox. Pass a `brandKitId` to apply a brand kit from the start, or omit it to start from the template's defaults.

POST
/projects

Creates a project from a pinned catalog template version. The template is not started here: the first POST /projects/{id}/runs is what materialises the sandbox. Pass a brandKitId to apply a brand kit from the start, or omit it to start from the template's defaults.

Request Body

application/json

The project to create.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/projects" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "templateId": "string",    "templateVersion": "string"  }'
{  "id": "string",  "name": "string",  "templateId": "string",  "templateVersion": "string",  "sandboxId": "string",  "sandboxState": "none",  "brandKitId": "string",  "lastCheckpointId": "string",  "createdAt": "string",  "updatedAt": "string"}

List your projects GET

Returns the caller's projects, most recently active first. Soft-deleted projects are never included. Each entry carries the sandbox state and the last checkpoint id, so a dashboard can render the list without a follow-up request.

Read a project GET

Returns one project. A project owned by another user answers with the same 404 as a project that does not exist.