canvases

Stage a complete source project as a draft version and build it, without publishing.

The draft gets the same validation, versioning, and server-side build as a publish, but the canvas's head and live build never move, so nothing changes for viewers. Promote the version with promote to make it live. The response reports how the draft's declared capabilities widen the current head's, so growth in access can be reviewed before it ships. No version guard applies: a draft conflicts with nothing.

post/api/projects/{project_id}/canvases/{id}/draft/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/canvases/{id}/draft/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this canvas.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

promptstring

Short description of the change, stored on the draft's version history entry.

Response

version_idstring required

Id of the draft source version this request created.

Changes

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