Olive Works LLC

API Description for Business Users of ZeroGPT. <br><br>                This is a paid service that allows you to integrate our detection platform in your own custom solution. <br>                Reach to us on <a href='mailto:info@zerogpt.com'>info@zerogpt.com</a> for more info<br><br>                <b>With ZeroGPT, you can:</b><br>                <ul>                    <li>Detect AI-generated text at a document, paragraph, and sentence level.</li>                    <li>Get probabilities and detailed statistics.</li>                    <li>Run batched inference over several files.</li>                </ul>                <p>                    <ol>                        <li>Start by <a href='https://www.zerogpt.com/my-account' target='_blank' rel='noopener noreferrer'>Creating or Logging in</a> to your account.</li>                        <li>Fill your balance from within your dashboard</li>                        <li>Get your API Key from within your dashboard</li>                    </ol>                </p>                All methods return a response in this format<br>                 { <br>                     &nbsp;&nbsp;&nbsp;&nbsp;success: boolean : true or false, <br>                     &nbsp;&nbsp;&nbsp;&nbsp;code: integer : the http response code, <br>                     &nbsp;&nbsp;&nbsp;&nbsp;data: object : json object,  <br>                     &nbsp;&nbsp;&nbsp;&nbsp;message: string description or error if any <br>                 } <br><br>                Secure Methods require jwt authentication:<br>                After logging in, set Header 'Authorization'='Bearer [token generated using login]'<br><br>                Useful Fields of a detection result: <br>                h: sentences that are most likely generated by AI/GPT<br>                aiWords: number of words that are most likely generated by AI/GPT<br>                textWords: number of words inside the entire text<br>                fakePercentage: the percentage of AI generated words inside the text<br><br>                To accelerate your development even further, a Postman collection (can be directly imported in postman) available here : <a href='https://api.postman.com/collections/564519-df642187-5ab8-4ad0-b0a1-2aee313b5eb5?access_key=PMAT-01GYW6P4JGWDBAXKKJBK0GH5J9'>Postman collection</a><br>                After importing the collection, Go to 'Variables' tab, and set your token and APIKey                

Zerogpt Business API

Detect

Detect AI plagiarism in your text. Highlights the sentences that are most likely generated by AI, and returns other useful info.

Detect AI in your text

Detect AI plagiarism in your File. Highlights the sentences that are most likely generated by AI, and returns other useful info.

Detect AI in your file

Detect AI plagiarism in multiple files. Highlights the sentences that are most likely generated by AI, and returns other useful info.

Detect AI in multiple files

Detect Text Plagiarism

Detect File Plagiarism

Transform

Websocket for real time processing

Summarizes a text by specified ratio percentage. 

                                        Post Object: 

                                        {

                                            skipRealtime: 1: Use without websocket. 0: Realtime processing, pushed using websocket protocol - wsId must be posted.

                                            wsId : String : the Websocket Id obtained after connecting websocket. Does not work if skipRealtime = 1.

                                            string : String : The text to summarize

                                            maxWordsPercentage: float: The ratio by which you want to summarize, defaults to 0.15. Accepted values: from 0.01 to 0.99.

                                        }

Summarize a text

Summarizes a file by specified ratio percentage. 

                                        Form Data Fields: 

                                        skipRealtime: 1: Use without websocket. 0: Realtime processing, pushed using websocket protocol - wsId must be posted.

                                        wsId : String : the Websocket Id obtained when connecting to websocket. Does not work if skipRealtime = 0.

                                        file : FileBlob (binary array) : the file to summarize

                                        maxWordsPercentage: float: The ratio by which you want to summarize, defaults to 0.15. Accepted values: from 0.01 to 0.99.

Summarize a file

Paraphrases a text by specified tone. 

                                        Post Object: 

                                        {

                                            skipRealtime: 1: Use without websocket. 0: Realtime processing, pushed using websocket protocol - wsId must be posted.

                                            wsId : String : the Websocket Id obtained when connecting to websocket. Does not work if skipRealtime = 0.

                                            string : String : the text to paraphrase

                                            tone: String: Choose from: "Standard", "Academic", "Fluent", "Formal", "Simple", "Creative", "Engineer", "Doctor", "Lawyer", "Teenager" 

                                        }

Paraphrase a text

Paraphrases a file by specified tone. 

                                        Form Data Fields: 

                                        skipRealtime: 1: Use without websocket. 0: Realtime processing, pushed using websocket protocol - wsId must be posted.

                                        wsId : String : the Websocket Id obtained when connecting to websocket. Does not work if skipRealtime = 0.

                                        file : FileBlob (binary array) : the file to paraphrase

                                        tone: String: Choose from: "Standard", "Academic", "Fluent", "Formal", "Simple", "Creative", "Engineer", "Doctor", "Lawyer", "Teenager"

Paraphrase a file

Grammar and spell checking of a text. 

                                        Post Object: 

                                        {

                                            skipRealtime: 1: Use without websocket. 0: Realtime processing, pushed using websocket protocol - wsId must be posted.

                                            wsId : String : the Websocket Id obtained when connecting to websocket. Does not work if skipRealtime = 0.

                                            string : String : the text to grammar check

                                        }

Grammar and spell Check a text

Grammar and spell checking of a file. 

                                        Form Data Fields: 

                                        skipRealtime: 1: Use without websocket. 0: Realtime processing, pushed using websocket protocol - wsId must be posted.

                                        wsId : String : the Websocket Id obtained when connecting to websocket. Does not work if skipRealtime = 0.

                                        file : FileBlob (binary array) : the file to grammar check

Grammar and Spell Check a file

Chat with a very smart bot. If conversation_id is 0, a new conversation object will be created for you, and returned in the response

Chat with AI bot

Retrieve the list of conversations initiated by a user

Get list of conversations

Retrieve the list of messages of a conversation

Get a conversation's messages

Translate a text from a language, if the source language is not known, the source language will be returned by the http response in the end. 

                                        Post Object: 

                                        {

                                            skipRealtime: 1: Use without websocket. 0: Realtime processing, pushed using websocket protocol - wsId must be posted.

                                            wsId : String : the Websocket Id obtained when connecting to websocket. Does not work if skipRealtime = 0.

                                            string : String : the text you would like to translate

                                            fromLanguage: String : Source language, use normal english language names: English, French, Portuguese, German, etc...

                                            toLanguage: String : Target Language, use normal english language names: English, French, Portuguese, German, etc...

                                        }

AI Text Translator

Write an email, or generate an email reply 

                                        Post Object: 

                                        {

                                            skipRealtime: 1: Use without websocket. 0: Realtime processing, pushed using websocket protocol - wsId must be posted.

                                            wsId : String : the Websocket Id obtained when connecting to websocket. Does not work if skipRealtime = 0.

                                            string : String : the text or topic you would like to generate email from

                                            emailType: String : Choose from "Compose" (Write a new email), "reply" (Reply to email) 

                                            length: length of the email in words : From 1 to 500

                                            purpose: String: the email purpose

                                            recipient: Email String of recipient

                                            sender: Email String of sender

                                            subjectLine: email subject

                                            tone: Choose from "Masculine", "Friendly", "Funny", "Casual", "Excited", "Professional", "Witty", "Luxury", "Adventurous", "Sarcastic", "Feminine", "Bold", "Dramatic", "Grumpy", "Secretive", "Persuasive"

                                        }

Email generator

Auth

Mandatory step to retrieve your token,<br>Access your token via data.token

Login

Generate mandatory api key required for detection<br>                                            Only required Once, The api key doesn't expire

Generateapikey

Use if you forgot your password, a temporary link will be sent to your email to reset your password

Forgotpassword

Resetpassword

Resendverificationemail

Dashboard

Getstats

Change Password

Change Personal settings of logged in user

Get packages

Change your current package, package type must be API (1)

Change your api package.

Get list of all detection results made by the logged in user.

Get detection results

Retrieve all created collections (batches) by current logged in user.

Get Collections

retrieve the status of the collection, as well as the scores of the files that have finished processing<br>                                                Status:<br>                                                0: Pending, no file has been processed yet<br>                                                1: Is currently being processed <br>                                                2: Has successfully finished processing all files<br>                                                -1: An error was encountered in at least 1 file

Check Collection

Delete a collection and all related detection results

Delete Collection

Set the IP addresses for the servers, in a csv string.

Set IP whitelist

Export the detection result to pdf and automatically download your file

Export to pdf

Get Detection Result

Return list of conversations with the AI bot.

Get Conversations

Get List of messages belonging to a conversation.

Get Messages

Change Social Settings.

ZeroGPT Business API

ZeroGPT Documentation

ZeroGPT provides api to develop your own custom solutions: AI Detector, Summarizer, Paraphraser, Chat, Translator, Email Helper

Production

Sandbox

<p class="slate-p " >The Zerogpt Business API section enables business users to seamlessly integrate our AI detection platform into their own applications. With ZeroGPT, users can easily detect AI-generated text at various levels within documents. This API empowers businesses to enhance their content moderation and fraud detection processes with accurate and efficient AI-powered detection capabilities.</p><p class="slate-p " >Moreover, You can, summarize, paraphrase, chat, grammar and spell check, translate your texts </p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

The Zerogpt Business API section enables business users to seamlessly integrate our AI detection platform into their own applications. With ZeroGPT, users can easily detect AI-generated text at various levels within documents. This API empowers businesses to enhance their content moderation and fraud detection processes with accurate and efficient AI-powered detection capabilities.

Moreover, You can, summarize, paraphrase, chat, grammar and spell check, translate your texts 

<p class="slate-p " ><p class="slate-p " >Smart Realtime Text Transformer: Summarize, paraphrase, grammar check, chat, translate, email helper</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p></p><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " >Websocket allowing realtime communication

Base Url</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">const wsUrl = “<a href="https://api.zerogpt.com/api/transform/ws" target="_self">wss://api.zerogpt.com/api/transform/ws</a>”</div></code></pre></div><p class="slate-p " >Connecting to this websocket will push you a Client Id, which shall be used by all proceeding methods</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">setClientId,&lt;WebSocketId&gt;</div></code></pre></div><p class="slate-p " >Everytime a connection to websocket is lost, you should reconnect to websocket</p><p class="slate-p " >WebSocketId is used in all proceeding methods, so store it safely in your web app, and use it while it&apos;s valid and the connection is open</p><p class="slate-p " >A Sample code is provided in javascipt:</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">this.ws = new WebSocket(wsUrl);</div><div class="slate-code_line"></div><div class="slate-code_line">this.ws.onopen = () =&gt; {
  this.connected = true;
};</div><div class="slate-code_line"></div><div class="slate-code_line">this.ws.onmessage = this.updateResponse</div><div class="slate-code_line"></div><div class="slate-code_line"></div><div class="slate-code_line"></div><div class="slate-code_line">this.ws.onclose = () =&gt; {</div><div class="slate-code_line">     this.connected = false;</div><div class="slate-code_line"></div><div class="slate-code_line">};</div><div class="slate-code_line"></div><div class="slate-code_line">updateTextFromSocketEvent(event) {</div><div class="slate-code_line">  var msg = event.data</div><div class="slate-code_line">  var msgArr = msg.split(&apos;,&apos;)</div><div class="slate-code_line">  </div><div class="slate-code_line">  if(msgArr[0] === &apos;setClientId&apos;) {</div><div class="slate-code_line">      this.wsId= msgArr[1];</div><div class="slate-code_line">  }</div><div class="slate-code_line">  else if(msgArr[0] === &apos;done&apos;) {</div><div class="slate-code_line">      this.isReceiving = false</div><div class="slate-code_line">  }</div><div class="slate-code_line">  else {</div><div class="slate-code_line">    if(msg.includes(&apos;\n&apos;)) {</div><div class="slate-code_line">        msg = msg.replace(&apos;\n&apos;, &apos;&lt;br&gt;&apos;)</div><div class="slate-code_line">    }</div><div class="slate-code_line">    this.receivedData += msg</div><div class="slate-code_line">  }</div><div class="slate-code_line">}</div></code></pre></div><p class="slate-p " >You should be able to add this piece of code anywhere you need access to realtime processing in your code</p><p class="slate-p " >Keep in mind, to add this piece of code, or an alternative in other languages if you plan on doing realtime processing in your web app.</p><p class="slate-p " ></p>

Websocket allowing realtime communication

Base Url

Connecting to this websocket will push you a Client Id, which shall be used by all proceeding methods

Everytime a connection to websocket is lost, you should reconnect to websocket

WebSocketId is used in all proceeding methods, so store it safely in your web app, and use it while it's valid and the connection is open

You should be able to add this piece of code anywhere you need access to realtime processing in your code

Keep in mind, to add this piece of code, or an alternative in other languages if you plan on doing realtime processing in your web app.

<p class="slate-p " >Summarize a specified text</p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

string

the Websocket Id obtained after connecting websocket. Does not work if skipRealtime = 1.

wsId

0 or 1. 1: Use without websocket. 0: Realtime processing, pushed using websocket protocol - wsId must be posted

skipRealtime

The ratio by which you want to summarize, defaults to 0.15. Accepted values: from 0.01 to 0.99.

maxWordsPercentage

If you are using the VIP setting, this parameter can have one of two values: quick and thinking.
quick is obviously faster, 
thinking gives you a better answer but is slower

gen_speed

ApiKey

If the response has correctly passed through the api logic, successfully or wether an error occurred.

success

code

message

The object or array returned by the operation

data

detail

<p class="slate-p " ><p class="slate-p " >Summarizes a file by specified ratio percentage.</p></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

the Websocket Id obtained when connecting to websocket. Does not work if skipRealtime = 1

The ratio by which you want to summarize, defaults to 0.15. Accepted values: from 0.01 to 0.99

the file to summarize, should be a file blob (binary array)

file

1: Use without websocket. 0: Begin text processing, and as soon as a response is found, push it using websocket protocol - wsId must be posted in this case, a service result object will be returned at the end.

The Object returned. May be a single object if the operation corresponds to a single object; or an array of objects.

<p class="slate-p " ><p class="slate-p " >Paraphrases a text by specified tone.</p></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Websocket identifier retrieved after connecting to /ws using websocket

Tone of paraphraser. Choose from: "Standard", "Academic", "Fluent", "Formal", "Simple", "Creative", "Engineer", "Doctor", "Lawyer", "Teenager"

tone

<p class="slate-p " >Paraphrases a file by specified tone.</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p " >Grammar and spell checking of a text.</p></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " >Grammar and spell checking of a file.</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

Web Socket Identifier for realtime processing

1: Use without websocket. 0: Realtime processing, pushed using websocket protocol - wsId must be posted

<p class="slate-p " ><p class="slate-p " >Chat with a very smart bot. If conversation_id = 0, a new conversation object will be created for you, and returned in response</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

4 or 5; 5 is only available for MAX users.

chatVersion

<p class="slate-p " ><p class="slate-p " >Retrieve the list of conversations initiated by a user</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p " >Retrieve the list of messages of a conversation</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

conversation_id

<p class="slate-p " ><p class="slate-p " >Translate a text from a language, if the source language is not known, the source language will be returned by the http response in the end.</p></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

Source language, use normal english language names: English, French, Portuguese, German, etc... Leave empty to automatically detect language.

fromLanguage

Target Language, use normal english language names: English, French, Portuguese, German, etc...

toLanguage

<p class="slate-p " ><p class="slate-p " >Write an email, or generate an email reply</p></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

emailType

Example: to propose a new marketing campaign that will be effective for your business.

purpose

The received email, in case you're replying (writing a response) to it.

receivedEmail

purposeGoal

Email Title, example: Proposal for Marketing Campaign.

subjectLine

recipient

sender

Number of words to generate, accepted values from 10 to 500

length

The tone of the email. Choose from "Masculine", "Friendly", "Funny", "Casual", "Excited", "Professional", "Witty", "Luxury", "Adventurous", "Sarcastic", "Feminine", "Bold", "Dramatic", "Grumpy", "Secretive", "Persuasive"

emailTone

Language used by the email. Use normal english language names: English, French, Portuguese, German, etc...

emailLanguage

<p class="slate-p " >The Auth section of the ZeroGPT API allows users to authenticate and securely access their account information. With this section, users can verify their identity and ensure their data remains protected. This functionality enables a seamless and secure user experience within the ZeroGPT platform.</p><p class="slate-p " ></p>

The Auth section of the ZeroGPT API allows users to authenticate and securely access their account information. With this section, users can verify their identity and ensure their data remains protected. This functionality enables a seamless and secure user experience within the ZeroGPT platform.

<p class="slate-p " >Dashboard API for ZeroGPT</p><p class="slate-p " ></p>

Sections