Skip to main content
POST
Adapt a hook

Authorizations

Authorization
string
header
required

A workspace API key.

Body

application/json
sourceTitle
string
required

The title of the post whose shape you want to borrow. The words are not reused.

Required string length: 1 - 300
sourcePlatform
string
required

Where it ran, e.g. tiktok. Conventions differ enough to change the adaptation.

Required string length: 1 - 60
targetPlatform
string
required

Where yours will run, e.g. shorts.

Required string length: 1 - 60
pattern
string

The structural pattern to carry over, if you have already named it.

Maximum string length: 200
hookType
string

The kind of opening, e.g. question, stat.

Maximum string length: 120
formatTags
string[]

Format traits worth preserving, e.g. listicle, voiceover, screen-recording.

Maximum array length: 20
Required string length: 1 - 60
niche
string

Your subject area, so the rewrite lands in it.

Maximum string length: 200
projectId
string

The project to file this work under. Optional: omit it and one is created for you, and its id comes back on the response — read it from there rather than assuming. Pass the same id across calls when you want the script, the render and the thumbnail to land in one container. A project this workspace does not own answers not_found; the work is never silently filed somewhere else.

Required string length: 1 - 200

Response

Success.

success
boolean
required
projectId
string
required

The project this work was filed under. Read it from here — a call that sent no projectId had one created, and this is where its id comes back.

Example:

"prj_9x2a4c"

credits
number
required

What this call actually cost, which is not always what was quoted.

Example:

300

script
string
required

The adapted short-form script.

creditBalance
number

Your balance after the charge. Absent when billing is disabled for the workspace.

Example:

3900

{key}
any