Originality.ai

Introduction

Authentication

Rate Limit

Auto Credit Top-up

API V1.0 Reference

Scan

Account

Error Messages

API V2.0 (Coming Soon)

Default

API Url

Sandbox

Originality.ai API V1

<p class="slate-p" placeholder="Type / for widgets">Welcome to the API documentation for Originality.AI</p><p class="slate-p" placeholder="Type / for widgets">The Originality API is organized around <a href="http://en.wikipedia.org/wiki/Representational_State_Transfer" target="_blank">REST</a>. Our API has a predictable resource-oriented URLs, <a href="https://www.json.org/json-en.html" target="_blank">json-encoded </a>request bodies / responses and uses standard HTTP response codes and authorization over our custom X-OAI-API-KEY header property.</p><p class="slate-p" placeholder="Type / for widgets">You can use the Originality API directly into your work flow. If you are an agency or an individual, you can easily check content for AI generated text and Plagiarism using this api</p><p class="slate-p" placeholder="Type / for widgets">Currently, this API doesn&apos;t support batch actions within a request. With our increased rate limit per IP (500/minute) you can send concurrent requests using your favourite request library with ease. </p><p class="slate-p" placeholder="Type / for widgets">This documentation will be continuously updated to reflect new API versions and changes</p><p class="slate-p" placeholder="Type / for widgets"></p>

Welcome to the API documentation for Originality.AI

. Our API has a predictable resource-oriented URLs, 

request bodies / responses and uses standard HTTP response codes and authorization over our custom X-OAI-API-KEY header property.

You can use the Originality API directly into your work flow. If you are an agency or an individual, you can easily check content for AI generated text and Plagiarism using this api

Currently, this API doesn't support batch actions within a request. With our increased rate limit per IP (500/minute) you can send concurrent requests using your favourite request library with ease. 

This documentation will be continuously updated to reflect new API versions and changes

Tab 1

<p class="slate-p" placeholder="Type / for widgets">In order to start making API requests to Originality.AI you first need to create an API Key. You can do so <a href="https://app.originality.ai/api-access" target="_blank">here</a></p><p class="slate-p" placeholder="Type / for widgets">All requests require the following headers </p><table class="slate-table"><colgroup></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p slate-indent-1" style="margin-left:24px" placeholder="Type / for widgets">Key</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p slate-indent-1" style="margin-left:24px" placeholder="Type / for widgets">Type</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">Value</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">Accept</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">string</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">application/json</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">X-OAI-API-KEY</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">string</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><p class="slate-p" placeholder="Type / for widgets">your-api-key</p></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr></tbody></table><p class="slate-p" placeholder="Type / for widgets"></p><h1 class="slate-h1">Responses</h1><p class="slate-p" placeholder="Type / for widgets">All responses are returned as a JSON object</p><p class="slate-p" placeholder="Type / for widgets"></p>

In order to start making API requests to Originality.AI you first need to create an API Key. You can do so 

All requests require the following headers 

All responses are returned as a JSON object

200 - OK

An error occurred with the request. See the error response message for more information

422 - Bad request

404 - Not Found

429 - Too Many Requests

<p class="slate-p" placeholder="Type / for widgets">The rate limit for the Originality.AI API is 500 requests per minute by IP (Max 720,000 requests per 24 hour period) - If you need more requests, send an email to us at info@originality.ai</p><p class="slate-p" placeholder="Type / for widgets">Your remaining limit for the current minute can be found by examining your response headers property “X-RateLimit-Remaining”. Exceeding the request limit will return a “429 too many requests” error and will be refreshed at the start of the next minute</p><p class="slate-p" placeholder="Type / for widgets"></p>

The rate limit for the Originality.AI API is 500 requests per minute by IP (Max 720,000 requests per 24 hour period) - If you need more requests, send an email to us at info@originality.ai

Your remaining limit for the current minute can be found by examining your response headers property “X-RateLimit-Remaining”. Exceeding the request limit will return a “429 too many requests” error and will be refreshed at the start of the next minute

<p class="slate-p" placeholder="Type / for widgets">By default, Originality.AI accounts have auto top-up enabled by default. To manage your accounts top-up settings visit: <a href="https://app.originality.ai/account#topup" target="_blank">https://app.originality.ai/account#topup</a></p><p class="slate-p" placeholder="Type / for widgets">Important:</p><p class="slate-p" placeholder="Type / for widgets">If you are concurrently calling this API and have the auto top-up feature enabled, you may see duplicate charges on your credit card statement. Tips to avoid this: </p><p class="slate-p" placeholder="Type / for widgets">a) Reduce concurrency</p><p class="slate-p" placeholder="Type / for widgets">b) Disable Auto Top-up &amp; manually purchase additional credits: <a href="https://app.originality.ai/credits/purchase" target="_blank">https://app.originality.ai/credits/purchase</a></p><p class="slate-p" placeholder="Type / for widgets">c) If you plan on making hundreds to thousands of request per day, it&apos;s advised to purchase more credits to ensure your account runs smoothly</p>

By default, Originality.AI accounts have auto top-up enabled by default. To manage your accounts top-up settings visit: 

If you are concurrently calling this API and have the auto top-up feature enabled, you may see duplicate charges on your credit card statement. Tips to avoid this: 

b) Disable Auto Top-up & manually purchase additional credits: 

c) If you plan on making hundreds to thousands of request per day, it's advised to purchase more credits to ensure your account runs smoothly

<p>This reference is for V1.0 of the Originality.ai API</p><p>Endpoints are suffixed to the API base url: “<a href="https://api.originality.ai/api/v1/" target="_self">https://api.originality.ai/api/v1/</a>”</p><p>This version currently supports the following endpoints:</p><p></p>

This reference is for V1.0 of the Originality.ai API

Endpoints are suffixed to the API base url: “

This version currently supports the following endpoints: