Skip to main content
POST
Native platform post

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string

Stable retry key for this logical paid call. Reuse it after a timeout to receive the original result without duplicate work or spend.

Required string length: 1 - 255
x-sigmora-quote-only
string

Send 1 to get the price, balance and budget verdict without running anything.

Allowed value: "1"
x-sigmora-max-credits
string

The approved price; a call that would cost more is refused and nothing is charged.

Pattern: ^\d+$

Body

application/json
platform
enum<string>
required

Target platform, e.g. linkedin, x, tiktok. x and twitter-x are the same platform. Every accepted value is listed below.

Available options:
twitter,
twitter-x,
medium,
reddit,
linkedin,
youtube,
binance-square,
facebook,
instagram,
tiktok,
threads,
x
content
string
required

The material to rewrite as a native post.

Required string length: 1 - 50000
projectId
string
required

The existing project to file this work under. Create it with POST /v1/projects, then reuse its id across related calls. A project this workspace does not own answers not_found; the work is never silently filed somewhere else.

Required string length: 1 - 200
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
enum<string>

Voice of the post, e.g. professional, casual. Defaults to professional.

Available options:
professional,
casual,
humorous,
inspirational,
educational
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

Response

Success.

success
boolean
required
credits
number
required

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

Example:

300

copy
object
required

The post, written for the platform you named. The text is under result.

projectId
string

The existing project this work was filed under. It matches the projectId supplied by the caller after workspace ownership was verified.

Example:

"prj_9x2a4c"

creditBalance
number

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

Example:

3900

{key}
any