Publish a canvas page

Publishes a chat canvas artifact at a public address on the pages host. The content is sent explicitly, so edited canvases publish as shown. Only html, svg and markdown can be published. The page is a static snapshot served in a sandbox, with a fixed notice naming it as an AI-generated page. Publishing the same conversation_id and artifact_id again keeps the URL and extends the expiry. A durable canvas is published with canvas_id and revision_id instead: it has one publication whichever revision is published, the canvas’s published_revision_id follows it, and a json dashboard revision is published as the html snapshot sent in content. Who may publish is the organisation’s public_canvas_publishing setting (admins by default, members, or disabled); tightening it leaves live pages up. ttl_hours defaults to 168 and is capped at 720.

POST /api/v1/org/canvas-publications

Publish a canvas page

Python

import requests

url = "https://platform.ankra.app/api/v1/org/canvas-publications"

payload = {
    "conversation_id": "<string>",
    "artifact_id": "<string>",
    "title": "<string>",
    "content": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "url": "<string>",
  "title": "<string>",
  "language": "html",
  "size_bytes": 123,
  "status": "live",
  "conversation_id": "<string>",
  "artifact_id": "<string>",
  "canvas_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "interactive": true
}

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

PublishCanvasArtifactRequest

PublishCanvasRevisionRequest

Either a chat artifact publish (conversation_id and artifact_id) or a durable canvas publish (canvas_id and revision_id), never both.

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

interactive · boolean | null

Opts the page into running its scripts under the interactive sandbox policy (inline scripts only, no eval, no network, opaque origin). Accepted only when the published language is html; any other language answers 400 invalid_request. Omitted or null publishes a static page, also on a republish.

Response

200

application/json

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 | null · required

The conversation a chat artifact publication came from; null on a canvas publication.

artifact_id · string | null · required

The chat artifact published; null on a canvas publication.

canvas_id · string<uuid> | null · required

The durable canvas published; null on a chat artifact publication.

revision_id · string<uuid> | null · required

The canvas revision the page was published from (for a json dashboard revision, the revision its html snapshot was rendered from); null on a chat artifact publication.

created_at · string<date-time> · required

updated_at · string<date-time> · required

expires_at · string<date-time> · required

interactive · boolean · required

True when the page runs its scripts under the interactive sandbox policy; false for a static page and for a legacy row.