Text Improvements

Try the Text Improvements endpoint here

By using our Text Improvement endpoint, you can access our state-of-the-art recommendations engine, which is optimized for generating high-quality results efficiently.

Example

{
  "text": "Affiliated with the profession of project management, I have ameliorated myself with a different set of hard skills as well as soft skills",
  "types": ["fluency", "vocabulary/specificity"]
}

The following is a possible response from the Improvements API to the example request above:

{
  "id": "e0426d4c-4f63-e6bd-addb-6c617d86bb02",
  "improvements": [
    {
      "suggestions": [
        "As a project manager, I have acquired",
        "As a member of the project management profession, I have acquired",
        "Due to my association with the project management profession, I have acquired"
      ],
      "startIndex": 0,
      "endIndex": 84,
      "originalText": "Affiliated with the profession of project management, I have ameliorated myself with",
      "improvementType": "fluency"
    },
    {
      "suggestions": [
        "technical",
        "practical",
        "analytical"
      ],
      "startIndex": 104,
      "endIndex": 108,
      "originalText": "hard",
      "improvementType": "vocabulary/specificity"
    }
  ]
}

The response body includes an array of suggested improvements. Each item in the array is an object with the following fields:

suggestions: A list of suggestions for improving the input text, which may be for the entire text or a portion of it.

startIndex: The index indicating the beginning of the input text that the API suggests to improve.

endIndex: The index indicating the end of the input text that the API suggests to improve.

originalText: The specific text portion suggested for improvement by the API.

improvementType: The type of improvement that the API suggests, which can be:

fluency
vocabulary/specificity
vocabulary/variety
clarity/short-sentences
clarity/conciseness