canvases

Canvases: agent-built sandboxed browser apps, filed into channels.

Source is versioned per publish and built server-side; the canvas app renders the published build's artifact from the isolated artifact origin.

get/api/projects/{project_id}/canvases/{id}/state/value/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/canvases/{id}/state/value/
  • 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/.

Query parameters

keystring required

Exact key to read.

limitinteger

Maximum JSON characters in this response.

offsetinteger

Character offset from next_offset.

revisionstring

Revision from the first chunk. Required when offset is greater than zero.

scope'user' | 'shared' required

Scope of the value to read.

  • user - user
  • shared - shared

Response

scope'user' | 'shared' required
  • user - user
  • shared - shared
keystring required

Key of this value.

value_jsonstring required

A chunk of JSON text. Join all chunks in order, then parse the complete JSON.

revisionstring required

Content revision. Pass it on subsequent reads; a changed value returns 409.

offsetinteger required

Character offset of this chunk.

total_lengthinteger required

Character length of the complete JSON text.

next_offsetinteger nullable required

Next character offset, or null when complete.

completeboolean required

True when no further chunks remain. Earlier chunks are still needed when offset is nonzero.

Changes

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