For the complete documentation index, see llms.txt. This page is also available as Markdown.

AI Essay Generator

Generate esay based on mode, topic and word limit

Try Demo

Endpoints

POST https://prod.api.market/api/v1/capix/essay/generate/essay/v1/

Overview

This endpoint allows you to generate an essay based on a provided description, mode, and word count. The request must include a valid API token in the headers.

Request Headers

  • Content-Type: application/json

  • x-magicapi-key: API_KEY (Replace API_KEY with your actual API key)

Request Body

The body of the request should be in JSON format and include the following parameters:

  • description: A detailed description of the essay topic and key points to be covered. This is a string that provides guidance on what the essay should encompass.

  • mode: The mode of the essay generation. For example, it could be "Standard", "Detailed", etc.

  • word_count: The desired word count for the generated essay. This should be an integer.

Example Request Body

{
  "description": "Essay Topic: The Impact of Social Media on Human Communication Key Details and Questions: Introduction: Introduce the topic by highlighting the ubiquity of social media in modern life. Pose the central question: Has social media enhanced or hindered human communication? Historical Perspective: How did people communicate before the advent of social media? What were the key stages in the evolution of social media platforms? Positive Impacts of Social Media: How has social media facilitated global connectivity and understanding? Discuss the role of social media in democratizing content creation and information sharing. Negative Impacts of Social Media: Analyze the potential for misinformation and echo chambers. Explore the effects of social media on mental health and interpersonal relationships. Social Media and Business: How has social media transformed business marketing and customer engagement? Discuss the rise of influencer culture and its implications. The Future of Social Media: Speculate on the future trends in social media. What role might emerging technologies like AI and VR play in the evolution of social media? Conclusion: Summarize the main points. Reflect on the balance between the benefits and drawbacks of social media. Provide a personal perspective or a call to action on how to use social media responsibly. Themes to Explore: The role of technology in shaping human interaction. The balance between virtual and real-life communication. Ethical considerations in the age of digital media.",
  "mode": "Standard",
  "word_count": 1200
}

Error Handling

The API will return appropriate error messages if the request is invalid or if there is an issue with generating the essay. Common error codes include:

  • 400 Bad Request: The request was invalid. This can happen if the JSON is malformed or required parameters are missing.

  • 401 Unauthorized: The API key provided in the token header is invalid.

  • 500 Internal Server Error: An error occurred on the server while processing the request.

Example Error Response

Notes

  • Ensure that the API key is kept secure and not exposed in public repositories or client-side code.

  • Adjust the description, mode, and word_count according to your specific requirements for the essay generation.

Code Examples

It returns response like this

Data values

  • You can explain the essay on the description parametr

  • Word Count is the max word count of the story. Max 2000 is received. Result: You can seperate the titles with comma

  • Writing Mode could be either: Standard, Academic, Professional, Journalistic

  • Writing Purpose could be eighter: Narrative, Argumentative, Expository, Descriptive

Last updated