Publishes supplied HTML as a new public Carryo website for sharing a presentation, proposal, report, dashboard, invitation, portfolio, or landing page. Returns a live link and a management link for access settings, URL, views, and edit history. New Personal websites consume the account creation allowance. Personal is the default destination; workspaceId selects a user-chosen team. Supports an optional customSlug and hosted images. Pass attached images through imageFiles. For one attachment, assets needs only its relative website path; Carryo matches the attachment automatically. For multiple attachments, use fileIndex (0 for the first imageFiles entry). Do not invent file IDs or ask for a public URL when attachment upload is available. Known fileId references and fetchable HTTP(S) sourceUrl imports also work. Carryo imports and hosts its own copy. Base64 image bytes and data URLs are unsupported. Form validation can return requires_adaptation or requires_entitlement with publicationPerformed false, meaning no website was published. Supports HTML pages and their image assets, without general file storage or backend hosting.
View input schema
{
"type": "object",
"properties": {
"forms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[a-z][a-z0-9_-]{0,63}$"
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[a-z][a-z0-9_-]{0,63}$"
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"type": {
"type": "string",
"enum": [
"text",
"email",
"tel",
"number",
"date",
"textarea",
"select",
"checkbox",
"radio"
]
},
"required": {
"type": "boolean"
},
"maxLength": {
"type": "integer",
"minimum": 1,
"maximum": 3000
},
"options": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"minItems": 1,
"maxItems": 100
}
},
"required": [
"name",
"label",
"type"
],
"additionalProperties": false
},
"minItems": 1,
"maxItems": 30
},
"closed": {
"type": "boolean"
},
"notifyOwner": {
"type": "boolean"
},
"acknowledgementEmailField": {
"type": "string"
}
},
"required": [
"key",
"title",
"fields"
],
"additionalProperties": false
},
"maxItems": 5,
"description": "Optional definitions for JavaScript/React forms using window.CarryoForms.submit(key, values), which resolves on acceptance and rejects on failure. Stable keys and field names identify forms across edits. Static collection forms are inferred from data-carryo-form=\"key\" and named controls without duplicate definitions; placeholder submit handlers can block collection. Local calculator/filter forms use data-carryo-local and do not collect responses. Existing external endpoints retain their destination. Visitor acknowledgement is disabled unless explicitly enabled."
},
"htmlContent": {
"type": "string",
"minLength": 1,
"maxLength": 5242880,
"description": "Complete HTML for the page, presentation, slide deck, proposal, report, landing page, dashboard, invitation, portfolio, or one-page website to publish."
},
"fileName": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Short internal file name, for example client-proposal.html, board-deck.html, report.html, or landing-page.html."
},
"sharingMode": {
"type": "string",
"enum": [
"public"
],
"description": "Publishing mode for the Carryo page. Only public live links are supported here."
},
"expiresAt": {
"type": "string",
"description": "Optional ISO-8601 expiration timestamp"
},
"customSlug": {
"type": "string",
"minLength": 3,
"maxLength": 64,
"description": "Optional user-chosen URL ending using lowercase letters, numbers, and hyphens. An automatic URL is generated when omitted."
},
"workspaceId": {
"type": "string",
"pattern": "^ws_[A-Za-z0-9]+$",
"description": "Optional exact workspaceId of the Carryo team explicitly selected by the user. The default destination is Personal when omitted."
},
"imageFiles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"download_url": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"file_id": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"mime_type": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"file_name": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"required": [
"download_url",
"file_id"
],
"additionalProperties": false
},
"maxItems": 20,
"description": "Optional image attachments supplied through the host's file upload support. The host supplies file_id and download_url. Map each attachment to a website path in assets: with one attachment, path alone is sufficient; with multiple attachments, use fileIndex. The assistant does not need to know generated file IDs or download URLs. Temporary URLs are import sources, not hosted image URLs. Clients without file input support can omit this field."
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"contentType": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"fileId": {
"type": "string",
"minLength": 1,
"maxLength": 512,
"description": "Known attachment file_id matching an imageFiles entry. Prefer fileIndex if the host-generated ID is not visible. Mutually exclusive with fileIndex and sourceUrl."
},
"fileIndex": {
"type": "integer",
"minimum": 0,
"maximum": 19,
"description": "Zero-based position in imageFiles: 0 selects its first attachment. Use this when the host generates file IDs during upload. May be omitted when imageFiles contains exactly one attachment. Mutually exclusive with fileId and sourceUrl."
},
"sourceUrl": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "Fetchable HTTP(S) image URL for Carryo to import and host. Mutually exclusive with fileId and fileIndex. Data URLs and base64 bytes are unsupported."
}
},
"required": [
"path"
],
"additionalProperties": false
},
"maxItems": 20,
"description": "Optional image assets to add or replace. Each entry requires a relative website path. With one imageFiles attachment, path alone uses that attachment. Otherwise select exactly one source: fileIndex (zero-based imageFiles position), a known fileId, or a fetchable HTTP(S) sourceUrl. Never guess generated file IDs. Existing images are preserved when omitted; replacing an existing path does not use another slot. Base64 bytes and data URLs are unsupported."
}
},
"required": [
"htmlContent",
"fileName",
"sharingMode"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}