projects

Create a project

Create a stateful editing project from a RenderRequest, or empty. Elements without an id are assigned one so ops can address them. Returns the full project at version 1, plus an ADVISORY ok + violations[] lint of the seed composition — a project is allowed to hold an invalid head while you repair it with ops, so findings never block the 201.

Pass source_project_id instead of a request to copy a project: your own project or template, or a published template from GET /v1/templates. That one call duplicates a project, saves one as a template (kind: template) and starts a project from a template; source_kind records which it was.

post/v1/projects

Request

  • Base URL: https://api.framelane.io
  • URL: https://api.framelane.io/v1/projects
  • Auth: HTTP bearer

Request body

namestring nullable

Display name. Defaults to 'Untitled project', or for a copy to 'Copy of {source}' (same kind), '{source} Template' (a project saved as a template) or the template's name without ' Template' (a project made from a template).

source_project_idstring nullable

Copy this project's head into version 1 of the new one: your own project or template, or a published template from GET /v1/templates. Element ids are kept. Not together with render_request.

kind'project' | 'template'

template creates a template (a project used as a copy source).

author'user' | 'agent'

Who authored a version -- the human owner or an agent acting on their behalf.

Response

Successful Response

idstring required

Unique project id.

namestring required

Display name.

versioninteger required

Head version. Bumped on every applied ops batch.

workspace_idstring required

Owning workspace id.

editor_urlstring required

Open this project in the authenticated console.

kind'project' | 'template'

project, or template: a project used as a copy source.

source_project_idstring nullable

The project or template this one was copied from.

source_kind'project' | 'template' | 'public_template' nullable

What the source was: project (a duplicate), template (one of your templates) or public_template (a published template from the gallery).

thumbnail_urlstring nullable

A poster image of the head; null until one is generated.

thumbnail_versioninteger nullable

The head version the thumbnail shows. It is stale while this is below version.

created_atstring date-time required
updated_atstring date-time required
okboolean required

Advisory — the project was still created and stored at version 1. False means the seed composition has error-severity findings; a project is allowed to hold an invalid head while you repair it with ops.

Changes

No recorded changes to this operation across all 1 revision of this API.