Reply-Gen: API Documentation

This document describes how to use Reply-Gen, an API that automatically generates replies to text content.

API Endpoints:

• /reply: This endpoint generates a reply based on the provided content, desired number of sentences, moods, and reading level.
• /moods: Retrieves a list of supported moods.
• /moods_categorized: Retrieves a list of moods categorized into positive, negative, neutral.
• /reading_levels: Retrieves a list of supported reading levels.
• /valid_rapid_api_request: Returns True if valid rapid_api_request is made. Else raise 401.
• /ping: Checks if the API is online.

Authentication:

Requests to /reply must be authenicated through RapidAPI.

For all other endpoints no authentication is required to use the Reply-Gen API.

Making a Reply Request:

1. Prepare your request object:

   • content: The text content for which you want to generate a reply.
   • num_sentences: The desired number of sentences in the reply.
   • moods: An array of desired moods for the reply (see /moods for options).
   • reading_level: The desired reading level for the reply (see /reading_levels for options).

2. Send a POST request to the /reply endpoint:

   • Content-Type: application/json
   • Body: JSON object containing your request parameters (see example below).

{
  "content": "This is a great blog post!",
  "num_sentences": 3,
  "moods": ["Thankful", "Happy"],
  "reading_level": "High School"
}

3. Receive the API response:
   • Status code: 200 indicates success.
   • Response body: JSON object containing the generated reply.

Example Response:

{
  "response": "Thank you for reading! I'm glad you enjoyed the blog post. I'm always happy to hear feedback and suggestions, so please feel free to leave a comment below."
}

Additional Notes:

• The num_sentences parameter can be any integer between 1 and 6 and is treated as a suggestion to the model. We cannot guarantee that number of sentences will be generated.
• The API supports multiple moods.
• The API is still under development and new features are being added regularly.

For further information:

• Refer to the OpenAPI specification for detailed endpoint descriptions and parameter options.
• Explore the API playground to experiment with different requests and parameters.

We hope you find Reply-Gen useful!