Skip to main content
POST
Create a canvas

Authorizations

Authorization
string
header
required

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

Headers

authorization
string | null
x-ankra-organisation-id
string | null

Body

application/json
kind
enum<string>
required
Available options:
dashboard,
page
title
string
required
Required string length: 1 - 200
language
enum<string>
required
Available options:
json,
html,
svg,
markdown
content
string
required
Maximum string length: 524288
source_conversation_id
string | null
Maximum string length: 128
source_artifact_id
string | null
Maximum string length: 128

Response

The chat artifact was already saved; its canvas is returned unchanged.

A canvas with its draft revision.

id
string<uuid>
required
kind
enum<string>
required
Available options:
dashboard,
page
title
string
required
visibility
enum<string>
required
Available options:
private,
organisation
owner_user_id
string<uuid>
required
is_owner
boolean
required
is_pinned
boolean
required

Whether the caller pinned the canvas.

language
enum<string>
required

The language of the draft revision.

Available options:
json,
html,
svg,
markdown
draft_revision_id
string | null
required
published_revision_id
string | null
required
source_conversation_id
string | null
required
source_artifact_id
string | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
draft
CanvasRevision · object
required