Quick start
Rewriter - Documentation
API Access Key & Authentication
After signing up, every user is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Plaraphy API, simply attach your access_key to your preferred endpoint URL.
Your API query:
POST https://app.plaraphy.com/api/rewriter
API Features
Object | Description |
---|---|
access_key
|
[Required] Your API Access Key. |
text
|
[Required] Your text content. Check the max caracters per plan |
unique
|
[Optional] Rewrite in a way that passes online plagiarism test. Options: true or false |
mode
|
[Optional] Rewriting mode. The default mode is normal, however it is set to be discontinued soon. We recommend using standard, or fluent |
Example API Request:
curl 'https://app.plaraphy.com/api/rewriter' -X POST -H 'Accept: application/json' -H 'Authorization: Bearer ' --data $'text=Hello+World&unique=true&lang=en&mode=fluent'
Example API Response with JOB ID:
{ "original": "The current Covid outbreak, the most widespread since the start of the pandemic in 2020, has painted Xi Jinping, China’s president, into a corner. He has refused to budge on the government’s strict Covid approach. If he loosens restrictions and infections skyrocket, there is the risk of mass casualties and an overwhelmed health care system. But keeping the current policies in place and limiting infections with widespread lockdowns would inflict further damage to an already slowing economy.", "rewrited": "Your request has been created successfully under the JOB ID 1120013. The process will be ready in about 2 minutes. To retrieve the response from this request, just re-send it and the results will appear when available.", "parameters": { "unique": "true", "mode": "normal" }, "success": "pending", "job_id": 1120013 }
Example Successful API Response:
{ "original": "The current Covid outbreak, the most widespread since the start of the pandemic in 2020, has painted Xi Jinping, China’s president, into a corner. He has refused to budge on the government’s strict Covid approach. If he loosens restrictions and infections skyrocket, there is the risk of mass casualties and an overwhelmed health care system. But keeping the current policies in place and limiting infections with widespread lockdowns would inflict further damage to an already slowing economy.", "rewrited": "The current Covid outbreak has put China's president into a corner. He has refused to change his stance on the Covid approach. There is a risk of mass casualties if he loosens his restrictions. Keeping the current policies in place would cause more damage to the economy.", "parameters": { "unique": "true", "mode": "normal" }, "success": true, "job_id": null }
PHP cURL
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://app.plaraphy.com/api/rewriter",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "text=Save time and immediately improve your writing with Plaraphy API.&mode=fluent&lang=en&unique=true",
CURLOPT_HTTPHEADER => array(
"accept: application/json",
"authorization: Bearer
",
"cache-control: no-cache",
"content-type: application/x-www-form-urlencoded"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Python
import requests url = 'https://app.plaraphy.com/api/rewriter' payload = 'text=Save time and immediately improve your writing with Plaraphy API.&mode=fluent&lang=es&unique=true', headers = { 'accept': 'application/json', 'content-type': 'application/x-www-form-urlencoded', 'authorization': 'Bearer ', 'cache-control': 'no-cache', } response = requests.request('POST', url, data=payload, headers=headers) print(response.text)
JavaScript Jquery AJAX
var settings = { "async": true, "crossDomain": true, "url": "https://app.plaraphy.com/api/rewriter", "method": "POST", "headers": { "accept": "application/json", "content-type": "application/x-www-form-urlencoded", "authorization": "Bearer ", "cache-control": "no-cache" }, "data": { "text=Save time and immediately improve your writing with Plaraphy API.&mode=fluent&lang=es&unique=true", } } $.ajax(settings).done(function (response) { console.log(response); });
Plagiarism Checker - Documentation
API Access Key & Authentication
After signing up, every user is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Plaraphy API, simply attach your access_key to your preferred endpoint URL.
API Features
Object | Description |
---|---|
access_key
|
[Required] Your API Access Key. |
url
|
[Required] The url to check. |
Example API Request:
curl 'https://app.plaraphy.com/api/plagiarism' -X POST -H 'Accept: application/json' -H 'Authorization: Bearer ' --data $'url=(url encoded)'
Example Successful API Response:
{ "plagiarism_rate": 13.456620106236475, "plagiarism_links": [ { "url": "https://www.sciencedirect.com/science/article/pii/S0268401220308082", "percentage": 13.456620106236475 }, { "url": "https://www.chegg.com/flashcards/test-3-7d6e5cdc-6d4c-4443-81fe-73007f8c4195/deck", "percentage": 3.6344695873603796 }, { "url": "https://technologyadvice.com/blog/information-technology/how-to-use-an-api/", "percentage": 10.444214876033058 } ], "success": true, "job_id": null }
Example API Response with JOB ID:
{ "success":"pending", "message":"Your request has been created successfully under the JOB ID 1120015. The process will be ready in about 2 minutes. To retrieve the response from this request, just re-send it and the results will appear when available.", "job_id":1120015 }
PHP cURL
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://app.plaraphy.com/api/plagiarism",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
//url must be urlencoded
CURLOPT_POSTFIELDS => "url=https%3A%2F%2Fwww.google.com",
CURLOPT_HTTPHEADER => array(
"accept: application/json",
"authorization: Bearer
",
"cache-control: no-cache",
"content-type: application/x-www-form-urlencoded"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Python
import requests url = 'https://app.plaraphy.com/api/plagiarism' //url must be urlencoded payload = 'url=https%3A%2F%2Fwww.google.com', headers = { 'accept': 'application/json', 'content-type': 'application/x-www-form-urlencoded', 'authorization': 'Bearer ', 'cache-control': 'no-cache', } response = requests.request('POST', url, data=payload, headers=headers) print(response.text)
JavaScript Jquery AJAX
var settings = { "async": true, "crossDomain": true, "url": "https://app.plaraphy.com/api/plagiarism", "method": "POST", "headers": { "accept": "application/json", "content-type": "application/x-www-form-urlencoded", "authorization": "Bearer ", "cache-control": "no-cache" }, "data": { //url must be urlencoded "url": "https%3A%2F%2Fwww.google.com"", } } $.ajax(settings).done(function (response) { console.log(response); });
Summarizer - Documentation
API Access Key & Authentication
After signing up, every user is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Plaraphy API, simply attach your access_key to your preferred endpoint URL.
API Features
Object | Description |
---|---|
access_key
|
[Required] Your API Access Key. |
output_percent
|
[Required] Percent of the original text to be returned. Values range from 10% to 100% |
text
|
[Required]Text to summarize |
Example API Request:
curl 'https://app.plaraphy.com/api/summarizer' -X POST -H 'Accept: application/json' -H 'Authorization: Bearer ' --data $'text=Save time and immediately improve your writing with Plaraphy API.&output_percent=(10 to 100)'
Example API Response:
{"summary":"Save time and immediately improve your writing with Plaraphy API.","percent":"10","success":true}
PHP cURL
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://app.plaraphy.com/api/summarizer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "text=Save time and immediately improve your writing with Plaraphy API.&output_percent=(10 to 100)",
CURLOPT_HTTPHEADER => array(
"accept: application/json",
"authorization: Bearer
",
"cache-control: no-cache",
"content-type: application/x-www-form-urlencoded"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Python
import requests url = 'https://app.plaraphy.com/api/summarizer' payload = 'text=Save time and immediately improve your writing with Plaraphy API.&output_percent=(10 to 100)', headers = { 'accept': 'application/json', 'content-type': 'application/x-www-form-urlencoded', 'authorization': 'Bearer ', 'cache-control': 'no-cache', } response = requests.request('POST', url, data=payload, headers=headers) print(response.text)
JavaScript Jquery AJAX
var settings = { "async": true, "crossDomain": true, "url": "https://app.plaraphy.com/api/summarizer", "method": "POST", "headers": { "accept": "application/json", "content-type": "application/x-www-form-urlencoded", "authorization": "Bearer ", "cache-control": "no-cache" }, "data": { "text=Save time and immediately improve your writing with Plaraphy API.&output_percent=(10 to 100)", } } $.ajax(settings).done(function (response) { console.log(response); });
Sentiment analysis - Documentation
API Access Key & Authentication
After signing up, every user is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Plaraphy API, simply attach your access_key to your preferred endpoint URL.
API Features
Object | Description |
---|---|
access_key
|
[Required] Your API Access Key. |
text
|
[Required] Text to summarize. Check the max caracters per plan |
Example API Request:
curl 'https://app.plaraphy.com/api/sentiment' -X POST -H 'Accept: application/json' -H 'Authorization: Bearer ' --data $'text=Save time and immediately improve your writing with Plaraphy API.'
Example API Response:
{"sentiments_detected":[{"neg":0,"neu":0.567,"pos":0.433,"compound":0.7269,"sentence":"Save time and immediately improve your writing with Plaraphy API."}],"sentiment":"positive","success":true}
PHP cURL
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://app.plaraphy.com/api/sentiment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "text=Save time and immediately improve your writing with Plaraphy API.",
CURLOPT_HTTPHEADER => array(
"accept: application/json",
"authorization: Bearer
",
"cache-control: no-cache",
"content-type: application/x-www-form-urlencoded"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Python
import requests url = 'https://app.plaraphy.com/api/sentiment' payload = 'text=Save time and immediately improve your writing with Plaraphy API.', headers = { 'accept': 'application/json', 'content-type': 'application/x-www-form-urlencoded', 'authorization': 'Bearer ', 'cache-control': 'no-cache', } response = requests.request('POST', url, data=payload, headers=headers) print(response.text)
JavaScript Jquery AJAX
var settings = { "async": true, "crossDomain": true, "url": "https://app.plaraphy.com/api/sentiment", "method": "POST", "headers": { "accept": "application/json", "content-type": "application/x-www-form-urlencoded", "authorization": "Bearer ", "cache-control": "no-cache" }, "data": { "text=Save time and immediately improve your writing with Plaraphy API.", } } $.ajax(settings).done(function (response) { console.log(response); });
Article Extractor - Documentation
API Access Key & Authentication
After signing up, every user is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Plaraphy API, simply attach your access_key to your preferred endpoint URL.
API Features
Object | Description |
---|---|
access_key
|
[Required] Your API Access Key. |
url
|
[Required] The url to check. |
Example API Request:
curl 'https://app.plaraphy.com/api/article_extractor' -X POST -H 'Accept: application/json' -H 'Authorization: Bearer ' --data $'url=(url encoded)'
Example API Response:
{"text":"Love podcasts or audiobooks? Learn on the go with our new app.","title":"Funciones sobre arreglos que debes conocer en Javascript","summary":"Love podcasts or audiobooks?\nLearn on the go with our new app.","keywords":"conocer, arreglos, funciones, app, podcasts, audiobooks, debes, javascript, en, sobre, love, que, learn","success":true}
PHP cURL
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://app.plaraphy.com/api/article_extractor",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
//url must be urlencoded
CURLOPT_POSTFIELDS => "url=https%3A%2F%2Fwww.google.com",
CURLOPT_HTTPHEADER => array(
"accept: application/json",
"authorization: Bearer
",
"cache-control: no-cache",
"content-type: application/x-www-form-urlencoded"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Python
import requests url = 'https://app.plaraphy.com/api/article_extractor' //url must be urlencoded payload = 'url=https%3A%2F%2Fwww.google.com', headers = { 'accept': 'application/json', 'content-type': 'application/x-www-form-urlencoded', 'authorization': 'Bearer ', 'cache-control': 'no-cache', } response = requests.request('POST', url, data=payload, headers=headers) print(response.text)
JavaScript Jquery AJAX
var settings = { "async": true, "crossDomain": true, "url": "https://app.plaraphy.com/api/article_extractor", "method": "POST", "headers": { "accept": "application/json", "content-type": "application/x-www-form-urlencoded", "authorization": "Bearer ", "cache-control": "no-cache" }, "data": { //url must be urlencoded "url=https%3A%2F%2Fwww.google.com", } } $.ajax(settings).done(function (response) { console.log(response); });
Classifier - Documentation
API Access Key & Authentication
After signing up, every user is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Plaraphy API, simply attach your access_key to your preferred endpoint URL.
API Features
Object | Description |
---|---|
access_key
|
[Required] Your API Access Key. |
text
|
[Required] Text to summarize. Check the max caracters per plan |
Example API Request:
curl 'https://app.plaraphy.com/api/classifier' -X POST -H 'Accept: application/json' -H 'Authorization: Bearer ' --data $'text=Save time and immediately improve your writing with Plaraphy API.'
Example API Response:
{"keywords":"save, time, immediately, improve, writing","categories":"Writing Pencils, Time & Attendance Clocks, Multifunction Writing Instruments, Writing & Drawing Instruments, Writing & Drawing Instrument Accessories","keywords_scores":"save, 1, save, 1, time, 1, save, 1, time, 1, immediately, 1, save, 1, time, 1, immediately, 1, improve, 1, save, 1, time, 1, immediately, 1, improve, 1, writing, 1","categories_scores":"Writing Pencils, 0.050875486666667, Writing Pencils, 0.050875486666667, Time & Attendance Clocks, 0.043321498, Writing Pencils, 0.050875486666667, Time & Attendance Clocks, 0.043321498, Multifunction Writing Instruments, 0.043150657333333, Writing Pencils, 0.050875486666667, Time & Attendance Clocks, 0.043321498, Multifunction Writing Instruments, 0.043150657333333, Writing & Drawing Instruments, 0.037462433333333, Writing Pencils, 0.050875486666667, Time & Attendance Clocks, 0.043321498, Multifunction Writing Instruments, 0.043150657333333, Writing & Drawing Instruments, 0.037462433333333, Writing & Drawing Instrument Accessories, 0.033099222","success":true}
PHP cURL
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://app.plaraphy.com/api/classifier",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "text=Save time and immediately improve your writing with Plaraphy API.",
CURLOPT_HTTPHEADER => array(
"accept: application/json",
"authorization: Bearer
",
"cache-control: no-cache",
"content-type: application/x-www-form-urlencoded"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Python
import requests url = 'https://app.plaraphy.com/api/classifier' payload = 'text=Save time and immediately improve your writing with Plaraphy API.', headers = { 'accept': 'application/json', 'content-type': 'application/x-www-form-urlencoded', 'authorization': 'Bearer ', 'cache-control': 'no-cache', } response = requests.request('POST', url, data=payload, headers=headers) print(response.text)
JavaScript Jquery AJAX
var settings = { "async": true, "crossDomain": true, "url": "https://app.plaraphy.com/api/classifier", "method": "POST", "headers": { "accept": "application/json", "content-type": "application/x-www-form-urlencoded", "authorization": "Bearer ", "cache-control": "no-cache" }, "data": { "text=Save time and immediately improve your writing with Plaraphy API.", } } $.ajax(settings).done(function (response) { console.log(response); });
Retrieve Documentation
With the Retrieve endpoint you can get the response from any JOB ID. Your JOB ID from the rewriter endpoint or plagiarism endpoint is what we use to identify your request. Your job ID is the unique identifier given to each job you submit. This information is required when you query a job's status from either our rewriter endpoint or plagiarism endpoint.
Your API query:
GET https://app.plaraphy.com/api/retrieve?job_id=[JOB_ID]
API Features
Object | Description |
---|---|
access_key
|
[Required] Your API Access Key. |
job_id
|
[Required] (PLAGIARISM AND REWRITER ONLY) Your JOB ID from the rewriter endpoint or plagiarism endpoint |
Example API Request:
curl 'https://app.plaraphy.com/api/retrieve' -X GET -H 'Accept: application/json' -H 'Authorization: Bearer ' --data $'job_id=[JOB_ID]'
Example API Response:
{ "original": "The current Covid outbreak, the most widespread since the start of the pandemic in 2020, has painted Xi Jinping, China’s president, into a corner. He has refused to budge on the government’s strict Covid approach. If he loosens restrictions and infections skyrocket, there is the risk of mass casualties and an overwhelmed health care system. But keeping the current policies in place and limiting infections with widespread lockdowns would inflict further damage to an already slowing economy.", "rewrited": "The current Covid outbreak has put China's president into a corner. He has refused to change his stance on the Covid approach. There is a risk of mass casualties if he loosens his restrictions. Keeping the current policies in place would cause more damage to the economy.", "parameters": { "unique": "true", "mode": "normal" }, "success": true, "job_id": null }
PHP cURL
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://app.plaraphy.com/api/retrieve",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => http_build_query(array("job_id" => "[JOB_ID]")),
CURLOPT_HTTPHEADER => array(
"accept: application/json",
"authorization: Bearer
",
"cache-control: no-cache",
"content-type: application/x-www-form-urlencoded"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Python
import requests url = 'https://app.plaraphy.com/api/retrieve' payload = 'job_id=[JOB_ID]', headers = { 'accept': 'application/json', 'content-type': 'application/x-www-form-urlencoded', 'authorization': 'Bearer ', 'cache-control': 'no-cache', } response = requests.request('GET', url, data=payload, headers=headers) print(response.text)
JavaScript Jquery AJAX
var settings = { "async": true, "crossDomain": true, "url": "https://app.plaraphy.com/api/retrieve", "method": "GET", "headers": { "accept": "application/json", "content-type": "application/x-www-form-urlencoded", "authorization": "Bearer ", "cache-control": "no-cache" }, "data": { "job_id=[JOB_ID]", } } $.ajax(settings).done(function (response) { console.log(response); });