{"id":3415,"date":"2023-12-18T14:51:46","date_gmt":"2023-12-18T14:51:46","guid":{"rendered":"https:\/\/community.plagium.com\/docs\/dates-updates\/events-calendar\/"},"modified":"2024-06-10T21:31:45","modified_gmt":"2024-06-10T21:31:45","slug":"api-v2","status":"publish","type":"docs","link":"https:\/\/community.plagium.com\/es\/docs\/api\/api-v2\/","title":{"rendered":"API v2"},"content":{"rendered":"\n<blockquote class=\"wp-block-quote has-vivid-red-color has-text-color has-link-color wp-elements-e85754099e798c0196e8c9e77cfbef7e is-layout-flow wp-block-quote-is-layout-flow\">\n<p>Please be aware that version 2 of the API will no longer be supported after January\u00a01st,\u00a02024.<\/p>\n<\/blockquote>\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>Send 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\/v2\/document<\/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\">password<\/mark><\/td><td>no<\/td><td>Your API password if set<\/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><strong>yes<\/strong><\/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\"><code>data.url_filter<\/code><\/mark><\/td><td>no<\/td><td>Domain or urls to be excluded from results separated by space or line feed.<\/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><\/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>var request = require('request');\n\nvar body={\nkey:\"YOUR API KEY\",\ndata: {\n    title:\"Abraham Lincoln\",\n    text:\"Abraham Lincoln was an American statesman and lawyer who served as the 16th President of the United States from March 1861 until his assassination in April 1865. Lincoln led the United States through the American Civil War\u2014its bloodiest war and perhaps its greatest moral, constitutional, and political crisis.\",\n    import_id:\"YOUR DOCUMENT ID\",\n    source:&#91;\"web\",\"file\"],\n    url_filter:\"en.wikipedia.org\\nfr.wikipedia.org\/wiki\/Thomas_Edison\",\n    read:\"private\",\n    webhook: {\n        url:\"https:\/\/your_app_webhook_address\",\n        format:\"document\",\n        metadata:{\n            my_metadata:{}\n        }\n    }\n}\n};\n            \nrequest.post(\"https:\/\/api.plagium.com\/v2\/document\", { json: true, body: body },\nfunction(err, res, body) {\n    if (err) console.error(err);\n    else {\n        console.log(body.obj._id);\n    }\n});<\/code><\/pre>\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\">Response Example<\/span><\/a><\/span><\/div><div class=\"wp-block-getwid-tabs__tab-content-wrapper\"><div class=\"wp-block-getwid-tabs__tab-content\">\n<p>Use&nbsp;<code><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">body.obj._id<\/mark><\/code>&nbsp;for future references.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>{\n\"data\": {\n    \"key\": \"YOUR API KEY\",\n    \"type\": \"document\",\n    \"data\": {\n    \"import_id\": \"YOUR DOCUMENT ID\",\n    \"text\": \"Abraham Lincoln was an American statesman and lawyer who served as the 16th President of the United States from March 1861 until his assassination in April 1865. Lincoln led the United States through the American Civil War\u2014its bloodiest war and perhaps its greatest moral, constitutional, and political crisis.\",\n    \"min_rank\": 40,\n    \"min_relation\": 0.33,\n    \"webhook\": {\n        \"url\": \"https:\/\/your_app_webhook_address\",\n        \"format\": \"document\"\n        } \n    }\n},\n\"obj\": {\n    \"_id\": \"12345678-1234-1234-1234-12345678\",\n    \"obj\": {\n        \"import_id\": \"YOUR DOCUMENT ID\",\n        \"active\": true,\n        \"data\": {\n            \"profile\": {\n                \"title\": \"Abraham Lincoln\"\n            },\n            \"privacy\": {\n                \"read\": \"private\"\n            },\n            \"search\": {\n                \"status\": \"waiting\",\n                \"type\": \"deep\",\n                \"source\": &#91;\"web\"],\n                \"from\": \"text\",\n                \"text\": \"Abraham Lincoln was an American statesman and lawyer who served as the 16th President of the United States from March 1861 until his assassination in April 1865. Lincoln led the United States through the American Civil War\u2014its bloodiest war and perhaps its greatest moral, constitutional, and political crisis.\",\n                \"similarity\": {\n                    \"min_relation\": 0.33,\n                    \"min_rank\": 40\n                },\n                \"webhook\": {\n                    \"url\":\"https:\/\/your_app_webhook_address\",\n                    \"format\":\"document\"\n                },\n                \"version\": 0\n            },\n            \"urls\": {\n                \"edit\": \"https:\/\/premium.plagium.com\/admin\/en\/documents\/id\/12345678-1234-1234-1234-12345678\",\n                \"report\": \"https:\/\/premium.plagium.com\/admin\/en\/report\/id\/12345678-1234-1234-1234-12345678\",\n                \"print\": \"https:\/\/premium.plagium.com\/admin\/en\/print\/report\/12345678-1234-1234-1234-12345678\"\n            }\n        },\n        \"type\": \"document\",\n        \"rights\": {\n            \"ownedby\": \"aaaaaaaa-aaaa-aaaa-aaaaaaaa,\n            \"createdby\": \"api\",\n            \"created\": 1554848878747,\n            \"modifiedby\": \"api\",\n            \"modified\": 1554848878747\n        }\n    }\n},\n\"api\": {\n    \"version\": \"2.0.5\",\n    \"name\": \"api\",\n    \"date\": 1554848938125\n}\n}<\/code><\/pre>\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\">Webhook Response 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>{\n\"obj\": {\n    \"_id\": \"12345678-1234-1234-1234-12345678\",\n    \"obj\": {\n        \"data\": {\n            \"stats\": {\n                \"time\": {\n                    \"parse\": 0,\n                    \"compare\": 1350,\n                    \"search\": 440,\n                    \"sort\": 0,\n                    \"pct\": 2,\n                    \"total\": 1665,\n                    \"download\": 319\n                },\n                \"proximity\": {\n                    \"sentence\": 0,\n                    \"score\": {\n                        \"document\": 80,\n                        \"page\": 80,\n                        \"paragraph\": 80,\n                        \"sentence\": 80\n                    },\n                    \"page\": 100,\n                    \"document\": {\n                        \"pct_length\": 100,\n                        \"pct_selected_queries\": 100,\n                        \"pct_selected\": 100,\n                        \"pct\": 100,\n                        \"pct_selected_length\": 100,\n                        \"pct_queries\": 100\n                    },\n                    \"paragraph\": 100\n                },\n                \"results\": {\n                    \"kept\": 5,\n                    \"downloaded\": 8,\n                    \"found\": 8\n                },\n                \"steps\": {\n                    \"search\": 1,\n                    \"compare\": 1,\n                    \"download\": 1\n                },\n                \"download_round\": 1,\n                \"processor_version\": 13,\n                \"compare_completed\": true,\n                \"download_completed\": true,\n                \"search_round\": 1,\n                \"compare_round\": 0,\n                \"search_completed\": true\n            },\n            \"file\": {\n                \"key\": \"fcf52ae0-5b39-11e9-bb64-ad0e064387d9\"\n            },\n            \"search\": {\n                \"version\": 0,\n                \"similarity\": { \"min_relation\": 0.33, \"min_rank\": 40 },\n                \"source\": &#91;\"web\"],\n                \"status_pct\": null,\n                \"status_updated\": 1554870223885,\n                \"from\": \"text\",\n                \"text\": \"Abraham Lincoln was an American statesman and lawyer who served as the 16th President of the United States from March 1861 until his assassination in April 1865. Lincoln led the United States through the American Civil War\u2014its bloodiest war and perhaps its greatest moral, constitutional, and political crisis.\",\n                \"type\": \"deep\",\n                \"webhook\": {\n                    \"url\":\"https:\/\/your_app_webhook_address\",\n                    \"format\": \"document\"\n                }\n                \"status\": \"ready\"\n            },\n            \"privacy\": { \"read\": \"private\" },\n            \"profile\": { \n                \"title\": \"Abraham Lincoln\" \n            },\n            \"urls\": {\n                \"edit\": \"https:\/\/premium.plagium.com\/admin\/en\/documents\/id\/12345678-1234-1234-1234-12345678\",\n                \"report\": \"https:\/\/premium.plagium.com\/admin\/en\/report\/id\/12345678-1234-1234-1234-12345678\",\n                \"print\": \"https:\/\/premium.plagium.com\/admin\/en\/print\/report\/12345678-1234-1234-1234-12345678\"\n            }\n        },\n        \"rights\": {\n            \"created\": 1554864020611,\n            \"modifiedby\": \"lambda\",\n            \"modified\": 1554870223885,\n            \"createdby\": \"api\",\n            \"ownedby\": \"aaaaaaaa-aaaa-aaaa-aaaaaaaa\"\n        },\n        \"active\": true,\n        \"import_id\": \"my_import_id\",\n        \"type\": \"document\"\n    }\n},\n\"search\": {\n    \"_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx\",\n    \"obj\": {\n        \"data\": {\n            \"obj_id\": \"12345678-1234-1234-1234-12345678\",\n            \"obj_type\": \"document\",\n            \"obj_import_id\": \"my_import_id\",\n            \"search\": {\n                \"status\": \"ready\",\n                \"type\": \"deep\",\n                \"source\": &#91;\"web\"],\n                \"precision\": 90,\n                \"similarity\": {\n                    \"min_rank\": 40,\n                    \"min_relation\": 0.33\n                }\n            },\n            \"cost\": {\n                \"size\": 33,\n                \"length_queries\": 32,\n                \"nb_sentences\": 1,\n                \"nb_searchable_sentences\": 1,\n                \"nb_queries\": 1,\n                \"length_selected_queries\": 32,\n                \"nb_selected_queries\": 1,\n                \"nb_pages\": 1,\n                \"nb_words\": 5\n            },\n            \"payment\": {\n                \"no_credit\": false,\n                \"no_charge\": false,\n                \"charge_parent\": false,\n                \"documents\": 0,\n                \"pages\": 0,\n                \"words\": 0,\n                \"characters\": 0,\n                \"currency\": {\n                    \"usd\": 0.08,\n                    \"eur\": 0,\n                    \"brl\": 0,\n                    \"mxn\": 0,\n                    \"inr\": 0\n                },\n                \"need\": {\n                    \"usd\": 0.08,\n                    \"eur\": 0.07,\n                    \"brl\": 0.22,\n                    \"mxn\": 0,\n                    \"inr\": 4\n                }\n            },\n            \"stats\": {\n                \"processor_version\": 13,\n                \"search_completed\": true,\n                \"search_round\": 1,\n                \"download_completed\": true,\n                \"download_round\": 1,\n                \"compare_completed\": true,\n                \"compare_round\": 0,\n                \"results\": {\n                    \"found\": 8,\n                    \"kept\": 5,\n                    \"downloaded\": 8\n                },\n                \"proximity\": {\n                    \"document\": {\n                        \"pct_queries\": 100,\n                        \"pct_length\": 100,\n                        \"pct\": 100,\n                        \"pct_selected_queries\": 100,\n                        \"pct_selected_length\": 100,\n                        \"pct_selected\": 100\n                    },\n                    \"score\": {\n                        \"document\": 80,\n                        \"page\": 80,\n                        \"paragraph\": 80,\n                        \"sentence\": 80\n                    },\n                    \"page\": 100,\n                    \"paragraph\": 100,\n                    \"sentence\": 0\n                },\n                \"time\": {\n                    \"total\": 6619,\n                    \"parse\": 0,\n                    \"search\": 1674,\n                    \"sort\": 0,\n                    \"pct\": 2,\n                    \"download\": 2614,\n                    \"compare\": 2735\n                },\n                \"steps\": {\n                    \"search\": 1,\n                    \"download\": 1,\n                    \"compare\": 1\n                }\n            }\n        },\n        \"type\": \"search\",\n        \"active\": true,\n        \"rights\": {\n            \"ownedby\": \"aaaaaaaa-aaaa-aaaa-aaaaaaaa\",\n            \"createdby\": \"lambda\",\n            \"created\": 1554870330685,\n            \"modifiedby\": \"lambda\",\n            \"modified\": 1554870330685\n        }\n    }\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>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\/v2\/results<\/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\">password<\/mark><\/td><td>no<\/td><td>Your API password if set.<\/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>The id of your document: the&nbsp;<code><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-red-color\">_id<\/mark><\/code>&nbsp;field.<\/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>var request = require('request');\n\nvar body={\nkey:\"YOUR API KEY\",\ndata: {\n    id:\"DOCUMENT ID\"\n}\n};\n            \nrequest.post(\"https:\/\/api.plagium.com\/v2\/results\", { json: true, body: body },\nfunction(err, res, body) {\n    if (err) console.error(err);\n    else {\n        if (body.results) {\n            for (var r of body.results) {\n                console.log(r.result.title);\n                console.log(r.result.url);\n                console.log(r.score);\n            }\n        }\n    }\n});<\/code><\/pre>\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\">Response 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>{\n\"data\": {\n    \"key\": \"YOUR API KEY\",\n    \"type\": \"results\",\n    \"data\": {\n        \"id\": \"12345678-1234-1234-1234-12345678\"\n    }\n},\n\"obj\": {\n    \"_id\": \"12345678-1234-1234-1234-12345678\",\n    \"obj\": {\n        \"data\": {\n            \"stats\": {\n                \"time\": {\n                    \"parse\": 0,\n                    \"compare\": 8506,\n                    \"search\": 81,\n                    \"sort\": 0,\n                    \"pct\": 0,\n                    \"total\": 5220,\n                    \"download\": 571\n                },\n                \"proximity\": {\n                    \"sentence\": 0,\n                    \"score\": {\n                        \"document\": 100,\n                        \"page\": 100,\n                        \"paragraph\": 100,\n                        \"sentence\": 100\n                    },\n                    \"page\": 100,\n                    \"document\": {\n                        \"pct_length\": 100,\n                        \"pct_selected_queries\": 100,\n                        \"pct_selected\": 100,\n                        \"pct\": 100,\n                        \"pct_selected_length\": 100,\n                        \"pct_queries\": 100\n                    },\n                    \"paragraph\": 100\n                },\n                \"results\": {\n                    \"kept\": 26,\n                    \"downloaded\": 36,\n                    \"found\": 36\n                },\n                \"steps\": {\n                    \"search\": 1,\n                    \"compare\": 1,\n                    \"download\": 1\n                },\n                \"download_round\": 1,\n                \"processor_version\": 13,\n                \"compare_completed\": true,\n                \"download_completed\": true,\n                \"search_round\": 1,\n                \"compare_round\": 0,\n                \"search_completed\": true\n            },\n            \"payment\": {\n                \"pages\": 0,\n                \"words\": 0,\n                \"documents\": 0,\n                \"no_charge\": false,\n                \"characters\": 0,\n                \"currency\": {\n                    \"eur\": 0,\n                    \"brl\": 0,\n                    \"mxn\": 0,\n                    \"inr\": 0,\n                    \"usd\": 0.08\n                },\n                \"need\": {\n                    \"inr\": 4,\n                    \"mxn\": 0,\n                    \"usd\": 0.08,\n                    \"brl\": 0.22,\n                    \"eur\": 0.07\n                },\n                \"charge_parent\": false,\n                \"no_credit\": false\n            },\n            \"search\": {\n                \"version\": 0,\n                \"similarity\": {\n                    \"min_relation\": 0.33,\n                    \"min_rank\": 45\n                },\n                \"source\": &#91;\n                    \"web\"\n                ],\n                \"status_pct\": null,\n                \"status_updated\": 1554868124901,\n                \"from\": \"text\",\n                \"text\": \"Abraham Lincoln was an American statesman and lawyer who served as the 16th President of the United States from March 1861 until his assassination in April 1865. Lincoln led the United States through the American Civil War\u2014its bloodiest war and perhaps its greatest moral, constitutional, and political crisis.\",\n                \"type\": \"deep\",\n                \"webhook\": {\n                    \"url\": \"https:\/\/your_app_webhook_address\",\n                    \"format\": \"document\"\n                },\n                \"status\": \"ready\"\n            },\n            \"cost\": {\n                \"nb_queries\": 5,\n                \"nb_selected_queries\": 5,\n                \"nb_sentences\": 2,\n                \"nb_words\": 48,\n                \"size\": 310,\n                \"length_queries\": 302,\n                \"length_selected_queries\": 302,\n                \"nb_pages\": 1,\n                \"nb_searchable_sentences\": 2\n            },\n            \"privacy\": {\n                \"read\": \"public\"\n            },\n            \"profile\": {\n                \"title\": \"Abraham Lincoln\"\n            },\n            \"urls\": {\n                \"edit\": \"https:\/\/premium.plagium.com\/admin\/en\/documents\/id\/12345678-1234-1234-1234-12345678\",\n                \"report\": \"https:\/\/premium.plagium.com\/admin\/en\/report\/id\/12345678-1234-1234-1234-12345678\",\n                \"print\": \"https:\/\/premium.plagium.com\/admin\/en\/print\/report\/12345678-1234-1234-1234-12345678\",\n                \"public_report\": \"https:\/\/premium.plagium.com\/admin\/en\/document\/report\/12345678-1234-1234-1234-12345678\"\n            }\n        },\n        \"rights\": {\n            \"created\": 1554868084936,\n            \"modifiedby\": \"lambda\",\n            \"modified\": 1554868124901,\n            \"createdby\": \"api\",\n            \"ownedby\": \"aaaaaaaa-aaaa-aaaa-aaaaaaaa\"\n        },\n        \"active\": true,\n        \"import_id\": \"YOUR DOCUMENT ID\",\n        \"type\": \"document\"\n    }\n},\n\"results\": &#91;{\n        \"result\": {\n            \"obj_type\": \"result\",\n            \"url\": \"https:\/\/en.wikipedia.org\/wiki\/Abraham_Lincoln\",\n            \"title\": \"Abraham Lincoln - Wikipedia\",\n            \"description\": \"Abraham Lincoln (February 12, 1809 \u2013 April 15, 1865) was an American statesman, politician, and lawyer who served as the 16th president of the United States from 1861 until his assassination in April 1865.\"\n        },\n        \"score\": 0.2660360339939722,\n        \"max_page_score\": 0.2660360339939722,\n        \"max_paragraph_score\": 39.4230239311529,\n        \"max_sentence_score\": 86.15384615384616,\n        \"queries\": 5,\n        \"found\": 1,\n        \"comparison\": {\n            \"score\": 80.45383729594255,\n            \"max_page_score\": 80.45383729594255,\n            \"max_paragraph_score\": 80.45383729594255,\n            \"max_sentence_score\": 80.87719298245614\n        },\n        \"checked\": true\n    },\n    {\n        \"result\": {\n            \"obj_type\": \"result\",\n            \"url\": \"https:\/\/en.wikipedia.org\/wiki\/16th_President_of_the_United_States\",\n            \"title\": \"Abraham Lincoln - Wikipedia\",\n            \"description\": \"Abraham Lincoln (February 12, 1809 \u2013 April 15, 1865) was an American statesman, politician, and lawyer who served as the 16th president of the United States from 1861 until his assassination in April 1865.\"\n        },\n        \"score\": 0.26594427801507586,\n        \"max_page_score\": 0.26594427801507586,\n        \"max_paragraph_score\": 39.4230239311529,\n        \"max_sentence_score\": 86.15384615384616,\n        \"queries\": 5,\n        \"found\": 1,\n        \"comparison\": {\n            \"score\": 80.45383729594255,\n            \"max_page_score\": 80.45383729594255,\n            \"max_paragraph_score\": 80.45383729594255,\n            \"max_sentence_score\": 80.87719298245614\n        },\n        \"checked\": true\n    }\n],\n\"api\": {\n    \"version\": \"2.0.7\",\n    \"name\": \"results\",\n    \"date\": 1554871697745\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>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\/v2\/remaining_credits<\/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\">password<\/mark><\/td><td>no<\/td><td>Your API password if set.<\/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>var request = require('request');\n\nvar body={\nkey:\"YOUR API KEY\"\n};\n            \nrequest.post(\"https:\/\/api.plagium.com\/v2\/remaining_credits\", { json: true, body: body },\nfunction(err, res, body) {\n    if (err) console.error(err);\n    else  console.log(body);\n});<\/code><\/pre>\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\">Response 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>{\n\"data\":{\n    \"key\":\"YOUR API KEY\",\n    \"type\":\"remaining_credits\"\n},\n\"remaining_credits\":{\n    \"currency\":{\n        \"usd\":86.00,\n        \"eur\":null,\n        \"brl\":null,\n        \"inr\":null},\n    \"documents\":null,\n    \"pages\":null,\n    \"words\":null,\n    \"characters\":null\n},\n\"api\":{\n    \"version\":\"2.0.10\",\n    \"name\":\"remaining_credits\",\n    \"date\":1566219132762\n}\n}<\/code><\/pre>\n<\/div><\/div>\n<\/div>\n\n\n\n<p><\/p>\n","protected":false},"featured_media":0,"parent":2129,"menu_order":1,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"docs_folder":[],"class_list":["post-3415","docs","type-docs","status-publish","hentry"],"comment_count":0,"_links":{"self":[{"href":"https:\/\/community.plagium.com\/es\/wp-json\/wp\/v2\/docs\/3415","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/community.plagium.com\/es\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/community.plagium.com\/es\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/community.plagium.com\/es\/wp-json\/wp\/v2\/comments?post=3415"}],"version-history":[{"count":3,"href":"https:\/\/community.plagium.com\/es\/wp-json\/wp\/v2\/docs\/3415\/revisions"}],"predecessor-version":[{"id":4108,"href":"https:\/\/community.plagium.com\/es\/wp-json\/wp\/v2\/docs\/3415\/revisions\/4108"}],"up":[{"embeddable":true,"href":"https:\/\/community.plagium.com\/es\/wp-json\/wp\/v2\/docs\/2129"}],"prev":[{"title":"API v3","link":"https:\/\/community.plagium.com\/es\/docs\/api\/api-v3\/","href":"https:\/\/community.plagium.com\/es\/wp-json\/wp\/v2\/docs\/3414"}],"wp:attachment":[{"href":"https:\/\/community.plagium.com\/es\/wp-json\/wp\/v2\/media?parent=3415"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/community.plagium.com\/es\/wp-json\/wp\/v2\/doc_tag?post=3415"},{"taxonomy":"docs_folder","embeddable":true,"href":"https:\/\/community.plagium.com\/es\/wp-json\/wp\/v2\/docs_folder?post=3415"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}