Public Projects
apiKeyx-api-key<token>cursor?stringPagination cursor from a previous response.
limit?integerMaximum number of projects to return.
1 <= value <= 10020Projects fetched successfully.
application/json- response
projects*array<>nextCursor*|nullhasMore*booleanfalsecurl -X GET "https://example.com/api/public/v1/projects"{ "projects": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pid": "string", "name": "string", "theme": "default", "artifactType": "deck", "brandingId": null, "pageLayersScrollable": true, "pageAspectRatio": "16:9", "pageGridEnabled": false, "pageGridType": "12-column", "pageNumbersEnabled": false, "footerText": null, "footerDate": null, "footerHideOnCover": true, "footerShowPageTotal": false, "footerFontSizePt": 9, "presentTextExit": true, "presentMotionSpeed": "quick", "linkShareToken": "string", "linkAccess": "tenant", "linkRole": "owner", "publishSlug": null, "isPublished": false, "publishedAt": null, "ogImageUrl": null, "publishDescription": null, "showMadeWithEncelade": false, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "pinnedAt": null, "proposalExpiresAt": null, "proposalStatus": "draft", "firstPageId": "2f8ddfb6-97dc-4f88-8a30-be55455ab046", "members": [ { "id": "string", "userId": "string", "name": "string", "email": "string", "avatar": "string", "role": { "id": "owner", "name": "string" } } ], "tags": [], "viewerUrl": null, "embedUrl": null } ], "nextCursor": null, "hasMore": false}apiKeyx-api-key<token>pid*stringProject fetched successfully.
application/json- response
id*string^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidpid*stringtenantId*string^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidname*stringtheme*|"default"artifactType*stringDocument type. One-pagers target one portrait sheet; whole-document generation may emit a second editable sheet when required for readable content. Single-page generation never emits a continuation.
"deck""deck""proposal""one_pager"themeDefinitionSnapshot?|nullbrandingId*|^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidnullpageLayersScrollable*booleantruepageAspectRatio*string"16:9""16:9""3:2""fluid""a4-portrait""letter-portrait"pageGridEnabled*booleanfalsepageGridType*string"12-column""12-column""6x4"pageNumbersEnabled*booleanfalsefooterText*|nullfooterDate*|nullfooterHideOnCover*booleantruefooterShowPageTotal*booleanfalsefooterFontSizePt*integer8 <= value <= 209presentTextExit*booleantruepresentMotionSpeed*string"normal""quick""normal""slow"linkShareToken*string|nulllinkAccess*string"tenant""tenant""anyone"linkRole*string"viewer""owner""editor""content_editor""viewer"publishSlug*|nullisPublished*booleanfalsepublishedAt*|^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$date-timenullogImageUrl*|nullpublishDescription*|nullshowMadeWithEncelade*booleanfalsesharePasswordSet*booleanfalsecreatedAt*string^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$date-timeupdatedAt*string^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$date-timepinnedAt*|^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$date-timenullproposalExpiresAt*|^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$date-timenullproposalTrackViews*booleanfalsebackgroundPresets*array<>items <= 100[]pages*array<>members*array<>tags*array<>[]viewerUrl*|Public viewer link; null unless the project is published.
nullembedUrl*|Iframe embed link; null unless the project is published.
nullcurl -X GET "https://example.com/api/public/v1/projects/string"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pid": "string", "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0", "name": "string", "theme": "default", "artifactType": "deck", "themeDefinitionSnapshot": { "surface": "string", "panel": "string", "card": "string", "border": "string", "accent": "string", "accentMuted": "string", "text": "string", "mutedText": "string", "fontFamily": "string", "fontWeight": 1, "headingFontFamily": "string", "headingFontWeight": 1, "typeVoice": "neutral", "typeVoiceOverrides": { "display": { "sizePt": 1, "weight": 1, "trackingEm": 0, "lineHeight": 1 }, "h1": { "sizePt": 1, "weight": 1, "trackingEm": 0, "lineHeight": 1 }, "h2": { "sizePt": 1, "weight": 1, "trackingEm": 0, "lineHeight": 1 }, "h3": { "sizePt": 1, "weight": 1, "trackingEm": 0, "lineHeight": 1 }, "eyebrow": { "sizePt": 1, "weight": 1, "trackingEm": 0, "face": "body", "case": "typed", "style": "italic", "rule": true }, "label": { "face": "body", "weight": 1, "trackingEm": 0 }, "headingStyle": "italic", "headingCase": "upper", "caseByLevel": { "display": "upper", "h1": "upper", "h2": "upper", "h3": "upper" }, "faceByLevel": { "display": "body", "h1": "body", "h2": "body", "h3": "body" }, "styleByLevel": { "display": "italic", "h1": "italic", "h2": "italic", "h3": "italic" } }, "coverTitleFace": "heading", "highlightStyle": "accent", "pageBackground": [], "layerBackground": { "type": "color", "value": "string", "tint": "string", "dissolveSettings": { "colors": [ "#d91f26", "#0a0a0a" ], "angle": 90, "fade": 0.35, "noiseOpacity": 0.45, "noiseScale": 1.6, "gradient": "string" } }, "layerBorder": { "radius": 0, "width": 0, "type": "color", "value": "string", "side": "all", "sideWidths": { "property1": 0, "property2": 0 } }, "layerShadow": "drop-shadow-none", "headerLayerBackground": { "type": "color", "value": "string", "tint": "string", "dissolveSettings": { "colors": [ "#d91f26", "#0a0a0a" ], "angle": 90, "fade": 0.35, "noiseOpacity": 0.45, "noiseScale": 1.6, "gradient": "string" } }, "headerLayerBorder": { "radius": 0, "width": 0, "type": "color", "value": "string", "side": "all", "sideWidths": { "property1": 0, "property2": 0 } }, "cardLayerBackground": { "type": "color", "value": "string", "tint": "string", "dissolveSettings": { "colors": [ "#d91f26", "#0a0a0a" ], "angle": 90, "fade": 0.35, "noiseOpacity": 0.45, "noiseScale": 1.6, "gradient": "string" } }, "chartColors": [ "string" ], "backgroundVariants": [ { "id": "string", "name": "string", "layers": [] } ], "contrast": { "surface": "string", "panel": "string", "card": "string", "border": "string", "accent": "string", "text": "string", "mutedText": "string", "pageBackground": [], "chartColors": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "coverPageBackground": [ { "id": "string", "kind": "string", "color": "string", "animatedGradient": { "colors": [ "string" ], "angle": 0, "duration": 0, "animation": "string" }, "settings": { "property1": null, "property2": null }, "opacity": 0, "blendMode": "normal", "rect": { "x": 0, "y": 0, "width": 0, "height": 0 }, "hidden": true, "posterUrl": "string", "posterSourceUrl": "string", "sourceImageUrl": "string", "mediaPrompt": "string", "mediaProvider": "string", "mediaAttribution": { "title": "string", "author": "string", "authorUrl": "string", "sourceUrl": "string" } } ], "coverHidesLogo": true }, "fonts": [ { "id": "string", "label": "string", "family": "string", "url": "http://example.com", "mimeType": "string", "sizeBytes": 0, "assetId": "string", "storageKey": "string", "weight": 0, "style": "string" } ], "logo": { "url": "http://example.com", "assetId": "string", "widthPercent": 3, "position": "top-left", "contrast": { "url": "http://example.com", "assetId": "string" }, "titlePage": { "url": "http://example.com", "assetId": "string", "contrast": { "url": "http://example.com", "assetId": "string" } }, "otherPages": { "url": "http://example.com", "assetId": "string", "contrast": { "url": "http://example.com", "assetId": "string" } }, "clearSpace": 0 }, "footer": { "text": "string", "showPageNumbers": true, "hideOnCover": true, "showPageTotal": true, "fontSizePt": 8 }, "pageMargins": { "left": 0, "top": 0, "right": 0, "bottom": 0 } }, "brandingId": null, "pageLayersScrollable": true, "pageAspectRatio": "16:9", "pageGridEnabled": false, "pageGridType": "12-column", "pageNumbersEnabled": false, "footerText": null, "footerDate": null, "footerHideOnCover": true, "footerShowPageTotal": false, "footerFontSizePt": 9, "presentTextExit": true, "presentMotionSpeed": "quick", "linkShareToken": "string", "linkAccess": "tenant", "linkRole": "owner", "publishSlug": null, "isPublished": false, "publishedAt": null, "ogImageUrl": null, "publishDescription": null, "showMadeWithEncelade": false, "sharePasswordSet": false, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "pinnedAt": null, "proposalExpiresAt": null, "proposalTrackViews": false, "backgroundPresets": [], "pages": [ { "pageBackground": [], "presentModeAnimation": "none", "currentSelectedLayerId": null, "currentSelectedLayerType": null, "speakerNotes": "", "watermarkEnabled": false, "watermarkText": "", "watermarkShowOnAllPages": false, "layout": [], "isPageLayoutLocked": false, "hide": false, "contrast": false, "contrastSet": 1, "footerText": "string", "layerVisibilityDefaults": null, "showLayoutBounds": true, "fluidLayout": null, "narrativeBeat": "setup", "layoutId": "string", "transition": null, "scene": { "id": "string", "camera": { "x": 0, "y": 0, "zoom": 1 }, "tokens": { "surface": "string", "ink": "string", "accent": "string", "material": "dark-glass", "from": "string" }, "bridge": "settle" }, "generationContent": null, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "slug": "string", "position": 0 } ], "members": [ { "id": "string", "userId": "string", "name": "string", "email": "string", "avatar": "string", "role": { "id": "owner", "name": "string" } } ], "tags": [], "viewerUrl": null, "embedUrl": null}apiKeyx-api-key<token>pid*stringapplication/json- body
name?string1 <= length <= 255theme?|themeDefinitionSnapshot?|nullbrandingId?|^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidpageLayersScrollable?booleanpageAspectRatio?string"16:9""3:2""fluid""a4-portrait""letter-portrait"pageGridEnabled?booleanpageGridType?string"12-column""6x4"pageNumbersEnabled?booleanfooterText?|length <= 120footerDate?|length <= 32footerHideOnCover?booleanfooterShowPageTotal?booleanfooterFontSizePt?integer8 <= value <= 20presentTextExit?booleanpresentMotionSpeed?string"quick""normal""slow"publishDescription?|length <= 500showMadeWithEncelade?booleanproposalExpiresAt?|When the proposal expires. After this time the published link shows that it has expired and it can no longer be accepted. null removes the expiry. Only takes effect on proposals. Setting or changing it needs a plan with proposal tracking (feature_locked otherwise).
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$date-timeproposalTrackViews?booleanEmails the project owners when someone opens the published proposal. Only takes effect on proposals. Turning it on needs a plan with proposal tracking (feature_locked otherwise); turning it off is always allowed.
backgroundPresets?array<>items <= 100pages?array<>members?array<>Project updated successfully.
application/json- response
id*string^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidpid*stringtenantId*string^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidname*stringtheme*|"default"artifactType*stringDocument type. One-pagers target one portrait sheet; whole-document generation may emit a second editable sheet when required for readable content. Single-page generation never emits a continuation.
"deck""deck""proposal""one_pager"themeDefinitionSnapshot?|nullbrandingId*|^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidnullpageLayersScrollable*booleantruepageAspectRatio*string"16:9""16:9""3:2""fluid""a4-portrait""letter-portrait"pageGridEnabled*booleanfalsepageGridType*string"12-column""12-column""6x4"pageNumbersEnabled*booleanfalsefooterText*|nullfooterDate*|nullfooterHideOnCover*booleantruefooterShowPageTotal*booleanfalsefooterFontSizePt*integer8 <= value <= 209presentTextExit*booleantruepresentMotionSpeed*string"normal""quick""normal""slow"linkShareToken*string|nulllinkAccess*string"tenant""tenant""anyone"linkRole*string"viewer""owner""editor""content_editor""viewer"publishSlug*|nullisPublished*booleanfalsepublishedAt*|^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$date-timenullogImageUrl*|nullpublishDescription*|nullshowMadeWithEncelade*booleanfalsesharePasswordSet*booleanfalsecreatedAt*string^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$date-timeupdatedAt*string^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$date-timepinnedAt*|^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$date-timenullproposalExpiresAt*|^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$date-timenullproposalTrackViews*booleanfalsebackgroundPresets*array<>items <= 100[]pages*array<>members*array<>tags*array<>[]viewerUrl*|Public viewer link; null unless the project is published.
nullembedUrl*|Iframe embed link; null unless the project is published.
nullcurl -X PATCH "https://example.com/api/public/v1/projects/string" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pid": "string", "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0", "name": "string", "theme": "default", "artifactType": "deck", "themeDefinitionSnapshot": { "surface": "string", "panel": "string", "card": "string", "border": "string", "accent": "string", "accentMuted": "string", "text": "string", "mutedText": "string", "fontFamily": "string", "fontWeight": 1, "headingFontFamily": "string", "headingFontWeight": 1, "typeVoice": "neutral", "typeVoiceOverrides": { "display": { "sizePt": 1, "weight": 1, "trackingEm": 0, "lineHeight": 1 }, "h1": { "sizePt": 1, "weight": 1, "trackingEm": 0, "lineHeight": 1 }, "h2": { "sizePt": 1, "weight": 1, "trackingEm": 0, "lineHeight": 1 }, "h3": { "sizePt": 1, "weight": 1, "trackingEm": 0, "lineHeight": 1 }, "eyebrow": { "sizePt": 1, "weight": 1, "trackingEm": 0, "face": "body", "case": "typed", "style": "italic", "rule": true }, "label": { "face": "body", "weight": 1, "trackingEm": 0 }, "headingStyle": "italic", "headingCase": "upper", "caseByLevel": { "display": "upper", "h1": "upper", "h2": "upper", "h3": "upper" }, "faceByLevel": { "display": "body", "h1": "body", "h2": "body", "h3": "body" }, "styleByLevel": { "display": "italic", "h1": "italic", "h2": "italic", "h3": "italic" } }, "coverTitleFace": "heading", "highlightStyle": "accent", "pageBackground": [], "layerBackground": { "type": "color", "value": "string", "tint": "string", "dissolveSettings": { "colors": [ "#d91f26", "#0a0a0a" ], "angle": 90, "fade": 0.35, "noiseOpacity": 0.45, "noiseScale": 1.6, "gradient": "string" } }, "layerBorder": { "radius": 0, "width": 0, "type": "color", "value": "string", "side": "all", "sideWidths": { "property1": 0, "property2": 0 } }, "layerShadow": "drop-shadow-none", "headerLayerBackground": { "type": "color", "value": "string", "tint": "string", "dissolveSettings": { "colors": [ "#d91f26", "#0a0a0a" ], "angle": 90, "fade": 0.35, "noiseOpacity": 0.45, "noiseScale": 1.6, "gradient": "string" } }, "headerLayerBorder": { "radius": 0, "width": 0, "type": "color", "value": "string", "side": "all", "sideWidths": { "property1": 0, "property2": 0 } }, "cardLayerBackground": { "type": "color", "value": "string", "tint": "string", "dissolveSettings": { "colors": [ "#d91f26", "#0a0a0a" ], "angle": 90, "fade": 0.35, "noiseOpacity": 0.45, "noiseScale": 1.6, "gradient": "string" } }, "chartColors": [ "string" ], "backgroundVariants": [ { "id": "string", "name": "string", "layers": [] } ], "contrast": { "surface": "string", "panel": "string", "card": "string", "border": "string", "accent": "string", "text": "string", "mutedText": "string", "pageBackground": [], "chartColors": [ "string", "string", "string", "string", "string", "string", "string", "string" ], "coverPageBackground": [ { "id": "string", "kind": "string", "color": "string", "animatedGradient": { "colors": [ "string" ], "angle": 0, "duration": 0, "animation": "string" }, "settings": { "property1": null, "property2": null }, "opacity": 0, "blendMode": "normal", "rect": { "x": 0, "y": 0, "width": 0, "height": 0 }, "hidden": true, "posterUrl": "string", "posterSourceUrl": "string", "sourceImageUrl": "string", "mediaPrompt": "string", "mediaProvider": "string", "mediaAttribution": { "title": "string", "author": "string", "authorUrl": "string", "sourceUrl": "string" } } ], "coverHidesLogo": true }, "fonts": [ { "id": "string", "label": "string", "family": "string", "url": "http://example.com", "mimeType": "string", "sizeBytes": 0, "assetId": "string", "storageKey": "string", "weight": 0, "style": "string" } ], "logo": { "url": "http://example.com", "assetId": "string", "widthPercent": 3, "position": "top-left", "contrast": { "url": "http://example.com", "assetId": "string" }, "titlePage": { "url": "http://example.com", "assetId": "string", "contrast": { "url": "http://example.com", "assetId": "string" } }, "otherPages": { "url": "http://example.com", "assetId": "string", "contrast": { "url": "http://example.com", "assetId": "string" } }, "clearSpace": 0 }, "footer": { "text": "string", "showPageNumbers": true, "hideOnCover": true, "showPageTotal": true, "fontSizePt": 8 }, "pageMargins": { "left": 0, "top": 0, "right": 0, "bottom": 0 } }, "brandingId": null, "pageLayersScrollable": true, "pageAspectRatio": "16:9", "pageGridEnabled": false, "pageGridType": "12-column", "pageNumbersEnabled": false, "footerText": null, "footerDate": null, "footerHideOnCover": true, "footerShowPageTotal": false, "footerFontSizePt": 9, "presentTextExit": true, "presentMotionSpeed": "quick", "linkShareToken": "string", "linkAccess": "tenant", "linkRole": "owner", "publishSlug": null, "isPublished": false, "publishedAt": null, "ogImageUrl": null, "publishDescription": null, "showMadeWithEncelade": false, "sharePasswordSet": false, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "pinnedAt": null, "proposalExpiresAt": null, "proposalTrackViews": false, "backgroundPresets": [], "pages": [ { "pageBackground": [], "presentModeAnimation": "none", "currentSelectedLayerId": null, "currentSelectedLayerType": null, "speakerNotes": "", "watermarkEnabled": false, "watermarkText": "", "watermarkShowOnAllPages": false, "layout": [], "isPageLayoutLocked": false, "hide": false, "contrast": false, "contrastSet": 1, "footerText": "string", "layerVisibilityDefaults": null, "showLayoutBounds": true, "fluidLayout": null, "narrativeBeat": "setup", "layoutId": "string", "transition": null, "scene": { "id": "string", "camera": { "x": 0, "y": 0, "zoom": 1 }, "tokens": { "surface": "string", "ink": "string", "accent": "string", "material": "dark-glass", "from": "string" }, "bridge": "settle" }, "generationContent": null, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "slug": "string", "position": 0 } ], "members": [ { "id": "string", "userId": "string", "name": "string", "email": "string", "avatar": "string", "role": { "id": "owner", "name": "string" } } ], "tags": [], "viewerUrl": null, "embedUrl": null}apiKeyx-api-key<token>pid*stringProject deleted.
curl -X DELETE "https://example.com/api/public/v1/projects/string"apiKeyx-api-key<token>pid*stringapplication/json- body
password?|8–128 characters sets the link password, null removes it, and leaving it out keeps the current one.
8 <= length <= 128Project published.
application/json- response
pid*stringisPublished*booleanslug*|Kept on unpublish, so publishing again restores the link.
viewerUrl*|Public viewer link; null unless the project is published.
nullembedUrl*|Iframe embed link; null unless the project is published.
nullpasswordProtected*booleanpublishedAt*|^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$date-timecurl -X POST "https://example.com/api/public/v1/projects/string/publish" \ -H "Content-Type: application/json" \ -d '{}'{ "pid": "string", "isPublished": true, "slug": "string", "viewerUrl": null, "embedUrl": null, "passwordProtected": true, "publishedAt": "2019-08-24T14:15:22Z"}apiKeyx-api-key<token>pid*stringProject unpublished.
application/json- response
pid*stringisPublished*booleanslug*|Kept on unpublish, so publishing again restores the link.
viewerUrl*|Public viewer link; null unless the project is published.
nullembedUrl*|Iframe embed link; null unless the project is published.
nullpasswordProtected*booleanpublishedAt*|^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$date-timecurl -X DELETE "https://example.com/api/public/v1/projects/string/publish"{ "pid": "string", "isPublished": true, "slug": "string", "viewerUrl": null, "embedUrl": null, "passwordProtected": true, "publishedAt": "2019-08-24T14:15:22Z"}apiKeyx-api-key<token>pid*stringapplication/json- body
instruction*string1 <= length <= 4000pageId?stringdryRun?booleanfalseThe run finished; status says whether it saved.
application/json- response
status*string"applied""proposed""no_changes""truncated"message*stringThe model's reply.
changes*array<>skipped*array<>changedPageIds*array<string>deletedPageIds*array<string>curl -X POST "https://example.com/api/public/v1/projects/string/edits" \ -H "Content-Type: application/json" \ -d '{ "instruction": "string" }'{ "status": "applied", "message": "string", "changes": [ { "tool": "string", "details": "string" } ], "skipped": [ { "tool": "string", "reason": "string" } ], "changedPageIds": [ "string" ], "deletedPageIds": [ "string" ]}apiKeyx-api-key<token>pid*stringlayerId*stringpageId?stringThe page holding the layer. Needed only when the layer ID is on several pages, as it is after a page is duplicated.
application/json- body
chartData*The values were saved.
application/json- response
projectPid*stringpageId*stringlayerId*stringupdatedAt*stringISO time the values were written.
curl -X PUT "https://example.com/api/public/v1/projects/string/layers/string/data" \ -H "Content-Type: application/json" \ -d '{ "chartData": { "xKey": "string", "xLabel": "string", "series": [ { "key": "string", "label": "string" } ], "rows": [ { "property1": "string", "property2": "string" } ] } }'{ "projectPid": "string", "pageId": "string", "layerId": "string", "updatedAt": "string"}