open_api.json

{
  "openapi": "3.0.0",
  "info": {
    "title": "GPTZero API",
    "version": "2.0.0",
    "description": "API to predict whether text was generated by AI."
  },
  "servers": [
    {
      "url": "https://gptzero-chat-plugin.drengskapur.workers.dev"
    }
  ],
  "paths": {
    "/predict": {
      "post": {
        "operationId": "predict",
        "summary": "This endpoint takes in a single text input and returns the model's result.",
        "requestBody": {
          "description": "Takes in a JSON as the body of the request where the text input is value to \"document\" key",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "document": {
                    "type": "string"
                  }
                },
                "required": [
                  "document"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful operation. Returns a DocumentPredictions object containing length-1 array \"documents\" for the input",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DocumentPredictions"
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DocumentContentError"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "DocumentPredictions": {
        "type": "object",
        "properties": {
          "documents": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "average_generated_prob": {
                  "type": "number",
                  "description": "The average of the probabilties that each sentence was generated by an AI"
                },
                "completely_generated_prob": {
                  "type": "number",
                  "description": "The probability that the entire document was generated by an AI"
                },
                "overall_burstiness": {
                  "type": "number",
                  "description": "The amount of variation in the perplexity of the document. A useful indicator to distinguish AI and human written text"
                },
                "sentences": {
                  "type": "array",
                  "description": "Information about each sentence is contained in this array, and the sentences in the document are listed in order.",
                  "items": {
                    "type": "object",
                    "properties": {
                      "sentence": {
                        "type": "string"
                      },
                      "perplexity": {
                        "description": "The lower the perplexity, the more likely an AI would have generated this sentence",
                        "type": "number"
                      },
                      "generated_prob": {
                        "description": "The probability that this sentence was generated by an AI. Our current model predicts 0/1 labels, but this may change to be a percentage in the future.",
                        "type": "number"
                      }
                    }
                  }
                },
                "paragraphs": {
                  "type": "array",
                  "description": "Paragraphs are newline-delimited bodies of text in the document",
                  "items": {
                    "type": "object",
                    "properties": {
                      "start_sentence_index": {
                        "type": "number",
                        "description": "The index in the `sentences` array of the first sentence of the paragraph"
                      },
                      "num_sentences": {
                        "type": "number",
                        "description": "The number of sentences in this paragraph."
                      },
                      "completely_generated_prob": {
                        "type": "number",
                        "description": "The probability that the entire paragraph was generated by an AI"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "DocumentContentError": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string"
          }
        }
      }
    },
    "securitySchemes": {
      "ApiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Api-Key"
      }
    }
  },
  "security": [
    {
      "ApiKey": []
    }
  ]
}