logo
Ghost ai

API Documentation

Welcome to the documentation for Ghost AI. Our API offers robust features for detecting AI-generated content and humanizing text to create more natural text that can bypass all major AI detectors. This documentation serves as a comprehensive guide, providing you with all the information needed to integrate and make the most out of our API. Whether you're looking to enhance the authenticity of digital communication or increase the ranking of your online content, you'll find valuable insights and practical instructions here.

AI Humanizer

Overview

The AI Humanizer is a feature of our API designed to transform AI-generated text into content that more closely resembles natural human writing. This tool is invaluable for developers and content creators seeking to enhance the readability and relatability of their AI-generated content, ensuring that it resonates more effectively with human audiences.

Endpoint

POST https://the-ghost-ai-backend-005c5dcbf4a6.herokuapp.com/transformations/humanize/

Request Parameters

To use the AI Humanizer, you must send a POST request with the following parameters in the body:
  • text (required): The AI-generated text you wish to humanize. This should be a string containing the content that needs processing.
  • humanizerIntensity (required): Defines the level of humanization to be applied to the text. The options are LOW, MEDIUM, and HIGH, allowing you to control the extent to which the text is made to feel more human-like.
    • LOW: Applies minimal humanization, making slight adjustments to make the text more readable without significantly altering its structure.
    • MEDIUM: Introduces a moderate level of humanization, improving readability and adding human-like expressions and variations to the text.
    • HIGH: Ensures the highest level of humanization, significantly transforming the text to closely mimic natural human writing styles, including idiomatic expressions and more complex linguistic nuances.
  • purpose (optional): Specifies the purpose of the text. Allows you to tailor the humanization to suit the intended audience and context of the content.
    • GENERAL (default): Applies humanization suitable for general audiences and contexts.
    • ESSAY: Tailors humanization for academic or formal writing purposes.
    • ARTICLE: Optimizes humanization for journalistic or blog-style content.
    • CREATIVE: Customizes humanization for creative writing or storytelling
    • TECHNICAL: Adapts humanization for technical or instructional content.
    • LEGAL: Adjusts humanization for legal or contractual text.
  • literacyLevel (optional): Specifies the literacy level of the text's intended audience. This allows a more accurate humanization process that aligns with the audience's reading comprehension level.
    • HIGH_SCHOOL: Adapts humanization for high school-level readers.
    • COLLEGE (default): Optimizes humanization for college-level readers.
    • DOCTORATE: Adjusts humanization for readers with advanced degrees.

Headers

Authorization (required): To authenticate your request, include your API key in the request headers using the format "Api-Key your_api_key_here".

Responses

The API responds with a JSON object containing one of the following:
  • 200: If the request is successful, the API returns a JSON object with a single key:
    • humanizedText: The transformed, humanized version of the input text as a string.
    • wordCount: The number of words that were humanized.
  • 500: If the request fails, the API returns a JSON object with an error key:
    • error: A string describing the error encountered during the request.

Example Request

POST https://the-ghost-ai-backend-005c5dcbf4a6.herokuapp.com/transformations/humanize/ Headers: { "Authorization": "Api-Key your_api_key_here" } Body: {"text": "This is a sample text generated by an AI.", "humanizerIntensity": "HIGH", "purpose": "GENERAL", "literacyLevel": "COLLEGE" }

Example Success Response

{ "humanizedText": "Here is a bit of text that has been created by some clever AI, given a personal touch to sound more like it came from a human."}

Example Error Response

{ "error": "Invalid API key provided." }

Notes

  • Ensure that your API key is valid and has not expired to avoid authorization errors.
  • The effectiveness of humanization may vary depending on the original text's complexity and the chosen intensity level. Experiment with different levels to find the optimal setting for your needs.
If you have further questions or require assistance, please refer to our support resources or contact us.

AI Detector

Overview

The AI Detection feature of our API is a powerful tool designed to analyze text and predict whether it was generated by an AI, written by a human, or contains elements of both. It outputs the likelihood of each scenario as a percentage, providing valuable insights for content verification, authenticity checks, and understanding the nature of the text's origin.

Endpoint

POST https://the-ghost-ai-backend-005c5dcbf4a6.herokuapp.com/detection/ai/

Request Parameters

To utilize the AI Detection feature, send a POST request with the following parameter in the body:
  • text (required): The text you want to analyze. This should be a string of the content for which you are seeking an AI, mixed, or human origin prediction.

Headers

Authorization (required): To authenticate your request, include your API key in the request headers using the format "Api-Key your_api_key_here".

Response

The API responds with a JSON object that includes one of the two possibilities:
  • 200: The API returns a JSON object containing the probabilities that the text is AI-generated, human-written, or a mix of both, represented as percentages:
    • ai: The percentage likelihood that the text was generated by AI.
    • mixed: The percentage likelihood that the text contains elements of both AI-generated and human-written content.
    • human: The percentage likelihood that the text was written by a human.
  • 500: If the request fails, the API returns a JSON object with an error key:
    • error: A string detailing the nature of the error encountered during the request.

Example Request

POST https://the-ghost-ai-backend-005c5dcbf4a6.herokuapp.com/detection/ai/ Headers: { "Authorization": "Api-Key your_api_key_here" } Body: {"text": "This text will be analyzed for its origin." }

Example Success Response

{ "ai": .75, "mixed": .15, "human": .1 }

Example Error Response

{ "error": "API key missing or invalid." }

Notes

  • The accuracy of the predictions may vary based on the complexity and length of the text. It is recommended to use substantial text samples for more reliable detection results.
  • Keep your API key confidential to prevent unauthorized usage.
For further assistance or more detailed inquiries, please consult our support resources or reach out to our customer service team.