Skip to main content
POST
Publish a canvas page

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
conversation_id
string
required
artifact_id
string
required

The canvas artifact id, or a client-chosen id such as document- for a canvas extracted from a code fence.

title
string
required
language
enum<string>
required
Available options:
html,
svg,
markdown
content
string
required
Maximum string length: 200000
ttl_hours
integer | null
Required range: x >= 1

Response

The artifact was already published; its page was updated in place and kept its URL.

id
string<uuid>
required
slug
string
required
url
string
required
title
string
required
language
enum<string>
required
Available options:
html,
svg,
markdown
size_bytes
integer
required
status
enum<string>
required
Available options:
live,
unpublished,
taken_down
conversation_id
string
required
artifact_id
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
expires_at
string<date-time>
required