PATCH
/
v1
/
teams
/
{teamId}
/
content
/
slideshows
/
{contentItemId}
/
slides
/
{slideId}
/
captions
/
{textElementId}
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

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

const response = await client.slideshows.editSlideshowCaption({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  contentItemId: process.env.OCTOSPARK_CONTENT_ITEM_ID ?? "contentItemId",
  slideId: process.env.OCTOSPARK_SLIDE_ID ?? "slideId",
  textElementId: process.env.OCTOSPARK_TEXT_ELEMENT_ID ?? "textElementId",
  body: {},
})
{
  "slideshow": {
    "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>"
            }
          ],
          "imageElements": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "bindingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "position": {
                "x": 0,
                "y": 0,
                "width": 50000.5,
                "height": 50000.5,
                "rotation": 0
              },
              "opacity": 0.5,
              "zIndex": 50
            }
          ]
        }
      ],
      "styles": {},
      "assetBindings": {},
      "styleContext": {
        "renderTokens": {},
        "references": [
          {
            "sourceId": "<string>",
            "label": "<string>",
            "sha256": "<string>"
          }
        ]
      }
    },
    "assetRefs": [
      "<unknown>"
    ],
    "links": {
      "self": "<string>",
      "revisions": "<string>",
      "latestRenderJob": "<string>"
    },
    "browserPreviewUrl": "<string>",
    "previewCreativeHash": "<string>"
  },
  "revision": {
    "contentItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "payloadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "revision": 123,
    "creativeHash": "<string>",
    "reversesRevision": 123,
    "artifactRunId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "actorType": "<string>",
    "actorUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "commands": [
      "<unknown>"
    ]
  },
  "run": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "experimentConfigId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contentItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>",
    "targetSlideId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "baseRevision": 123,
    "resultRevision": 123,
    "workflowId": "<string>",
    "renderJobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "outputAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "errorCode": "<string>",
    "diagnostics": "<string>",
    "pauseReason": "<string>",
    "maxSpendDecimillicents": 123,
    "spentDecimillicents": 123,
    "activeDurationMs": 123,
    "links": {
      "self": "<string>",
      "events": "<string>",
      "slideshow": "<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.

​
contentItemId
string<uuid>
required

Slideshow content item id (UUID), as returned by createSlideshow, createSlideshowGeneration, or listSlideshows.

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}$
​
slideId
string<uuid>
required

Slide id (UUID) from the slideshow project returned by getSlideshow.

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}$
​
textElementId
string<uuid>
required

Caption element id from the selected slide.

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}$

Body

application/json
​
expectedRevision
integer
required

a positive number

​
text
string

a string at most 4000 character(s) long

Maximum string length: 4000
​
role
enum<string>

Caption purpose within the slide. Omit to keep its current role.

Available options:
hook,
heading,
body,
caption,
cta,
custom
​
position
object

Caption position and dimensions in the slide coordinate system. Omit to keep its current placement.

​
styleId
string

a string matching the pattern ^[A-Za-z][A-Za-z0-9._-]*$

Required string length: 1 - 128
Pattern: ^[A-Za-z][A-Za-z0-9._-]*$
​
overrides
object

Individual text-style changes, applied over the selected style. Omit to retain existing overrides.

Response

SlideshowCommandsResponse

​
status
enum<string>
required
Available options:
applied,
queued
​
slideshow
object
required
​
revision
object
required
​
run
object
required