API Documentation

Integrate our API into your platform or your company's communications systems within hours.

Rephraser is a simple API that receives text in English and returns it rephrased and corrected - as though it were edited by a professional native English-speaker editor.

Authentication URL

https://rephraser.ai/api/auth

API Authentication Request (HTTP POST)

{
    "email": "{YOUR_EMAIL}",
    "password": "{YOUR_PASSWORD}"
}


Endpoint URL

https://rephraser.ai/api/rephrase

API Request (HTTP POST)

Our API uses a JSON format:

{
    "text": "he are good, This is test."
}


API Response

The text is analyzed and tokenized to sentences and words. The response is returned as an array of sentences in a JSON format with the following fields:

Field Type Description
original String The original text
edited String The edited text
original_highlight List of Objects List of characters in 'original' to be highlighted. Each inner object is of the form: { range: [start_ind, end_ind] } where start_ind is first index of character in 'original' to highlight, and end_ind is the last one (excluding)
edited_highlight List of Objects List of characters in 'edited' to be highlighted. Each inner list is of form: { range: [start_ind, end_ind] } where start_ind is first index of character in 'edited' to highlight, and end_ind is the last one (excluding)
number_of_words Integer Number of words used in this api call
words_left Integer Number of words left in subscription


Here is the response for the example sentence "This year we deepen our industry and expand our scale, leading nearly 30 delegations.":

{
  "original":"This year we deepen our industry and expan our scale, leading nearly 30 delegations.",
  "edited":"This year, we've deepened our industry and expanded our membership, leading almost 30 delegations.",
  "original_highlight":[
    {"ranges": [2,7]},{"ranges": [37,42]},{"ranges": [47,52]},{"ranges": [62,68]}
  ],
  "edited_highlight":[
    {"ranges": [9,10]},{"ranges": [13,16]},{"ranges": [17,25]},{"ranges": [43,51]},{"ranges": [56,66]},{"ranges": [76,82]}
  ],
  "number_of_words": 14,
  "words_left": 19928
}