Skip to main content
POST
text.rewrite

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 rewrite, at most 5,000 characters.

Required string length: 1 - 5000
language
string

Language to use for the rewrite.

Maximum string length: 24
transform
enum<string>
default:paraphrase

Transformation to apply; default paraphrase.

Available options:
paraphrase,
passive_to_active,
active_to_passive,
informal_to_formal,
formal_to_informal,
shorten,
expand,
sentence_split,
switch_tone,
switch_tense,
generate_title,
generate_acronym
tone
enum<string>

Requested tone; required for switch_tone.

Available options:
confident,
diplomatic,
enthusiastic,
friendly,
straightforward,
professional,
casual,
empathetic,
persuasive
style
enum<string>

Writing style.

Available options:
academic,
business,
casual,
simple
tense
string

Explicit target tense; required for switch_tense.

Required string length: 1 - 40
Pattern: ^[a-z_]+$
limit
number

Maximum alternative rewrites, at most five; default one.

Required range: x >= 1

Response

The result

results
object[]
required

Alternative rewrites.