Skip to main content
POST

Authorizations

Authorization
string
header
required

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

Body

application/json
username
string

Username

verified
boolean

Verified account

timeAgo
string

Timestamp

avatar
string

Profile photo

photo
string

Story photo

storyText
string

Story text

textStyle
enum<string>

Text style

Available options:
classic,
modern,
neon,
typewriter,
strong
textSize
enum<string>

Text size

Available options:
small,
medium,
large
textPosition
enum<string>

Text position

Available options:
top,
center,
bottom
textAlign
enum<string>

Text alignment

Available options:
left,
center,
right
background
enum<string>

Background gradient

Available options:
purpleOrange,
sunset,
ocean,
forest,
mono,
candy
photoFit
enum<string>

Photo layout

Available options:
cover,
contain
storyCount
number

Stories in the set

Required range: 1 <= x <= 10
activeStory
number

Segment playing

Required range: 1 <= x <= 10
location
string

Location sticker

music
string

Music sticker

replyPlaceholder
string

Reply bar text

showReplyBar
boolean

Show the reply bar

showScrim
boolean

Darken top and bottom for legibility

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.