Skip to main content
POST
text.scan.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
text
string
required

Exact submitted text, including whitespace; at most 5000 Unicode code points. May contain personal data.

Required string length: 1 - 5000
retain
boolean
required

Required consent to store submitted text upstream. There is no published delete endpoint.

checks
enum<string>[]

Selected analyses. Default is detection only; facts is an explicit more expensive option.

Required array length: 1 - 7 elements

One kind of text analysis.

Available options:
ai,
plagiarism,
facts,
readability,
grammar,
quality,
allowance
allowanceThreshold

Allowed generated-text threshold, as a percentage. Confidence is not a measured percentage of generated words.

excludedUrls
string[]

Up to 10 source URLs to exclude.

Maximum array length: 10

Public source URL to exclude from comparisons.

limit
integer
default:100

Maximum matched excerpts to return, 1 to 1,000. Default 100.

Required range: 1 <= x <= 1000
claimLimit
integer
default:20

Maximum claims per chunk. Default 20.

Required range: 1 <= x <= 100
label
string
default:Saved text scan

Your saved-scan label. Default Saved text scan.

Required string length: 1 - 120

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.