API Documentation

Introduction

Welcome to the GPT Zero API documentation. This API allows you to interact with the OpenAI GPT model for text analysis. You can perform text-based searches and receive detailed information about the provided text.

Base URL

The base URL for the API is: https://api.gpt-zero.com

Authentication

To access the GPT Zero API, you need to provide a valid API key in the request. The API key is associated with a specific user and is used for authentication.

Request Headers

  • apikey: Your unique API key.
  • text: The search query.

Endpoints & Parameters

Endpoint

  • URL: https://api.gpt-zero.com

Method

  • Method: POST

Request Parameters

  • text (required): The text you want to analyze. Must be between 30 and 12000 characters.
  • apikey (required):  Your unique API Key assign to you.

Example Request

curl -X POST -H "apikey: your-api-key" -d "text=Your text for analysis" https://api.gpt-zero.com

Example Response

{
    "status": "active",
    "content": "Your text for analysis",
    "real_percentage": 25.67,
    "fake_percentage": 74.33,
    "word_count": 50,
    "real_probability": 0.2567,
    "fake_probability": 0.7433
}

Error Responses

In case of errors, the API returns a JSON response with an “error” key containing an error message.

Example Error Response

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

Rate Limiting

The GPT Zero API has a rate limit to prevent abuse. The current rate limits for free users are:

  • Daily Limit: 50 requests per day.

If you exceed the rate limits, you will receive an error response indicating that the daily request limit has been reached.

Support

If you encounter any issues or have questions about the API, please contact our support team at [email protected].