Skip to main content
POST
Restyle long-form

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
content
string
required

The long-form text to restyle.

Required string length: 1 - 100000
contentType
string
required

What it is, e.g. article, transcript, email. Decides what structure survives.

Required string length: 1 - 60
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
tone
string

The register to move it to.

Maximum string length: 60
style
string

The manner, e.g. conversational, technical.

Maximum string length: 60
targetAudience
string

Who the rewrite is for.

Maximum string length: 60
preserveKeywords
string[]

Terms that must survive the rewrite verbatim.

Maximum array length: 50
Required string length: 1 - 120

Response

Success.

success
boolean
required
credits
number
required

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

Example:

300

paraphrase
object
required

The restyled text. 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