POST
/
v1
/
teams
/
{teamId}
/
content
/
slideshows
/
drafts
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.slideshows.createSlideshowDraft({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  body: {},
})
{
  "contentItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sourceContentItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "status": "<string>",
  "payloadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "revision": 123,
  "creativeHash": "<string>",
  "currentCreativeHash": "<string>",
  "renderedCreativeHash": "<string>",
  "renderFresh": true,
  "activeRun": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>"
  },
  "latestRun": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>",
    "errorCode": "<string>",
    "diagnostics": "<string>"
  },
  "latestRenderJob": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>"
  },
  "project": {
    "schemaVersion": 1,
    "artifactKind": "slideshow",
    "runtime": {
      "rendererVersion": "<string>",
      "remotionVersion": "<string>",
      "reactVersion": "<string>",
      "platform": "linux-arm64",
      "entryPoint": "<string>",
      "dependencyAllowlistVersion": "<string>"
    },
    "sourceFiles": [
      {
        "path": "<string>",
        "contents": "<string>",
        "sha256": "<string>"
      }
    ],
    "output": {
      "width": 123,
      "height": 123,
      "fps": 30
    },
    "slides": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "durationFrames": 9000,
        "posterFrame": 1,
        "assetBindingIds": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "textElements": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "text": "<string>",
            "position": {
              "x": 0,
              "y": 0,
              "width": 50000.5,
              "height": 50000.5,
              "rotation": 0
            },
            "styleId": "<string>",
            "overrides": {
              "fontWeight": 500,
              "fontSize": 259,
              "lineHeight": 2.25,
              "letterSpacing": 32,
              "fill": "<string>",
              "strokeColor": "<string>",
              "strokeWidth": 16,
              "shadowColor": "<string>",
              "shadowBlur": 64,
              "shadowOffsetX": 0,
              "shadowOffsetY": 0,
              "panelColor": "<string>",
              "panelOpacity": 0.5,
              "padding": 128,
              "borderRadius": 128,
              "italic": true,
              "opacity": 0.5,
              "maxWidth": 2048.5
            }
          }
        ],
        "backgroundBindingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "backgroundPresentation": {
          "focalPoint": {
            "x": 0.5,
            "y": 0.5
          },
          "overlay": {
            "color": "<string>",
            "opacity": 0.5
          }
        },
        "embeddedText": [
          {
            "text": "<string>"
          }
        ]
      }
    ],
    "styles": {},
    "assetBindings": {},
    "styleContext": {
      "renderTokens": {},
      "references": [
        {
          "sourceId": "<string>",
          "label": "<string>",
          "sha256": "<string>"
        }
      ]
    }
  },
  "assetRefs": [
    "<unknown>"
  ],
  "links": {
    "self": "<string>",
    "revisions": "<string>",
    "latestRenderJob": "<string>"
  },
  "browserPreviewUrl": "<string>",
  "previewCreativeHash": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
idempotency-key
string
required

a string at most 200 character(s) long

Required string length: 1 - 200

Path Parameters

​
teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

Body

application/json
​
draft
object
required

Minimal slideshow description. Only slide text is required - the pinned renderer runtime, source bundle, output size, styles, caption layout and identifiers are all filled in for you.

​
title
string

a string at most 500 character(s) long

Maximum string length: 500
​
autoRender
boolean

When true, queue a render immediately after creating the slideshow; defaults to false.

Response

Success

​
contentItemId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
​
teamId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
​
sourceContentItemId
string<uuid> | null
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
​
title
string | null
required
​
status
string
required
​
payloadId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
​
revision
integer
required

an integer

​
creativeHash
string | null
required
​
currentCreativeHash
string | null
required
​
renderedCreativeHash
string | null
required
​
renderFresh
boolean
required
​
activeRun
object
required
​
latestRun
object
required

The most recent agent run whatever its outcome, so a failure is visible without having kept its run id.

​
latestRenderJob
object
required
​
project
object
required

Complete deterministic slideshow project, including slides, styles, asset bindings, output settings, and the pinned renderer runtime.

​
assetRefs
any[]
required
​
links
object
required
​
browserPreviewUrl
string
​
previewCreativeHash
string