{"id":3414,"date":"2023-12-18T14:51:26","date_gmt":"2023-12-18T14:51:26","guid":{"rendered":"https:\/\/community.plagium.com\/docs\/dates-updates\/changelog\/"},"modified":"2024-02-19T22:26:44","modified_gmt":"2024-02-19T22:26:44","slug":"api-v3","status":"publish","type":"docs","link":"https:\/\/community.plagium.com\/fr\/docs\/api\/api-v3\/","title":{"rendered":"API v3"},"content":{"rendered":"\n<div class=\"wp-block-getwid-tabs\" data-active-tab=\"0\"><ul class=\"wp-block-getwid-tabs__nav-links\"><\/ul>\n<div class=\"wp-block-getwid-tabs__nav-link\"><span class=\"wp-block-getwid-tabs__title-wrapper\"><a href=\"#\"><span class=\"wp-block-getwid-tabs__title\"><strong>Send text document<\/strong><\/span><\/a><\/span><\/div><div class=\"wp-block-getwid-tabs__tab-content-wrapper\"><div class=\"wp-block-getwid-tabs__tab-content\">\n<pre class=\"wp-block-code\"><code>https:&#47;&#47;api.plagium.com\/300\/document\/create<\/code><\/pre>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Argument<\/strong><\/th><th><strong>Required<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">key<\/mark><\/td><td>yes<\/td><td>Your API Key<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.text<\/mark><\/td><td>yes<\/td><td>Text<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.title<\/mark><\/td><td>no<\/td><td>Document title<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.description<\/mark><\/td><td>no<\/td><td>Document description<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.author<\/mark><\/td><td>no<\/td><td>Document author<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.keywords<\/mark><\/td><td>no<\/td><td>Document keywords<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.source<\/mark><\/td><td>no<\/td><td>Scope of the search.<br>Possible values:<br>&#8211; <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">web<\/mark>: search over the web<br>&#8211; <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">file<\/mark>: compare with my documents<br>Default is: <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">[&#8220;web&#8221;]<\/mark>.<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.type<\/mark><\/td><td>no<\/td><td>Search type. Possible values:<br>&#8211; <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">quick<\/mark>: for a quick search (only available with data.source=web)<br>&#8211; <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">deep<\/mark>: for a deep search<br>Default is: <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">&#8220;deep&#8221;<\/mark>.<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.import_id<\/mark><\/td><td>no<\/td><td>The id of your document for consolidation usage<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.min_rank<\/mark><\/td><td>no<\/td><td>Minimum amount percentage (0 to 100) of common meaningful words between two sentences.<br>Default is: <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">45.0<\/mark>.<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.min_relation<\/mark><\/td><td>no<\/td><td>Minimum similarity (0.0 to 1.0) between two sentences. Default is: <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">0.4<\/mark>.<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.webhook.url<\/mark><\/td><td>no<\/td><td>The webhook will make an HTTP POST request to your app with information about your search.<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.webhook.format<\/mark><\/td><td>no<\/td><td>Webhook data format. Possible values:<br>&#8211; <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">simple<\/mark>: only send search and cost information<br>&#8211; <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">document<\/mark>: send information about document, search, and cost<br>Default is: <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">simple<\/mark>.<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.webhook.metadata<\/mark><\/td><td>no<\/td><td>Webhook metadata. User data, can be anything JSON object. Metadata is returned with the webhook callback.<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.user_id<\/mark><\/td><td>no<\/td><td>Sub account user id. If set, search will be processed under sub account user.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/div><\/div>\n\n\n\n<div class=\"wp-block-getwid-tabs__nav-link\"><span class=\"wp-block-getwid-tabs__title-wrapper\"><a href=\"#\"><span class=\"wp-block-getwid-tabs__title\">Node.js Example<\/span><\/a><\/span><\/div><div class=\"wp-block-getwid-tabs__tab-content-wrapper\"><div class=\"wp-block-getwid-tabs__tab-content\">\n<pre class=\"wp-block-code\"><code>const http = require(\"http\");\n\nconst options = {\n    \"method\": \"POST\",\n    \"hostname\": \"https:\/\/api.plagium.com\",\n    \"port\": \"3000\",\n    \"path\": \"\/300\/document\/create\",\n    \"headers\": {\n        \"Content-Type\": \"application\/json\",\n    }\n};\n\nconst req = http.request(options, function (res) {\n    const chunks = &#91;];\n\n    res.on(\"data\", function (chunk) {\n        chunks.push(chunk);\n    });\n\n    res.on(\"end\", function () {\n        const body = Buffer.concat(chunks);\n        console.log(body.toString());\n    });\n});\n\nreq.write(JSON.stringify({\n        key: '&#91;YOUR API KEY]',\n        data: {\n        text: 'While Wolfgang was young, his family made several European journeys in which he and Nannerl performed as child prodigies. These began with an exhibition in 1762 at the court of Prince-elector Maximilian III of Bavaria in Munich, and at the Imperial Courts in Vienna and Prague.',\n        read: 'public'\n    }\n}));\nreq.end();\n\n<\/code><\/pre>\n<\/div><\/div>\n<\/div>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<div class=\"wp-block-getwid-tabs\" data-active-tab=\"0\"><ul class=\"wp-block-getwid-tabs__nav-links\"><\/ul>\n<div class=\"wp-block-getwid-tabs__nav-link\"><span class=\"wp-block-getwid-tabs__title-wrapper\"><a href=\"#\"><span class=\"wp-block-getwid-tabs__title\"><strong>Upload document<\/strong><\/span><\/a><\/span><\/div><div class=\"wp-block-getwid-tabs__tab-content-wrapper\"><div class=\"wp-block-getwid-tabs__tab-content\">\n<pre class=\"wp-block-code\"><code>https:&#47;&#47;api.plagium.com\/300\/document\/upload<\/code><\/pre>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Argument<\/strong><\/th><th><strong>Required<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">key<\/mark><\/td><td><strong>yes<\/strong><\/td><td>Your API Key<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.title<\/mark><\/td><td>no<\/td><td>Document title<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.description<\/mark><\/td><td>no<\/td><td>Document description<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.author<\/mark><\/td><td>no<\/td><td>Document author<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.keywords<\/mark><\/td><td>no<\/td><td>Document keywords<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.source<\/mark><\/td><td>no<\/td><td>Scope of the search.<br>Possible values:<br>&#8211; <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">web<\/mark>: search over the web<br>&#8211; <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">file<\/mark>: compare with my documents<br>Default is: <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">[&#8220;web&#8221;]<\/mark>.<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.type<\/mark><\/td><td>no<\/td><td>Search type. Possible values:<br>&#8211; <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">quick<\/mark>: for a quick search (only available with data.source=web)<br>&#8211; <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">deep<\/mark>: for a deep search<br>Default is: <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">&#8220;deep&#8221;<\/mark>.<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.import_id<\/mark><\/td><td>no<\/td><td>The id of your document for consolidation usage<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.min_rank<\/mark><\/td><td>no<\/td><td>Minimum amount percentage (0 to 100) of common meaningful words between two sentences.<br>Default is: <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">45.0<\/mark>.<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.min_relation<\/mark><\/td><td>no<\/td><td>Minimum similarity (0.0 to 1.0) between two sentences. Default is: <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">0.4<\/mark>.<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.webhook.url<\/mark><\/td><td>no<\/td><td>The webhook will make an HTTP POST request to your app with information about your search.<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.webhook.format<\/mark><\/td><td>no<\/td><td>Webhook data format. Possible values:<br>&#8211; <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">simple<\/mark>: only send search and cost information<br>&#8211; <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">document<\/mark>: send information about document, search, and cost<br>Default is: <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">simple<\/mark>.<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.webhook.metadata<\/mark><\/td><td>no<\/td><td>Webhook metadata. User data, can be anything JSON object. Metadata is returned with the webhook callback.<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">data.user_id<\/mark><\/td><td>no<\/td><td>Sub account user id. If set, search will be processed under sub account user.<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/div><\/div>\n\n\n\n<div class=\"wp-block-getwid-tabs__nav-link\"><span class=\"wp-block-getwid-tabs__title-wrapper\"><a href=\"#\"><span class=\"wp-block-getwid-tabs__title\">Node.js Example<\/span><\/a><\/span><\/div><div class=\"wp-block-getwid-tabs__tab-content-wrapper\"><div class=\"wp-block-getwid-tabs__tab-content\">\n<pre class=\"wp-block-code\"><code>const http = require(\"http\");\n\nconst boundary = '011000010111000001101001';\n\nconst options = {\n    \"method\": \"POST\",\n    \"hostname\": \"https:\/\/api.plagium.com\",\n    \"port\": \"3000\",\n    \"path\": \"\/300\/document\/upload\",\n    \"headers\": {\n        \"Content-Type\": `multipart\/form-data; boundary=---${boundary}`,\n    }\n};\n\nconst req = http.request(options, function (res) {\n    const chunks = &#91;];\n\n    res.on(\"data\", function (chunk) {\n        chunks.push(chunk);\n    });\n\n    res.on(\"end\", function () {\n        const body = Buffer.concat(chunks);\n        console.log(body.toString());\n    });\n});\n\nreq.write(`-----${boundary}\\r\\nContent-Disposition: form-data; name=\\\"file\\\"; filename=\\\"example.pdf\\\"\\r\\nContent-Type: application\/pdf\\r\\n\\r\\n\\r\\n-----${boundary}\\r\\nContent-Disposition: form-data; name=\\\"data\\\"\\r\\n\\r\\n{\\n\\t\\\"title\\\": \\\"Example of document\\\",\\n\\t\\\"read\\\": \\\"public\\\"\\n}\\r\\n-----${boundary}\\r\\nContent-Disposition: form-data; name=\\\"key\\\"\\r\\n\\r\\n75B9C398F5B42A3229E1F9FFBAF63CCB4A0F5C981548834C962C4941DB3956880F781F951C78E8FF\\r\\n-----${boundary}--\\r\\n`);\nreq.end();<\/code><\/pre>\n<\/div><\/div>\n<\/div>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<div class=\"wp-block-getwid-tabs\" data-active-tab=\"0\"><ul class=\"wp-block-getwid-tabs__nav-links\"><\/ul>\n<div class=\"wp-block-getwid-tabs__nav-link\"><span class=\"wp-block-getwid-tabs__title-wrapper\"><a href=\"#\"><span class=\"wp-block-getwid-tabs__title\"><strong>Get document<\/strong><\/span><\/a><\/span><\/div><div class=\"wp-block-getwid-tabs__tab-content-wrapper\"><div class=\"wp-block-getwid-tabs__tab-content\">\n<pre class=\"wp-block-code\"><code>https:&#47;&#47;api.plagium.com\/300\/document\/get\n<\/code><\/pre>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Argument<\/strong><\/th><th><strong>Required<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">key<\/mark><\/td><td><strong>yes<\/strong><\/td><td>Your API Key<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code>data.id<\/code><\/mark><\/td><td><strong>yes<\/strong><\/td><td>Document ID GUID<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code>data.user_id<\/code><\/mark><\/td><td>no<\/td><td>Sub account user id<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/div><\/div>\n\n\n\n<div class=\"wp-block-getwid-tabs__nav-link\"><span class=\"wp-block-getwid-tabs__title-wrapper\"><a href=\"#\"><span class=\"wp-block-getwid-tabs__title\">Node.js Example<\/span><\/a><\/span><\/div><div class=\"wp-block-getwid-tabs__tab-content-wrapper\"><div class=\"wp-block-getwid-tabs__tab-content\">\n<pre class=\"wp-block-code\"><code>const http = require(\"http\");\n\nconst options = {\n    \"method\": \"POST\",\n    \"hostname\": \"https:\/\/api.plagium.com\",\n    \"port\": \"3000\",\n    \"path\": \"\/300\/document\/get\",\n    \"headers\": {\n        \"Content-Type\": \"application\/json\",\n    }\n};\n\nconst req = http.request(options, function (res) {\n    const chunks = &#91;];\n\n    res.on(\"data\", function (chunk) {\n        chunks.push(chunk);\n    });\n\n    res.on(\"end\", function () {\n        const body = Buffer.concat(chunks);\n        console.log(body.toString());\n    });\n});\n\nreq.write(JSON.stringify({\n    key: '&#91;YOUR API KEY]',\n    data: {\n        id: '&#91;DOCUMENT ID]',\n    },\n}));\nreq.end();<\/code><\/pre>\n<\/div><\/div>\n<\/div>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<div class=\"wp-block-getwid-tabs\" data-active-tab=\"0\"><ul class=\"wp-block-getwid-tabs__nav-links\"><\/ul>\n<div class=\"wp-block-getwid-tabs__nav-link\"><span class=\"wp-block-getwid-tabs__title-wrapper\"><a href=\"#\"><span class=\"wp-block-getwid-tabs__title\"><strong>Get results<\/strong><\/span><\/a><\/span><\/div><div class=\"wp-block-getwid-tabs__tab-content-wrapper\"><div class=\"wp-block-getwid-tabs__tab-content\">\n<pre class=\"wp-block-code\"><code>https:&#47;&#47;api.plagium.com\/300\/document\/results\n<\/code><\/pre>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Argument<\/strong><\/th><th><strong>Required<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">key<\/mark><\/td><td><strong>yes<\/strong><\/td><td>Your API Key<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code>data.id<\/code><\/mark><\/td><td><strong>yes<\/strong><\/td><td>Document ID GUID<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code>data.user_id<\/code><\/mark><\/td><td>no<\/td><td>Sub account user id<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/div><\/div>\n\n\n\n<div class=\"wp-block-getwid-tabs__nav-link\"><span class=\"wp-block-getwid-tabs__title-wrapper\"><a href=\"#\"><span class=\"wp-block-getwid-tabs__title\">Node.js Example<\/span><\/a><\/span><\/div><div class=\"wp-block-getwid-tabs__tab-content-wrapper\"><div class=\"wp-block-getwid-tabs__tab-content\">\n<pre class=\"wp-block-code\"><code>const http = require(\"http\");\n\nconst options = {\n    \"method\": \"POST\",\n    \"hostname\": \"https:\/\/api.plagium.com\",\n    \"port\": \"3000\",\n    \"path\": \"\/300\/document\/results\",\n    \"headers\": {\n        \"Content-Type\": \"application\/json\",\n    }\n};\n\nconst req = http.request(options, function (res) {\n    const chunks = &#91;];\n\n    res.on(\"data\", function (chunk) {\n        chunks.push(chunk);\n    });\n\n    res.on(\"end\", function () {\n        const body = Buffer.concat(chunks);\n        console.log(body.toString());\n    });\n});\n\nreq.write(JSON.stringify({\n    key: '&#91;YOUR API KEY]',\n    data: {id: '&#91;DOCUMENT ID]'}\n}));\nreq.end();<\/code><\/pre>\n<\/div><\/div>\n<\/div>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<div class=\"wp-block-getwid-tabs\" data-active-tab=\"0\"><ul class=\"wp-block-getwid-tabs__nav-links\"><\/ul>\n<div class=\"wp-block-getwid-tabs__nav-link\"><span class=\"wp-block-getwid-tabs__title-wrapper\"><a href=\"#\"><span class=\"wp-block-getwid-tabs__title\"><strong>Get remaining credits<\/strong><\/span><\/a><\/span><\/div><div class=\"wp-block-getwid-tabs__tab-content-wrapper\"><div class=\"wp-block-getwid-tabs__tab-content\">\n<pre class=\"wp-block-code\"><code>https:&#47;&#47;api.plagium.com\/300\/account\/remaining_credits\n<\/code><\/pre>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Argument<\/strong><\/th><th><strong>Required<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">key<\/mark><\/td><td><strong>yes<\/strong><\/td><td>Your API Key<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/div><\/div>\n<\/div>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<div class=\"wp-block-getwid-tabs\" data-active-tab=\"0\"><ul class=\"wp-block-getwid-tabs__nav-links\"><\/ul>\n<div class=\"wp-block-getwid-tabs__nav-link\"><span class=\"wp-block-getwid-tabs__title-wrapper\"><a href=\"#\"><span class=\"wp-block-getwid-tabs__title\"><strong>List sub accounts (available only for institutional account)<\/strong><\/span><\/a><\/span><\/div><div class=\"wp-block-getwid-tabs__tab-content-wrapper\"><div class=\"wp-block-getwid-tabs__tab-content\">\n<pre class=\"wp-block-code\"><code>https:&#47;&#47;api.plagium.com\/300\/sub_account\/list\n<\/code><\/pre>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Argument<\/strong><\/th><th><strong>Required<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">key<\/mark><\/td><td><strong>yes<\/strong><\/td><td>Your API Key<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/div><\/div>\n<\/div>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<div class=\"wp-block-getwid-tabs\" data-active-tab=\"0\"><ul class=\"wp-block-getwid-tabs__nav-links\"><\/ul>\n<div class=\"wp-block-getwid-tabs__nav-link\"><span class=\"wp-block-getwid-tabs__title-wrapper\"><a href=\"#\"><span class=\"wp-block-getwid-tabs__title\"><strong>Create sub account (available only for institutional account)<\/strong><\/span><\/a><\/span><\/div><div class=\"wp-block-getwid-tabs__tab-content-wrapper\"><div class=\"wp-block-getwid-tabs__tab-content\">\n<pre class=\"wp-block-code\"><code>https:&#47;&#47;api.plagium.com\/300\/sub_account\/create\n<\/code><\/pre>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Argument<\/strong><\/th><th><strong>Required<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">key<\/mark><\/td><td><strong>yes<\/strong><\/td><td>Your API Key<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code>data.firstname<\/code><\/mark><\/td><td>no<\/td><td>User firstname<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code>data.lastname<\/code><\/mark><\/td><td>no<\/td><td>User lastname<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code>data.email<\/code><\/mark><\/td><td>no<\/td><td>User email, must be unique, if email already exists, will fail(a unique suffix is applied to the email when email is set)<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code>data.username<\/code><\/mark><\/td><td>no<\/td><td>Email or unique username, if not provided, a GUID is created.(a unique suffix is applied to the username when username is set)<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code>data.password<\/code><\/mark><\/td><td>no<\/td><td>If not provided, password is generated automatically<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code>data.product<\/code><\/mark><\/td><td><strong>yes<\/strong><\/td><td>Product code provided by Plagium<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/div><\/div>\n<\/div>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<div class=\"wp-block-getwid-tabs\" data-active-tab=\"0\"><ul class=\"wp-block-getwid-tabs__nav-links\"><\/ul>\n<div class=\"wp-block-getwid-tabs__nav-link\"><span class=\"wp-block-getwid-tabs__title-wrapper\"><a href=\"#\"><span class=\"wp-block-getwid-tabs__title\"><strong>Add Credits for sub account (available only for institutional account)<\/strong><\/span><\/a><\/span><\/div><div class=\"wp-block-getwid-tabs__tab-content-wrapper\"><div class=\"wp-block-getwid-tabs__tab-content\">\n<pre class=\"wp-block-code\"><code>https:&#47;&#47;api.plagium.com\/300\/sub_account\/add_credit\n<\/code><\/pre>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Argument<\/strong><\/th><th><strong>Required<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">key<\/mark><\/td><td><strong>yes<\/strong><\/td><td>Your API Key<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code>data.user_id<\/code><\/mark><\/td><td><strong>yes<\/strong><\/td><td>User ID GUID<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code>data.product<\/code><\/mark><\/td><td><strong>yes<\/strong><\/td><td>Product code provided by Plagium<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/div><\/div>\n<\/div>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<div class=\"wp-block-getwid-tabs\" data-active-tab=\"0\"><ul class=\"wp-block-getwid-tabs__nav-links\"><\/ul>\n<div class=\"wp-block-getwid-tabs__nav-link\"><span class=\"wp-block-getwid-tabs__title-wrapper\"><a href=\"#\"><span class=\"wp-block-getwid-tabs__title\"><strong>Get remaining credits for sub account (available only for institutional account)<\/strong><\/span><\/a><\/span><\/div><div class=\"wp-block-getwid-tabs__tab-content-wrapper\"><div class=\"wp-block-getwid-tabs__tab-content\">\n<pre class=\"wp-block-code\"><code>https:&#47;&#47;api.plagium.com\/300\/sub_account\/remaining_credits\n<\/code><\/pre>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Argument<\/strong><\/th><th><strong>Required<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">key<\/mark><\/td><td><strong>yes<\/strong><\/td><td>Your API Key<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code>data.user_id<\/code><\/mark><\/td><td><strong>yes<\/strong><\/td><td>User ID GUID<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code>data.product<\/code><\/mark><\/td><td><strong>yes<\/strong><\/td><td>Product code provided by Plagium<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/div><\/div>\n<\/div>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<div class=\"wp-block-getwid-tabs\" data-active-tab=\"0\"><ul class=\"wp-block-getwid-tabs__nav-links\"><\/ul>\n<div class=\"wp-block-getwid-tabs__nav-link\"><span class=\"wp-block-getwid-tabs__title-wrapper\"><a href=\"#\"><span class=\"wp-block-getwid-tabs__title\"><strong>Quick Search<\/strong><\/span><\/a><\/span><\/div><div class=\"wp-block-getwid-tabs__tab-content-wrapper\"><div class=\"wp-block-getwid-tabs__tab-content\">\n<pre class=\"wp-block-code\"><code>https:&#47;&#47;api.plagium.com\/300\/search\/quick\n<\/code><\/pre>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Argument<\/strong><\/th><th><strong>Required<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">key<\/mark><\/td><td><strong>yes<\/strong><\/td><td>Your API Key<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code><code>data.text<\/code><\/code><\/mark><\/td><td><strong>yes<\/strong><\/td><td>Text to search<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code><code>data.user_id<\/code><\/code><\/mark><\/td><td>no<\/td><td>User ID GUID on behalf search should be done<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code>data.product<\/code><\/mark><\/td><td><strong>yes<\/strong><\/td><td>Product code provided by Plagium<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/div><\/div>\n\n\n\n<div class=\"wp-block-getwid-tabs__nav-link\"><span class=\"wp-block-getwid-tabs__title-wrapper\"><a href=\"#\"><span class=\"wp-block-getwid-tabs__title\">Node.js Example<\/span><\/a><\/span><\/div><div class=\"wp-block-getwid-tabs__tab-content-wrapper\"><div class=\"wp-block-getwid-tabs__tab-content\">\n<pre class=\"wp-block-code\"><code>const http = require(\"http\");\n\nconst options = {\n  \"method\": \"POST\",\n  \"hostname\": \"https:\/\/api.plagium.com\",\n  \"port\": \"3000\",\n  \"path\": \"\/300\/search\/quick\",\n  \"headers\": {\n    \"Content-Type\": \"application\/json\",\n  }\n};\n\nconst req = http.request(options, function (res) {\n  const chunks = &#91;];\n\n  res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n  });\n\n  res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n  });\n});\n\nreq.write(JSON.stringify({\n  key: '&#91;YOUR API KEY]',\n  data: {\n    text: 'Albert Einstein was a German-born theoretical physicist, widely acknowledged to be one of the greatest and most influential physicists of all time. Einstein is best known for developing the theory of relativity, but he also made important contributions to the development of the theory of quantum mechanics.'\n  }\n}));\nreq.end();<\/code><\/pre>\n<\/div><\/div>\n<\/div>\n\n\n\n<div style=\"height:40px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<div class=\"wp-block-getwid-tabs\" data-active-tab=\"0\"><ul class=\"wp-block-getwid-tabs__nav-links\"><\/ul>\n<div class=\"wp-block-getwid-tabs__nav-link\"><span class=\"wp-block-getwid-tabs__title-wrapper\"><a href=\"#\"><span class=\"wp-block-getwid-tabs__title\"><strong>AI Detection<\/strong><\/span><\/a><\/span><\/div><div class=\"wp-block-getwid-tabs__tab-content-wrapper\"><div class=\"wp-block-getwid-tabs__tab-content\">\n<pre class=\"wp-block-code\"><code>https:&#47;&#47;api.plagium.com\/300\/ai\/check\n<\/code><\/pre>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th><strong>Argument<\/strong><\/th><th><strong>Required<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">key<\/mark><\/td><td><strong>yes<\/strong><\/td><td>Your API Key<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code><code>data.text<\/code><\/code><\/mark><\/td><td><strong>yes<\/strong><\/td><td>Text to search<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code><code>data.user_id<\/code><\/code><\/mark><\/td><td>no<\/td><td>User ID GUID on behalf search should be done<\/td><\/tr><tr><td><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\"><code>data.product<\/code><\/mark><\/td><td><strong>yes<\/strong><\/td><td>Product code provided by Plagium<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/div><\/div>\n\n\n\n<div class=\"wp-block-getwid-tabs__nav-link\"><span class=\"wp-block-getwid-tabs__title-wrapper\"><a href=\"#\"><span class=\"wp-block-getwid-tabs__title\">Node.js Example<\/span><\/a><\/span><\/div><div class=\"wp-block-getwid-tabs__tab-content-wrapper\"><div class=\"wp-block-getwid-tabs__tab-content\">\n<pre class=\"wp-block-code\"><code>const http = require(\"http\");\n\nconst options = {\n    \"method\": \"POST\",\n    \"hostname\": \"https:\/\/api.plagium.com\",\n    \"port\": \"3000\",\n    \"path\": \"\/300\/ai\/check\",\n    \"headers\": {\n        \"Content-Type\": \"application\/json\",\n    }\n};\n\nconst req = http.request(options, function (res) {\n    const chunks = &#91;];\n\n    res.on(\"data\", function (chunk) {\n    chunks.push(chunk);\n    });\n\n    res.on(\"end\", function () {\n    const body = Buffer.concat(chunks);\n    console.log(body.toString());\n    });\n});\n\nreq.write(JSON.stringify({\n    key: '&#91;YOUR API KEY]',\n    data: {\n    text: 'Albert Einstein was a German-born theoretical physicist, widely acknowledged to be one of the greatest and most influential physicists of all time. Einstein is best known for developing the theory of relativity, but he also made important contributions to the development of the theory of quantum mechanics.'\n    }\n}));\nreq.end();<\/code><\/pre>\n<\/div><\/div>\n<\/div>\n","protected":false},"featured_media":0,"parent":2129,"menu_order":0,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"docs_folder":[],"class_list":["post-3414","docs","type-docs","status-publish","hentry"],"comment_count":0,"_links":{"self":[{"href":"https:\/\/community.plagium.com\/fr\/wp-json\/wp\/v2\/docs\/3414","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/community.plagium.com\/fr\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/community.plagium.com\/fr\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/community.plagium.com\/fr\/wp-json\/wp\/v2\/comments?post=3414"}],"version-history":[{"count":5,"href":"https:\/\/community.plagium.com\/fr\/wp-json\/wp\/v2\/docs\/3414\/revisions"}],"predecessor-version":[{"id":3964,"href":"https:\/\/community.plagium.com\/fr\/wp-json\/wp\/v2\/docs\/3414\/revisions\/3964"}],"up":[{"embeddable":true,"href":"https:\/\/community.plagium.com\/fr\/wp-json\/wp\/v2\/docs\/2129"}],"next":[{"title":"API v2","link":"https:\/\/community.plagium.com\/fr\/docs\/api\/api-v2\/","href":"https:\/\/community.plagium.com\/fr\/wp-json\/wp\/v2\/docs\/3415"}],"wp:attachment":[{"href":"https:\/\/community.plagium.com\/fr\/wp-json\/wp\/v2\/media?parent=3414"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/community.plagium.com\/fr\/wp-json\/wp\/v2\/doc_tag?post=3414"},{"taxonomy":"docs_folder","embeddable":true,"href":"https:\/\/community.plagium.com\/fr\/wp-json\/wp\/v2\/docs_folder?post=3414"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}