Originality.ai

API V2.0 (NEW)

Scan Features

New Scan

Batch Scan

Url Scan

Retrieve Scans

Retrieve Scan

API V1.0 (Legacy)

Introduction

Authentication

Rate Limit

Auto Credit Top-up

Scan

Account

Error Messages

Default

Originality.ai API V1

AI Detector API Documentation - Originality.ai

Endpoint

Sandbox

<p>API v2.0 Reference for Originality.ai <a href="https://originality.ai/ai-checker" target="_blank">AI Detector</a>, <a href="https://originality.ai/plagiarism-checker" target="_blank">Plagiarism Checker</a>, <a href="https://originality.ai/readability-checker" target="_blank">Readability Checker</a> and Grammar Checker</p><h2>Rate Limit</h2><p>The standard rate limit for all users of the API is 500 requests per minute by IP (Max 720,000 re</p>

The standard rate limit for all users of the API is 500 requests per minute by IP (Max 720,000 requests per 24 hour period). If you find yourself reaching this limit, send an email to us at Info@originality.ai to request a higher rate limit or refer to our new batch scanning 

 . Your remaining limit for the current minute can be found by examining your response headers property ‘X-RateLimit-Remaining’. You will receive a ‘429’ response code if you exceed this rate limit.

 accounts have auto top-up enabled by default. To manage your top-up settings you can do that 

If you are concurrently calling this API and have auto top-up enabled, read the information below to avoid unwanted charges on your payment method

 you need an API key. You can create one 

if you are a legacy subscriber, grandfathered or enterprise user.

The table below displays the requests this API currently contains

<p class="slate-p " >This reference is for V1.0 of the Originality.ai API</p><p class="slate-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 class="slate-p " >This version currently supports the following endpoints:</p><p class="slate-p " ></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" ><colgroup ><col style="width:0%"><col style="width:0%"><col style="width:0%"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Name</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Type</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Endpoint</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Credit Balance</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#6C9EEB">GET</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >account/credits/balance</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Credit Usage</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#6C9EEB">GET</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >account/credits/content_scan_usage</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Payments</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#6C9EEB">GET</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >account/credits/payments</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >AI Scan</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#00FF00">POST</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >scan/ai</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Plagiarism Scan</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#00FF00">POST</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >scan/plag</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >AI &amp; Plagiarism Scan</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#00FF00">POST</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >scan/ai-plag</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >AI Url Scan</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#00FF00">POST</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >scan/url</p></td></div></tr></tbody></table></div><p class="slate-p " ></p><p class="slate-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:

<p class="slate-p" placeholder="Type / for widgets">These are the legacy api v1 endpoints. We are no longer updating this version</p><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">REST</a>. Our API has a predictable resource-oriented URLs, <a href="https://www.json.org/json-en.html">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>

These are the legacy api v1 endpoints. We are no longer updating this version

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

<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/home/api-token-dashboard" 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

<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">Originality.AI accounts have auto top-up enabled by default. To manage your accounts top-up settings visit: <a href="https://app.originality.ai/home/account#topup" target="_blank">https://app.originality.ai/home/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/home/credits/purchase" target="_blank">https://app.originality.ai/home/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><p class="slate-p" placeholder="Type / for widgets"></p>

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 class="slate-p " >The following endpoints are designated to the Originality.ai scanning functionality</p><p class="slate-p " >Use these endpoints for scanning for AI &amp;/or Plagiarism for your content</p><p class="slate-p " ></p><p class="slate-p " ></p>

The following endpoints are designated to the Originality.ai scanning functionality

Use these endpoints for scanning for AI &/or Plagiarism for your content

<p class="slate-p " >Scan a content string for AI using our state of the art AI detection models. Ensure the content string you are sending is encoded as UTF-8</p><p class="slate-p " ><span style="color:#00FF00">POST</span> https://api.originality.ai/api/v1/scan/ai</p><h3 class="slate-h3 " >AI Models</h3><p class="slate-p " >Our previous and current AI models are displayed here</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" ><colgroup ><col style="width:0%"><col style="width:0%"><col style="width:0%"><col style="width:0%"><col style="width:0%"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Version</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Name</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Reference ID</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Description</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Tags</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Lite 1.0.0</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Lite 1.0.0 Model</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >1</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Under 1% False Positive Rate. Use when you allow some use of AI for editing. Best for academia

</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >
</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >3.0.1</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >3.0.1 Turbo Model</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >2</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:rgb(56, 67, 91)">Under 5% False Positive Rate. Most accurate AI detector that is very hard to bypass. Use when you want to be certain AI was not used. Learn More </span><a href="https://originality.ai/ai-content-detection-accuracy/" target="_blank">Here</a>

</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Effective on the latest LLMs including GPT-4o, ChatGPT, Gemini Pro, 
Claude 3 and popular open-source models such as Llama 3</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Multi Language</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Multi Language</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >3</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Our Standard Model that supports languages other than English</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Russian, Spanish, Turkish, Italian, French, German, Portuguese, Dutch, Chinese (Mandarin), Greek, Polish, Vietnamese, Japanese, Persian</p></td></div></tr></tbody></table></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Scan a content string for AI using our state of the art AI detection models. Ensure the content string you are sending is encoded as UTF-8

 https://api.originality.ai/api/v1/scan/ai

Our previous and current AI models are displayed here

AI Scan

<p class="slate-p" placeholder="Type / for widgets"><div class="slate-mention_input"></div>Scan a content string for Plagiarism &amp; Readability using our plagiarism detection module. This module uses real-time Google Search results to check for plagiarism within your content. Before submitting your request, ensure the content string is UTF-8 encoded. All plagiarism requests return our custom built Readability scores for your content. More information on our readability metrics can be found here: <a href="https://originality.ai/blog/best-readability-score-to-rank-in-google">https://originality.ai/blog/best-readability-score-to-rank-in-google</a></p><p class="slate-p" placeholder="Type / for widgets"><span style="color:#00FF00" class="slate-color">POST</span> https://api.originality.ai/api/v1/scan/plag</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Scan a content string for Plagiarism & Readability using our plagiarism detection module. This module uses real-time Google Search results to check for plagiarism within your content. Before submitting your request, ensure the content string is UTF-8 encoded. All plagiarism requests return our custom built Readability scores for your content. More information on our readability metrics can be found here: 

 https://api.originality.ai/api/v1/scan/plag

Plagiarism / Readability Scan

<p class="slate-p" placeholder="Type / for widgets">Scan a content string for AI using our state of the art AI detection models and check for Plagiarism / Readability using live Google indexing. Ensure the content string you are sending is encoded as UTF-8 before submitting the request. All plagiarism results return our custom built Readability scores for your content. More information on our readability metrics can be found here: <a href="https://originality.ai/blog/best-readability-score-to-rank-in-google">https://originality.ai/blog/best-readability-scores-to-rank-in-google</a></p><p class="slate-p" placeholder="Type / for widgets">
<span style="color:#00FF00" class="slate-color">POST</span> https://api.originality.ai/api/v1/scan/ai-plag</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Scan a content string for AI using our state of the art AI detection models and check for Plagiarism / Readability using live Google indexing. Ensure the content string you are sending is encoded as UTF-8 before submitting the request. All plagiarism results return our custom built Readability scores for your content. More information on our readability metrics can be found here: 

 https://api.originality.ai/api/v1/scan/ai-plag

AI & Plagiarism / Readability Scan

<p class="slate-p" placeholder="Type / for widgets">Scan a URL for AI using our state of the art AI detection models. If the URL doesn&apos;t allow anonymous crawling, we won&apos;t be able to scan the URL. The URL must also have at least 100 words of content located within the &lt;p&gt; tags on the page.</p><p class="slate-p" placeholder="Type / for widgets"><span style="color:#00FF00" class="slate-color">POST</span> https://api.originality.ai/api/v1/scan/url</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Scan a URL for AI using our state of the art AI detection models. If the URL doesn't allow anonymous crawling, we won't be able to scan the URL. The URL must also have at least 100 words of content located within the <p> tags on the page.

 https://api.originality.ai/api/v1/scan/url