Skip to main content
GET
Get the promoted (production) version of a canvas

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Canvas id.

Response

The promoted version.

Full prompt version as returned by the version endpoints. message is the first message by index (normally the system prompt) and messages is the full ordered list. environments lists the environments the version is currently published to.

id
string<uuid>
required
promptId
string<uuid>
required
title
string
required
titleLocked
boolean
required

When true the title was set explicitly and is not auto-generated.

variables
object[]
required
configuration
object
required
workspaceId
string<uuid>
required
message
object | null
required
Example:
messages
object[]
required
createdBy
string
required
updatedBy
string
required
content
string | null
markdownContent
string | null
promoted
boolean | null

Legacy promotion flag. Prefer environments to know where a version is live.

draft
boolean | null
originVersionId
string<uuid> | null

Version this one was derived from through the lifecycle (edit/restore) operations.

workflowSpec
string | null

Serialized workflow specification for workflow versions.

graph
string | null

Serialized workflow graph for workflow versions.

isWorkflow
boolean | null
promptCustomTags
string[]

customTags of the parent canvas.

environments
object[]
deletedBy
string | null
createdAt
string<date-time> | null
updatedAt
string<date-time> | null
deletedAt
string<date-time> | null