POST
/
v1
/
teams
/
{teamId}
/
captions
/
format
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

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

const response = await client.captions.formatCaption({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  body: {},
})
{
  "text": "<string>",
  "changed": true
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
teamId
string
required

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

Body

application/json
​
text
string
required

The caption to space out. Words are never changed, only whitespace.

Example:

"Most teams post at random. We tested 400 posts. Morning slots won. Here is our schedule."

​
provider
enum<string> | null

The channel the caption is for. X captions stay one block. Omit or null for a channel-neutral format.

Available options:
x,
tiktok,
instagram,
facebook,
youtube,
linkedin,
threads,
pinterest
Example:

"instagram"

Response

Success

​
text
string
required

The spaced caption: hook line, 1 to 3 short paragraphs, then hashtags.

​
changed
boolean
required

False when the caption was already spaced (or is for X).