curl --request POST \
--url https://api.moda.app/v1/canvases \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"width": 5000,
"height": 5000,
"page_count": 1,
"intent": "<string>",
"template_canvas_id": "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
"folder_id": "fld_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
"brand_kit_id": "bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
"idempotency_key": "<string>"
}
'import requests
url = "https://api.moda.app/v1/canvases"
payload = {
"name": "<string>",
"width": 5000,
"height": 5000,
"page_count": 1,
"intent": "<string>",
"template_canvas_id": "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
"folder_id": "fld_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
"brand_kit_id": "bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
"idempotency_key": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
width: 5000,
height: 5000,
page_count: 1,
intent: '<string>',
template_canvas_id: 'cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
folder_id: 'fld_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
brand_kit_id: 'bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
idempotency_key: '<string>'
})
};
fetch('https://api.moda.app/v1/canvases', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.moda.app/v1/canvases",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'width' => 5000,
'height' => 5000,
'page_count' => 1,
'intent' => '<string>',
'template_canvas_id' => 'cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
'folder_id' => 'fld_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
'brand_kit_id' => 'bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
'idempotency_key' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.moda.app/v1/canvases"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"width\": 5000,\n \"height\": 5000,\n \"page_count\": 1,\n \"intent\": \"<string>\",\n \"template_canvas_id\": \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n \"folder_id\": \"fld_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n \"brand_kit_id\": \"bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n \"idempotency_key\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.moda.app/v1/canvases")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"width\": 5000,\n \"height\": 5000,\n \"page_count\": 1,\n \"intent\": \"<string>\",\n \"template_canvas_id\": \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n \"folder_id\": \"fld_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n \"brand_kit_id\": \"bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n \"idempotency_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.moda.app/v1/canvases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"width\": 5000,\n \"height\": 5000,\n \"page_count\": 1,\n \"intent\": \"<string>\",\n \"template_canvas_id\": \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n \"folder_id\": \"fld_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n \"brand_kit_id\": \"bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n \"idempotency_key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}Create Canvas
Create a canvas — blank pages, or a one-call copy of a team template.
Returns page ids + editor URL + revision. With template_canvas_id set,
the new canvas is a full copy of that source canvas (every page, node, and
variable; description, category, and theme carried over; the source’s brand
kit kept — brand consistency is the point of team templates) instead of
blank pages — the same copy seam the in-app agent’s
create_canvas(mode="copy_canvas") uses. The copy never inherits the
source’s template flag, and name replaces the default copy naming.
Discover the team’s flagged templates (with thumbnails) via
GET /v1/templates. A missing, deleted, or cross-team source is a 404
not_found; a source whose collaboration state is still syncing is a
retryable 503 canvas_crdt_state_not_ready.
A blank create with category: "slides" and a brand_kit_id also
attaches that kit’s saved default slides theme — the layouts Add Slide
draws from. theme_canvas_id in the response is the canvas’s effective
theme on both lanes (null when unthemed); a kit with no usable theme still
creates, unthemed.
Honors idempotency_key through the shared pipeline: a retried create
replays the stored result instead of minting a second canvas; the same key
with a different payload is a 409 idempotency_conflict.
Create-specific key semantics (deliberate, documented on the field):
- Replay is CLIENT-KEY-ONLY. Without a key every call creates a new canvas; the server never derives a replay key from the payload (same-args creates from different sessions are distinct intents).
- A replayed create is UNMISTAKABLY loud:
replayed: trueplusreused_existing: true, the ORIGINALcreated_at, and a steeringnote— never a barecommitted— because the replayed canvas may have been authored since, and a caller that treats it as a fresh blank canvas would author over existing content. - A stored result whose canvas was DELETED since does not replay: the
stale record is invalidated and the create re-executes fresh (loud
stale_replay_invalidatedmarker), minting a NEW canvas.
curl --request POST \
--url https://api.moda.app/v1/canvases \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"width": 5000,
"height": 5000,
"page_count": 1,
"intent": "<string>",
"template_canvas_id": "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
"folder_id": "fld_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
"brand_kit_id": "bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
"idempotency_key": "<string>"
}
'import requests
url = "https://api.moda.app/v1/canvases"
payload = {
"name": "<string>",
"width": 5000,
"height": 5000,
"page_count": 1,
"intent": "<string>",
"template_canvas_id": "cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
"folder_id": "fld_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
"brand_kit_id": "bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
"idempotency_key": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
width: 5000,
height: 5000,
page_count: 1,
intent: '<string>',
template_canvas_id: 'cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
folder_id: 'fld_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
brand_kit_id: 'bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
idempotency_key: '<string>'
})
};
fetch('https://api.moda.app/v1/canvases', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.moda.app/v1/canvases",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'width' => 5000,
'height' => 5000,
'page_count' => 1,
'intent' => '<string>',
'template_canvas_id' => 'cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
'folder_id' => 'fld_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
'brand_kit_id' => 'bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV',
'idempotency_key' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.moda.app/v1/canvases"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"width\": 5000,\n \"height\": 5000,\n \"page_count\": 1,\n \"intent\": \"<string>\",\n \"template_canvas_id\": \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n \"folder_id\": \"fld_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n \"brand_kit_id\": \"bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n \"idempotency_key\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.moda.app/v1/canvases")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"width\": 5000,\n \"height\": 5000,\n \"page_count\": 1,\n \"intent\": \"<string>\",\n \"template_canvas_id\": \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n \"folder_id\": \"fld_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n \"brand_kit_id\": \"bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n \"idempotency_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.moda.app/v1/canvases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"width\": 5000,\n \"height\": 5000,\n \"page_count\": 1,\n \"intent\": \"<string>\",\n \"template_canvas_id\": \"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n \"folder_id\": \"fld_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n \"brand_kit_id\": \"bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV\",\n \"idempotency_key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}{
"type": "invalid_request",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"causes": [
"<unknown>"
],
"details": {},
"retry_after_ms": 123,
"retryable": true
}Authorizations
API key from Settings > Developer > REST API
Headers
Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.
2026-04-12, 2026-05-01 "2026-05-01"
Body
Canvas display name.
1 - 255Page width in px. Omit BOTH width and height to use the category's default size (see category); with no category either, pages default to 1920×1080.
0 < x <= 10000Page height in px. Omit BOTH width and height to use the category's default size.
0 < x <= 10000Number of blank pages.
1 <= x <= 100What you are about to build, in a few words — recorded on the canvas for the person you are handing it to, who otherwise opens an empty page with nothing to explain it. Collapsed to one line and clamped server-side; over-length truncates rather than failing the create. Mutually exclusive with template_canvas_id (a copy arrives with the source's content, so there is no empty page to explain).
2000Canvas category (slides, social, carousel, pdf, diagram, ui, animation, prints, web-ads, other). Drives slides/motion semantics, export defaults, and — when width/height are both omitted — the page size, matching the in-app format picker: slides → 960×540, social → 1080×1080, carousel → 1080×1350, pdf → 816×1056, animation → 1920×1080, prints → 816×1056, web-ads → 300×250, diagram/ui/other → 1080×1080. Explicit width/height always win. Omit to let the server infer. To change an existing canvas's size, resize it in place (normal and supported: group the page's nodes, set the new page size, scale uniformly via the edit lane) — creating a new canvas is not the way to change size.
slides, social, carousel, pdf, diagram, ui, animation, prints, web-ads, other Prefixed cvs_ wire ID (Crockford base32 body) — the canonical, recommended form. For back-compat, a bare UUID string is also accepted in both path parameters and JSON request bodies (older integrations that stored raw UUIDs keep working), as is the prefix over a UUID body (cvs_00000000-0000-4000-8000-000000000000). All three are permanent, supported inputs; only the canonical form is ever emitted.
^cvs_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$"cvs_01HT9WK8N3M2J4A5Z6P7Q8R9TV"
Prefixed fld_ wire ID (Crockford base32 body) — the canonical, recommended form. For back-compat, a bare UUID string is also accepted in both path parameters and JSON request bodies (older integrations that stored raw UUIDs keep working), as is the prefix over a UUID body (fld_00000000-0000-4000-8000-000000000000). All three are permanent, supported inputs; only the canonical form is ever emitted.
^fld_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$"fld_01HT9WK8N3M2J4A5Z6P7Q8R9TV"
Explicit visibility for the new canvas: private hides it from teammates; team makes it visible to the whole team. Ignored in favor of the folder's visibility when folder_id is set. Omit for the workspace default.
team, private Prefixed bk_ wire ID (Crockford base32 body) — the canonical, recommended form. For back-compat, a bare UUID string is also accepted in both path parameters and JSON request bodies (older integrations that stored raw UUIDs keep working), as is the prefix over a UUID body (bk_00000000-0000-4000-8000-000000000000). All three are permanent, supported inputs; only the canonical form is ever emitted.
^bk_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$"bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV"
A retried create with the same key replays the stored result (replayed:true + reused_existing:true + the original created_at) instead of creating a second canvas. Replay is CLIENT-KEY-ONLY: omit the key and every call creates a NEW canvas — the server never derives a key from the payload. Never derive this key from the payload yourself (e.g. a hash of name+dimensions): same-args creates are legitimately distinct intents, and a payload-derived key reused from a later session returns the ORIGINAL (possibly authored) canvas instead of a new one. Use a fresh random key per intended create; reuse it only to retry that same create.
200Response
Successful Response
The response is of type Response Canvasactionscreate · object.