Skip to main content
GET
Get 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

Response

The canvas.

id
string<uuid>
required
title
string
required
Maximum string length: 256
projectId
string<uuid> | null
required

Project the canvas belongs to. null for the caller's personal drafts.

inferencesPercentage
string
required

Share of live inferences sampled for review, as a decimal string (for example "0.10").

layoutVersion
string
required

Editor layout version (v1 or v2).

workspaceId
string<uuid>
required
customTags
string[]
required
createdBy
string
required
updatedBy
string
required
allowedCredentials
string[] | null

Credential ids the canvas may use. null means unrestricted.

deletedBy
string | null
createdAt
string<date-time> | null
updatedAt
string<date-time> | null
deletedAt
string<date-time> | null
favorited
boolean

Whether the calling user favorited the canvas. Only present when the token carries a user identity.

promotedVersion
object | null

Production version. Only present when includePromotedVersion=true; null when the canvas has no production or promoted version.

latestVersion
object | null

Most recently created version. Only present when includePromotedVersion=true; null when the canvas has no versions.