Skip to main content
POST
Article from a script

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

Finished source script to turn into an article. This is the only required field.

Required string length: 1 - 200000
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
claims
object[]

Optional verified-claim ledger. Supplying it lets the article preserve citations and corrected wording.

Maximum array length: 500
channel
string

Channel or publication voice to write in.

Maximum string length: 120
title
string

Article title. Omit to have one derived from the script.

Maximum string length: 300
publisherName
string

Publisher name for the returned Schema.org metadata.

Maximum string length: 200
authorName
string

Author name for the returned byline and Schema.org metadata.

Maximum string length: 200

Response

Success.

success
boolean
required
credits
number
required

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

Example:

300

article
object
required

The article, carrying the citations it was written from.

jsonLd
object | null
required

Schema.org markup for the article, ready to embed. Null when none was built.

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