Do you have any questions? Just write us an email or ask us through the feedback section.

Response

The output contains information about the status of the request and about the language/s detected. The information provided is the same for the different output formats and the naming convention used for all fields is snake_case.

Response

These are the fields included in the response document

Name Description
status

Contains information about the extraction process and whether it has finished successfully. It is formed by a status code (code), a natural number that identifies the result, and a message (msg), a string describing the result. In addition, the field (credits) contains a natural number that indicates the credits consumed in the request and (remaining_credits) shows the number of credits left to the user to get to the credit limit.

You can find all the possible status codes returned by the API with an explanation and tips on how to manage them in our error codes catalog.

These are the possible status codes and the associated messages:

A request is any HTTP request done to the API to analyze less than 500 words. If the text sent is longer than that, then it will be considered that more than a request is made, more specifically, as many requests as we would need if the text were divided in chunks of 500 words.

For instance, an HTTP request with 1013 words, will count as three requests, so 3 credits will be consumed; an HTTP request with a text 25648 words long would count as 25648/500 = 51.296 => 52 credits, and so on.

language_list

List of detected languages for the document sent. Each element has the following structure:

  • language: language detected using the code defined by the ISO639-1 standard.
  • relevance: relevance value associated to it.
  • name: name of the language.
  • iso639-3: three letter code of the ISO639-1 standard.
  • iso639-2: two letter code of the ISO639-1 standard.
  • script: script used by the language. It will only appear when the verbose parameter is enabled.
  • speakers: number of speakers. It will only appear when the verbose parameter is enabled.

These are the supported languages:

Name ISO639-3 ISO639-2 Script Speakers
Mandarin ChinesecmnzhHan885000000
BengalibenbnBengali196000000
JapanesejpnjaHiragana, Katakana, and Han125000000
KoreankorkoHangul75000000
TelugutelteTelugu73000000
TamiltamtaTamil62000000
GujaratigujguGujarati44000000
MalayalammalmlMalayalam34014000
KannadakanknKannada33663000
BurmesemyamyMyanmar31000000
Borana-Arsi-Guji OromogaxorLatin30000000
PanjabipanpaGurmukhi25700000
ThaithathThai21000000
SinhalasinsiSinhala13218000
Modern GreekellelGreek12258540
Central KhmerkhmkmKhmer7063200
ArmenianhyehyArmenian6836000
SantalisatOl Chiki6218900
TibetanbodboTibetan6150000
GeorgiankatkaGeorgian4103000
LaolaoloLao4000000
Sichuan YiiiiiiYi1600000
Assyrian Neo-AramaicaiiSyriac1000000
SpanishspaesLatin332000000
EnglishengenLatin322000000
PortugueseporptLatin182000000
IndonesianindidLatin140000000
FrenchfrafrLatin124000000
GermandeudeLatin121000000
JavanesejavjvLatin75500800
VietnamesevieviLatin66897000
ItalianitaitLatin63000000
TurkishturtrLatin59000000
PolishpolplLatin44000000
SwahiliswhswLatin30000000
SundanesesunsuLatin27000000
RomanianronroLatin26000000
HausahauhaLatin22000000
BosnianbosbsCyrillic21000000
CroatianhrvhrLatin21000000
DutchnldnlLatin21000000
SerbiansrpsrCyrillic21000000
Central KurdishckbkuLatin20000000
YorubayoryoLatin20000000
Northern UzbekuznuzCyrillic18386000
IgboiboigLatin17000000
CebuanocebLatin15230000
TagalogtgltlLatin14850000
HungarianhunhuLatin14500000
North AzerbaijaniazjazLatin13869000
CzechcescsLatin12000000
Plateau MalagasypltmgLatin10156900
MaduresemadLatin10000000
NyanjanyanyLatin10000000
Ayacucho QuechuaquyquLatin1000000
KinyarwandakinrwLatin9306800
ZuluzulzuLatin9140000
SwedishswesvLatin9000000
LingalalinlnLatin8400000
SomalisomsoLatin8335000
Southern Qiandong MiaohmsLatin8200000
IlokoiloLatin8000000
UighuruigugArabic7464000
HaitianhathtLatin7382000
AkanakaakLatin7000000
HiligaynonhilLatin7000000
ShonasnasnLatin7000000
XhosaxhoxhLatin6858000
MinangkabauminLatin6500000
AfrikaansafrafLatin6365000
Luba-LulualuaLatin6300000
FinnishfinfiLatin6000000
RundirunrnLatin6000000
SlovakslkskLatin5606000
TurkmentuktkCyrillic5397500
DanishdandaLatin5292000
Tosk AlbanianalssqLatin5000000
Norwegian BokmålnobnbLatin5000000
SukumasukLatin5000000
SangosagsgLatin4900000
Norwegian NynorsknnonnLatin4700000
MossimosLatin4600000
CatalancatcaLatin4353000
Southern SothosotstLatin4197000
Central BikolbclLatin4000000
GalicianglgglLatin4000000
LithuanianlitltLatin4000000
UmbunduumbLatin4000000
TswanatsntnLatin3932000
PedinsoLatin3851000
BalinesebanLatin3800000
BuginesebugLatin3500000
Central KanuriknckrLatin3500000
IbibioibbLatin3186000
GandaluglgLatin3015980
AchineseaceLatin3000000
BambarabambmLatin3000000
KimbundukmbLatin3000000
LundalunLatin3000000
Central Atlas TamazighttzmLatin3000000
WaraywarLatin3000000
DyuladyuLatin2700000
WolofwolwoLatin2700000
Low GermanndsLatin2600000
MakhuwavmwLatin2500000
EweeweeeLatin2477600
SlovenianslvslLatin2218000
Central AymaraayrayLatin2200000
BembabemLatin2150000
Eastern ManinkakanemkLatin2140300
BaoulébciLatin2130000
EsperantoepoeoLatin2000000
PampangapamLatin2000000
TivtivLatin2000000
Tok PisintpiLatin2000000
SwatisswssLatin1670000
NyankolenynLatin1643193
YaoyaoLatin1597000
LatvianlavlvLatin1550000
Vlax RomanirmyLatin1500000
Logudorese SardiniansrcscLatin1500000
ScotsscoLatin1500000
TsongatsotsLatin1500000
MendemenLatin1480000
FonfonLatin1436000
Central NahuatlnhnLatin1376898
Northeastern DinkadipLatin1350000
MakondekdeLatin1260000
SionasnnLatin1240000
KabiyèkbpLatin1200000
TimnetemLatin1200000
TongatoiLatin1105000
EstonianestetLatin1100000
SoninkesnkLatin1067000
ChokwecjkLatin1004000
AdangmeadaLatin1000000
BinibinLatin1000000
GagaaLatin1000000
KoongokngLatin1000000
NdongandongLatin1000000
Balkan RomanirmnrmLatin1000000
RussianrusruCyrillic288000000
UkrainianukrukCyrillic41000000
Komi-PermyakkoiCyrillic12500000
BelarusianbelbeCyrillic10200000
BulgarianbulbgCyrillic9000000
KazakhkazkkCyrillic8000000
TatartatttCyrillic7000000
TajiktgktgCyrillic4380000
KirghizkirkyCyrillic2631420
MacedonianmkdmkCyrillic2500000
Halh MongoliankhkmnCyrillic2330000
Standard ArabicarbarArabic280000000
UrduurdurArabic54000000
SeraikiskrArabic15020000
Iranian PersianpesfaArabic7000000
HindihinhiDevanagari182000000
MarathimarmrDevanagari64783000
MaithilimaiDevanagari34700000
BhojpuribhoDevanagari25000000
NepalinepneDevanagari16200000
MagahimagDevanagari10821000
AmharicamhamEthiopic23000000
TigrinyatirtiEthiopic6060000
HebrewhebheHebrew4612000
Eastern YiddishyddyiHebrew3000000

Response examples

The format in which this information will be shown will depend on the value of the of parameter.

    New research finds that live music played for premature babies can be beneficial, calming their heart rate and breathing, and helping their sleep and sucking ability.
{
    status: {
        code: "0",
        msg: "OK",
        credits: "1"
    },
    language_list: [
        {
            language: "en",
            relevance: "100",
            name: "English",
            iso639-3: "eng",
            iso639-2: "en"
        }
    ]
}
<?xml version="1.0" encoding="utf-8"?>
<response>
  <status code="0" credits="1">
    <![CDATA[OK]]>
  </status>
  <language_list>
    <result>
      <language>en</language>
      <relevance>100</relevance>
      <name>English</name>
      <iso6393>eng</iso6393>
      <iso6392>en</iso6392>
    </result>
  </language_list>
</response>

Check the response document DTD: XML DTD.