Skip to main content
POST
Native platform post

Authorizations

Authorization
string
header
required

A workspace API key.

Body

application/json
platform
string
required

Target platform, e.g. linkedin, x, tiktok.

Required string length: 1 - 60
content
string
required

The material to rewrite as a native post.

Required string length: 1 - 50000
topic
string

What it is about, when the content alone is thin.

Maximum string length: 300
targetAudience
string

Who should recognise themselves in it.

Maximum string length: 300
tone
string

e.g. plain, wry, authoritative.

Maximum string length: 60
includeHashtags
boolean

Append platform-appropriate hashtags.

includeEmojis
boolean

Allow emoji where the platform expects them.

maxLength
integer

Hard character ceiling for the post.

Required range: 1 <= x <= 20000
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

copy
any
required

The post, written for the platform you named.

creditBalance
number

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

Example:

3900

{key}
any