Public Generation

Generate a complete project (plan + generate in one call)

Authorization

apiKey

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

topic?string

Lengthlength <= 512

supportingMaterials?array<>

Itemsitems <= 20

outlineHints*array<>

Items1 <= items <= 1000

verbosity*string

Default"balanced"

Value in"concise" | "balanced" | "detailed" | "guide"

model*string

Default"claude-sonnet-4-5-20250929"

Value in

"gpt-5.5" | "gpt-5.4" | "gpt-5-mini" | "claude-sonnet-4-5-20250929" | "claude-haiku-4-5-20251001" | "claude-opus-4-8" | "gemini-2.5-pro" | "gemini-2.5-flash"

tone?string

Length1 <= length <= 128

audience?string

Length1 <= length <= 256

imageStyle?string

Length1 <= length <= 256

pageCount*|

Default"auto"

includeCallToAction*boolean

Defaulttrue

callToAction?string

Length1 <= length <= 256

mediaProvider?string

Value in"unsplash" | "giphy" | "generated"

imageModel?string

Value in"gemini-3.1-flash-image-preview" | "imagen-4-fast" | "flux-2-pro"

deepResearch*boolean

Defaultfalse

useConnectors*boolean

Defaultfalse

pinnedConnectorResources?array<>

Itemsitems <= 10

iconFamily?string

Value in"lucide" | "nucleo-isometric" | "nucleo-glass" | "emoji"

theme?|

themeMode?string

Value in"light" | "dark"

tenantThemeDefinition?

callbackUrl?string

Formaturi

endUserEmail?string

Match^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Formatemail

Lengthlength <= 255

endUserRole?string

Value in"viewer" | "content_editor" | "editor"

Response Body

`application/json`

curl -X POST "https://example.com/api/public/v1/projects/generate" \  -H "Content-Type: application/json" \  -d '{    "outlineHints": [      "string"    ],    "verbosity": "concise",    "model": "gpt-5.5",    "pageCount": "auto",    "includeCallToAction": true,    "deepResearch": false,    "useConnectors": false  }'

{
  "sessionId": "string",
  "status": "planning"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string",
  "code": "CREDITS_EXHAUSTED",
  "limit": {
    "key": "string",
    "value": 0,
    "used": 0
  },
  "required_plan": "pro_v1",
  "upgrade_url": "http://example.com"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Generate a project outline

Authorization

apiKey

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

topic?string

Lengthlength <= 512

supportingMaterials?array<>

Itemsitems <= 20

outlineHints*array<>

Items1 <= items <= 1000

verbosity*string

Default"balanced"

Value in"concise" | "balanced" | "detailed" | "guide"

model*string

Default"claude-sonnet-4-5-20250929"

Value in

"gpt-5.5" | "gpt-5.4" | "gpt-5-mini" | "claude-sonnet-4-5-20250929" | "claude-haiku-4-5-20251001" | "claude-opus-4-8" | "gemini-2.5-pro" | "gemini-2.5-flash"

tone?string

Length1 <= length <= 128

audience?string

Length1 <= length <= 256

imageStyle?string

Length1 <= length <= 256

pageCount*|

Default"auto"

includeCallToAction*boolean

Defaulttrue

callToAction?string

Length1 <= length <= 256

mediaProvider?string

Value in"unsplash" | "giphy" | "generated"

imageModel?string

Value in"gemini-3.1-flash-image-preview" | "imagen-4-fast" | "flux-2-pro"

background?boolean

deepResearch*boolean

Defaultfalse

useConnectors*boolean

Defaultfalse

pinnedConnectorResources?array<>

Itemsitems <= 10

iconFamily?string

Value in"lucide" | "nucleo-isometric" | "nucleo-glass" | "emoji"

theme?|

themeMode?string

Value in"light" | "dark"

tenantThemeDefinition?

callbackUrl?string

Formaturi

endUserEmail?string

Match^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Formatemail

Lengthlength <= 255

endUserRole?string

Value in"viewer" | "content_editor" | "editor"

sessionId?string

clarificationAnswers?array<>

Itemsitems <= 4

Response Body

`application/json`

curl -X POST "https://example.com/api/public/v1/projects/plan" \  -H "Content-Type: application/json" \  -d '{    "outlineHints": [      "string"    ],    "verbosity": "concise",    "model": "gpt-5.5",    "pageCount": "auto",    "includeCallToAction": true,    "deepResearch": false,    "useConnectors": false  }'

{
  "plan": {
    "title": "string",
    "subtitle": "string",
    "titleAuthored": true,
    "tone": "string",
    "audience": "string",
    "summary": "string",
    "callToAction": "string",
    "pages": [
      {
        "title": "string",
        "objective": "string",
        "keyPoints": [
          "string"
        ],
        "slideType": "narrative",
        "mediaRole": "none",
        "narrativeBeat": "setup",
        "headlineStyle": "insight",
        "recommendedRoadmapStyles": [
          "OPTION1"
        ],
        "recommendedStatisticsStyles": [
          "CENTERED"
        ],
        "recommendedStepsStyles": [
          "CHEVRONS"
        ],
        "supportingPacketIds": [
          "string"
        ],
        "userContent": "string",
        "dataSourceHint": {
          "connectionId": "string",
          "provider": "google_sheets",
          "resourceId": "string",
          "resourceName": "string",
          "metric": "string",
          "fields": [
            "string"
          ],
          "targetLayerType": "chart"
        }
      }
    ]
  },
  "questions": [
    {
      "id": "string",
      "question": "string",
      "reason": "string",
      "inputType": "text",
      "choices": [
        "string"
      ],
      "placeholder": "string"
    }
  ],
  "sessionId": "string",
  "events": [
    {
      "type": "string",
      "message": "string",
      "data": null
    }
  ],
  "usage": {
    "property1": 0,
    "property2": 0
  }
}

{
  "sessionId": "string",
  "events": [
    {
      "type": "string",
      "message": "string",
      "data": null
    }
  ]
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string",
  "code": "CREDITS_EXHAUSTED",
  "limit": {
    "key": "string",
    "value": 0,
    "used": 0
  },
  "required_plan": "pro_v1",
  "upgrade_url": "http://example.com"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Generate project content from a supplied plan

Authorization

apiKey

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

plan*

sessionId?string

request?

background?boolean

callbackUrl?string

Formaturi

Response Body

`application/json`

curl -X POST "https://example.com/api/public/v1/projects/generate-from-plan" \  -H "Content-Type: application/json" \  -d '{    "plan": {      "title": "string",      "tone": "string",      "audience": "string",      "summary": "string",      "pages": [        {          "title": "string",          "objective": "string",          "keyPoints": [            "string"          ],          "slideType": "narrative",          "mediaRole": "none"        }      ]    }  }'

{
  "project": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "pid": "string",
    "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    "name": "string",
    "theme": "default",
    "themeDefinitionSnapshot": {
      "light": {
        "surface": "string",
        "panel": "string",
        "border": "string",
        "accent": "string",
        "accentMuted": "string",
        "text": "string",
        "mutedText": "string",
        "fontFamily": "string",
        "headingFontFamily": "string",
        "pageBackground": [],
        "layerBackground": {
          "type": "color",
          "value": "string",
          "tint": "string"
        },
        "layerBorder": {
          "radius": 0,
          "width": 0,
          "type": "color",
          "value": "string",
          "side": "all",
          "sideWidths": {
            "property1": 0,
            "property2": 0
          }
        },
        "layerShadow": "drop-shadow-none",
        "chartColors": [
          "string"
        ]
      },
      "dark": {
        "surface": "string",
        "panel": "string",
        "border": "string",
        "accent": "string",
        "accentMuted": "string",
        "text": "string",
        "mutedText": "string",
        "fontFamily": "string",
        "headingFontFamily": "string",
        "pageBackground": [],
        "layerBackground": {
          "type": "color",
          "value": "string",
          "tint": "string"
        },
        "layerBorder": {
          "radius": 0,
          "width": 0,
          "type": "color",
          "value": "string",
          "side": "all",
          "sideWidths": {
            "property1": 0,
            "property2": 0
          }
        },
        "layerShadow": "drop-shadow-none",
        "chartColors": [
          "string"
        ]
      },
      "fonts": [
        {
          "id": "string",
          "label": "string",
          "family": "string",
          "url": "http://example.com",
          "mimeType": "string",
          "sizeBytes": 0,
          "assetId": "string",
          "storageKey": "string",
          "weight": 0,
          "style": "string"
        }
      ]
    },
    "brandingId": null,
    "pageLayersScrollable": true,
    "pageAspectRatio": "16:9",
    "pageGridEnabled": false,
    "pageGridType": "12-column",
    "pageNumbersEnabled": false,
    "linkShareToken": "string",
    "linkAccess": "tenant",
    "linkRole": "owner",
    "publishSlug": null,
    "isPublished": false,
    "publishedAt": null,
    "ogImageUrl": null,
    "publishDescription": null,
    "lockedThemeMode": null,
    "showMadeWithEncelade": false,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "pinnedAt": null,
    "backgroundPresets": [],
    "pages": [
      {
        "pageBackground": [],
        "presentModeAnimation": "layers-staggered",
        "currentSelectedLayerId": null,
        "currentSelectedLayerType": null,
        "speakerNotes": "",
        "watermarkEnabled": false,
        "watermarkText": "",
        "watermarkShowOnAllPages": false,
        "layout": [],
        "isPageLayoutLocked": false,
        "hide": false,
        "layerVisibilityDefaults": null,
        "showLayoutBounds": true,
        "fluidLayout": null,
        "narrativeBeat": null,
        "pageTypeId": "string",
        "pageTypeVariantId": "string",
        "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"
        }
      }
    ]
  },
  "sessionId": "string",
  "events": [
    {
      "type": "string",
      "message": "string",
      "data": null
    }
  ],
  "metrics": {
    "durationMs": 0,
    "toolInvocationCount": 0,
    "eventCount": 0
  }
}

{
  "sessionId": "string",
  "events": [
    {
      "type": "string",
      "message": "string",
      "data": null
    }
  ]
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string",
  "code": "CREDITS_EXHAUSTED",
  "limit": {
    "key": "string",
    "value": 0,
    "used": 0
  },
  "required_plan": "pro_v1",
  "upgrade_url": "http://example.com"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

202application/json

400application/json

401application/json

402application/json

403application/json

429application/json

500application/json

503application/json

200application/json

202application/json

400application/json

401application/json

402application/json

403application/json

429application/json

500application/json

503application/json

200application/json

202application/json

400application/json

401application/json

402application/json

403application/json

429application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`