Meta tags:
description=A guide to using the Copyscape Premium API to check content for uniqueness.;

Headings (most frequently used words):

request, response, plagiarism, search, private, index, and, add, to, api, url, text, json, xml, ai, detector, copyscape, premium, using, the, sample, code, initial, checks, full, comparisons, html, delete, from, check, balance, getting, assistance,

Text of the page (most frequently used words):
the (216), api (92), and (83), for (74), your (69), text (56), copyscape (48), http (41), index (41), private (40), xml (39), yes (39), #request (38), search (34), url (34), json (33), #response (32), you (30), html (30), this (30), with (29), page (29), parameter (28), com (28), full (28), are (25), found (24), responses (23), from (23), name (22), check (22), that (22), post (21), was (20), example (20), www (20), content (20), plagiarism (20), value (19), article (19), succeeded (19), not (18), explanation (17), use (16), premium (16), using (16), words (16), operation (15), key (15), returns (14), username (14), parameters (14), add (14), provide (14), comparisons (14), matching (14), how (13), number (13), below (13), will (13), may (13), set (13), each (13), results (13), also (12), listed (12), these (12), added (12), web (12), can (12), raw (12), payload (12), comparison (12), internet (11), result (11), title (11), urlencoding (11), fields (10), format (10), ignore (10), urlencoded (10), one (10), source (10), more (10), searches (9), utf (9), encoded (9), specified (9), either (9), handle (9), encoding (9), requests (9), form (9), some (9), segment (9), limit (9), searched (9), against (9), initial (9), contains (8), per (8), present (8), cost (8), without (8), such (8), top (8), all (7), any (7), balance (7), has (7), dollars (7), object (7), element (7), subelements (7), default (7), required (7), follows (7), https (7), send (7), urls (7), get (7), error (7), note (7), level (7), values (7), two (7), score (7), detector (7), omitted (7), our (7), cpsearch (7), explains (7), about (7), please (6), remaining (6), created (6), must (6), used (6), method (6), should (6), data (6), spend (6), retrieved (6), between (6), copies (6), sites (6), longer (5), failed (5), delete (5), whether (5), additional (5), declaration (5), successful (5), tool (5), they (5), information (5), generated (5), applied (5), user (5), settings (5), which (5), code (5), matched (5), exact (5), performed (5), snippet (5), query (5), csearch (5), test (5), via (5), describes (5), available (4), account (4), future (4), contain (4), supplied (4), within (4), over (4), usually (4), language (4), lets (4), list (4), build (4), automatically (4), ways (4), asp (4), java (4), php (4), based (4), checks (4), would (4), count (4), info (4), font (4), site2 (4), site1 (4), psearch (4), users (4), sample (4), receive (4), copysentry (4), free (4), products (4), terms (3), have (3), contact (3), returned (3), basic (3), sia_1_4487334_3978624 (3), requires (3), confirming (3), provided (3), independence (3), described (3), above (3), unicode (3), latin (3), cyrillic (3), windows (3), 1251 (3), iso (3), 8859 (3), iana (3), none (3), except (3), itself (3), easier (3), building (3), lower (3), command (3), line (3), curl (3), browsers (3), submit (3), forms (3), easiest (3), scripting (3), probably (3), other (3), replaced (3), examples (3), scores (3), less (3), than (3), global (3), into (3), separate (3), its (3), zero (3), describing (3), law (3), indiana (3), when (3), human (3), display (3), minwordsmatched (3), few (3), both (3), perform (3), interface (3), server (3), sign (3), allows (3), wordpress (3), 2026 (2), rights (2), textual (2), description (2), field (2), valid (2), possible (2), given (2), today (2), credit (2), much (2), there (2), could (2), problem (2), my_article_123 (2), deleted (2), successfully (2), parser (2), safely (2), recognized (2), taken (2), mydomain (2), whose (2), pindexadd (2), most (2), languages (2), built (2), function (2), see (2), since (2), aiscore (2), segments (2), array (2), objects (2), providing (2), case (2), very (2), 583 (2), checked (2), querywords (2), credits (2), reason (2), failure (2), formats (2), formatting (2), edu (2), uslawdocs (2), people (2), seas (2), course (2), events (2), percentage (2), submitted (2), wordsmatched (2), iframe (2), window (2), contents (2), displayed (2), modification (2), viewurl (2), view (2), a1b2c3d4e5 (2), viewing (2), color (2), equal (2), station (2), pages (2), allviewurl (2), alltextmatched (2), allpercentmatched (2), allwordsmatched (2), charged (2), subdomains (2), then (2), ignored (2), always (2), blog (2), ten (2), delay (2), seconds (2), public (2), comma (2), delimited (2), domains (2), create (2), who (2), click (2), does (2), razor (2), syntax (2), write (2), costs (2), seamlessly (2), integrate (2), workflow (2), new (2), log (2), faqs (2), help (2), online (2), resources (2), responding (2), preventing (2), generative (2), banners (2), enterprise (2), testimonials (2), press (2), indigo, stream, technologies, providers, reserved, siteliner, giga, alert, questions, problems, regarding, getting, assistance, backwards, compatibility, but, meaning, past, had, fixed, price, know, many, were, current, word, pricing, total, 9990, 999, monetary, charge, deleting, articles, pindexdel, item, return, message, otherwise, ascii, characters, been, 123, reference, 472, space, accurate, whole, nonetheless, highlight, hot, spots, suspected, average, 392971, broken, sentences, estimated, probability, unlikely, likely, 982874, aicheck, assess, change, rely, structure, excludes, show, ensure, consistent, own, red, authority, good, colonies, solemnly, publish, declare, inevitably, interrupt, connections, correspondence, their, legislature, extend, unwarrantable, jurisdiction, merciless, indian, savages, known, rule, warfare, excited, domestic, insurrections, amongst, endeavoured, bring, plundered, ravaged, coasts, burnt, towns, destroyed, transporting, beyond, tried, pretended, offences, opposing, manly, firmness, his, invasions, queried, appropriate, body, includes, series, paragraphs, minimal, document, 404, retrieving, urlerror, textmatched, percentmatched, 133, 950, urlwords, highlighted, measure, amount, relative, approximate, compare, minimum, 777777, 000000, version, htmlsnippet, showing, textsnippet, gmt, 639, articlewords, position, links, temporary, weeks, after, expire, summarize, portion, simultaneously, differ, original, frameset, redirection, extract, 387, specification, don, mind, times, thorough, called, attempts, fetch, complete, compares, every, time, through, controls, maximum, prioritizing, longest, lengths, included, fail, uses, non, able, read, prioritize, speed, fast, efficient, way, indexes, indicative, containing, short, selection, length, provides, indication, largest, quantities, however, download, accessing, flavors, net, yet, include, visual, coldfusion, perl, ruby, python, levels, demonstrate, following, sections, need, begin, simple, script, side, runs, queries, cannot, accessed, javascript, running, mean, revealing, end, same, first, 200, plus, 100, part, thereof, technical, perspective, application, programming, developers, scripts, service, common, including, credentials, checking, plugin, internal, systems, enters, guide,

Text of the page (random words):
r available or uses a non html format that copyscape is not able to read url plagiarism search request to check for copies of a web page via the copyscape api send an http get request to either of these urls http www copyscape com api https www copyscape com api parameters are specified on the url using and as follows parameter explanation value required default u your username your username yes k your api key your api key yes o api operation csearch or psearch or cpsearch if you create a private index yes q source url urlencoded url yes c full comparisons 0 to 10 no 0 f response format json or xml or html no xml i ignore sites comma delimited domains to ignore no l spend limit value in dollars e g 0 50 no x example test 1 or omitted no api operation o use csearch to search against the public internet or psearch to search against your private index you can also use cpsearch to search against both the internet and your private index for the cost of two searches source url q as per the http specification this must be urlencoded for example should be replaced by 3f and replaced by 26 most languages provide a built in function for urlencoding see examples in php java and asp full comparisons c set to a value between 1 and 10 to request a full comparison with an exact count of matching words between the query text and the top one to ten results found note that full comparisons may add a delay of a few seconds more info ignore sites i subdomains are also omitted from the results for example if set to site1 com site2 com then www site1 com and blog site2 com would also be ignored ignore sites listed in your user settings are always applied spend limit i if this parameter is omitted the limit per search set in your user settings is applied example test x if set to 1 the api will search the internet for copies of http www copyscape com example html and you will not be charged text plagiarism search request to check for copies of some text via the copyscape api send an http post request to either of these urls http www copyscape com api https www copyscape com api the text to be searched and other parameters can be specified in one of two ways form encoded provide all parameter values as form urlencoded data within the http post payload this is how web browsers submit forms over http and will usually be easiest if your scripting language lets you set up an http post request with a list of parameter values it will probably build this form urlencoded payload automatically raw post provide all parameters except the text to be searched parameter t on the url using urlencoding and and as if this was an http get provide the text itself in the raw http post payload data with no parameter name and no urlencoding this method may be easier if you are building http requests at a lower level or using a command line tool such as curl the parameters are as follows parameter explanation value required default u your username your username yes k your api key your api key yes o api operation csearch or psearch or cpsearch if you create a private index yes e text encoding encoding name yes t text to be searched the text yes c full comparisons 0 to 10 no 0 f response format json or xml or html no xml i ignore sites comma delimited domains to ignore no l spend limit value in dollars e g 0 50 no x example test 1 or omitted no api operation o use csearch to search against the public internet or psearch to search against your private index you can also use cpsearch to search against both the internet and your private index for the cost of two searches text encoding e use an iana name such as utf 8 unicode iso 8859 1 latin 1 or windows 1251 cyrillic text to be searched t if you are using the raw post method as described above the raw text should be supplied in the post payload without a parameter name and without any urlencoding full comparisons c set to a value between 1 and 10 to request a full comparison with an exact count of matching words between the query text and the top one to ten results found note that full comparisons may add a delay of a few seconds more info ignore sites i subdomains are also omitted from the results for example if set to site1 com site2 com then www site1 com and blog site2 com would also be ignored ignore sites listed in your user settings are always applied spend limit i if this parameter is omitted the limit per search set in your user settings is applied example test x if set to 1 the api will search the internet for copies of the text on http www copyscape com example html and you will not be charged json xml plagiarism search response for searches with json responses the api returns a json object with the fields listed below for searches with xml responses the api returns a response xml element with the subelements listed below utf 8 encoded name explanation present example query url searched if a url search http mydomain com page html error reason for api request failure if request failed no credits remaining querywords number of words checked if succeeded 583 cost cost in dollars of this search if succeeded 0 09 count number of results found if succeeded 6 allwordsmatched number of source words matched if succeeded and c 3 and o is not cpsearch 387 allpercentmatched percentage of source words matched if succeeded and c 3 and o is not cpsearch 56 alltextmatched full extract of source text matched if succeeded and c 3 and o is not cpsearch when in the course of human events allviewurl url for viewing found results if succeeded and o is csearch http view copyscape com search a1b2c3d4e5 the query value may differ from the original url you supplied if there was a frameset or redirection the allwordsmatched allpercentmatched and alltextmatched values are based on full comparisons performed between the source text and the top up to 10 results found they summarize the portion of the source text that was matched in any of these full comparisons more info they are present if the c parameter is 3 or more and the search was not performed against both the internet and your private index simultaneously the allviewurl value can be used to display the list of results in an iframe or window if used the contents of this page must be displayed in full without modification please note that these links are temporary and are valid for no longer than a few weeks after which they expire for successful searches with json responses the top level object contains a result array of zero or more objects each describing one result that was found for successful searches with xml responses the top level response element contains zero or more result subelements each describing one result that was found in either case each result has the fields below name explanation present example index position in results yes 1 url url of found page or source url of page in private index yes http www law indiana edu uslawdocs declaration html handle handle of found article if private index sia_1_4487334_3978624 id id of found article if private index my_article_123 articlewords number of words in found article if private index 639 added when the found article was added gmt if private index 2026 10 04 04 33 19 title title of the found web page or article in your private index yes declaration of independence textsnippet text snippet showing some of the matching text yes separate and equal station to which htmlsnippet html version of snippet for display in web pages yes font color 777777 font font color 000000 separate and equal station font minwordsmatched minimum number of words matching yes 96 viewurl url for viewing found page if internet result http view copyscape com compare a1b2c3d4e5 1 the minwordsmatched value is an approximate and relative measure of the amount of matching content found for each result for an exact count of matching words in the top results use the c api parameter to request full comparisons more info the viewurl value can be used to display the found page with the matching content highlighted in an iframe or window if used the contents of this page must be displayed in full without modification if a full comparison was performed for a result it may also contain name explanation present example urlwords number of words in found page if internet page retrieved ok 950 wordsmatched exact number of words matching if page retrieved ok 133 percentmatched percentage of submitted content matched on page if page retrieved ok 13 textmatched matching text in full if page retrieved ok when in the course of human events urlerror error retrieving url if internet page not retrieved the document could not be retrieved error code 404 please note that additional fields may be added in future so your json or xml parser must safely ignore any that are not recognized html plagiarism search response for html responses the api returns utf 8 encoded content with minimal html formatting if the search request succeeded the title of the html page contains the url queried if appropriate and the number of results found the body of the page includes a series of paragraphs one for each result for example declaration of independence indiana law for opposing with manly firmness his invasions on the rights of the people for transporting us beyond seas to be tried for pretended offences he has plundered our seas ravaged our coasts burnt our towns and destroyed the he has excited domestic insurrections amongst us and has endeavoured to bring on the merciless indian savages whose known rule of warfare by their legislature to extend an unwarrantable jurisdiction over us which would inevitably interrupt our connections and correspondence by the authority of the good people of these colonies solemnly publish and declare http www law indiana edu uslawdocs declaration html if the api request failed the html response will contain some red text describing the error the html format may change in the future so you should not rely on its structure the html also contains less information than the json and xml formats and excludes full comparisons to show more information or ensure consistent formatting please use the json or xml response format and build your own html based on the information in the json or xml responses ai detector request to assess whether some text was ai generated send an http post request to either of these urls http www copyscape com api https www copyscape com api the text to be searched and other parameters can be specified in one of two ways form encoded provide all parameter values as form urlencoded data within the http post payload this is how web browsers submit forms over http and will usually be easiest if your scripting language lets you set up an http post request with a list of parameter values it will probably build this form urlencoded payload automatically raw post provide all parameters except the text to be searched parameter t on the url using urlencoding and and as if this was an http get provide the text itself in the raw http post payload data with no parameter name and no urlencoding this method may be easier if you are building http requests at a lower level or using a command line tool such as curl the parameters are as follows parameter explanation value required default u your username your username yes k your api key your api key yes o api operation aicheck yes e text encoding encoding name yes t text to be searched the text yes f response format json or xml yes l spend limit value in dollars e g 0 50 no text encoding e use an iana name such as utf 8 unicode iso 8859 1 latin 1 or windows 1251 cyrillic text to be searched t if you are using the raw post method as described above the raw text should be supplied in the post payload without a parameter name and without any urlencoding spend limit i if this parameter is omitted the limit per search set in your user settings is applied json xml ai detector response for json responses the api returns a json object with the fields listed below for xml responses the api returns a response xml element with the subelements listed below utf 8 encoded name explanation present example error reason for api request failure if request failed no credits remaining querywords number of words checked if succeeded 583 cost cost in dollars of this search if succeeded 0 09 aiscore global ai score from 0 01 to 0 99 if succeeded 0 982874 ai scores provide an estimated probability that content is ai generated from 0 01 1 or very unlikely to 0 99 99 or very likely for successful checks the text is also broken up into segments usually sentences with a separate ai score for each segment for json responses the top level object contains a segments array of objects each providing one segment and its score for xml responses the top level response element contains zero or more segment subelements each providing one segment and its score in either case each segment has the fields below name explanation present example text the text of the segment yes to be or not to be aiscore segment ai score from 0 01 to 0 99 yes 0 392971 the ai scores for each segment will be less accurate than the global ai score for the text as a whole since they are based on much less information nonetheless they can be used to highlight hot spots of suspected ai content note that the global ai score is not an average of the per segment ai scores url add to private index request this api operation requires a private index to be created for your account to add the content from a url to your private index send an http get request to either of these urls http www copyscape com api https www copyscape com api parameters are specified on the url using and as follows parameter explanation value required default u your username your username yes k your api key your api key yes o api operation pindexadd yes q source url urlencoded url yes i article id id for private index no none f response format json or xml or html no xml source url q and article id i these parameters must be urlencoded for example should be replaced by 3f by 26 and space by or 20 most languages provide a built in function for urlencoding see examples in php java and asp the title of the article in your private index is taken from the web page at the url provided the request returns a response confirming if the operation was successful text add to private index request this api operation requires a private index to be created for your account to add some text to your private index send an http post request to either of these urls http www copyscape com api https www copyscape com api the text to be added and other parameters can be specified in one of two ways form encoded provide all parameter values as form urlencoded data within the http post payload this is how web browsers submit forms over http and will usually be easiest if your scripting language lets you set up an http post request with a list of parameter values it will probably build this form urlencoded payload automa...