Skip to main content
POST
Article from a script

Authorizations

Authorization
string
header
required

A workspace API key.

Body

application/json
script
string
required
Required string length: 1 - 200000
claims
object[]
Maximum array length: 500
channel
string
Maximum string length: 120
title
string
Maximum string length: 300
publisherName
string
Maximum string length: 200
authorName
string
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

article
any
required

The article, carrying the citations it was written from.

jsonLd
any | null
required

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

creditBalance
number

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

Example:

3900

{key}
any