Skip to main content
POST
Rewrite representment text

Authorizations

Authorization
string
header
required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Headers

x-idempotency-key
string<uuid>
required

Idempotency key to be used. Sending again the same key would return the same result without re-executing the update.

Path Parameters

disputeId
string<uuid>
required

Identifier of the resource in Payrails.

Body

application/json
action
enum<string>
required

How to rewrite the passage.

Available options:
concise,
firm,
formal
text
string
required

The selected passage, including any evidence citation tags.

Required string length: 1 - 10000

Response

Passage rewritten. Nothing is stored; save the sections to keep it.

text
string
required

The rewritten passage, with the same evidence citation tags as the input.