Skip to main content
POST
text.grammar.check

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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

Text to correct, at most 5,000 characters.

Required string length: 1 - 5000
language
string

Language of the text; omit to use the serving source default or detection.

Maximum string length: 24
variety
enum<string>

Spelling variety to enforce.

Available options:
us,
gb,
au,
ca,
simplified,
traditional

Response

The result

text
string
required

Corrected text.

truncated
boolean
required

Whether more issue details exist than were returned.

issues
object[]

Up to 100 corrections, if the serving source reports spans.

Maximum array length: 100