Stilus API | Stilus

1 What is Stilus API?

2 Endpoint

3 Request
3.1 Dictionaries

4 Response

5 Example

6 Use the API

Usar Stilus API

1 What is Stilus API?

Stilus API is Stilus' developer platform designed to customize and integrate the Spanish proofreading service into any publishing environment (either proprietary or third-party).

Easy to use. Stilus API requires an Internet connection to enable user authentication and account service consumption. Requests to the API's endpoints are made through GET o POST, according to the linguistic configuration set for the proofreading.

Register at Stilus to start a free trial and try the demo. To integrate the API, read the following instructions or request a quote if you want to purchase the service. In any case, contact MeaningCloud to agree upon the proofreading volume you need.

2 Endpoint

The API's endpoint is:

http://«server»/«root path»/api/stilus.php

3 Request

Requests are made using GET or POST data submissions to the API entry point. Typically, a POST method is recommended in order to overcome the parameter maximum length limit associated to the GET method. The parameters are the following:

Parameter	Description	Values	Required
`key`	The access key is required for making requests to any of our web services. You can get a valid access key for free just by creating an account at MeaningCloud.	String	Yes
`txt`	Input text that's going to be analyzed.	String	Yes
`url`	URL with the content to check. Currently only non-authenticated HTTP and FTP are supported. The content types supported for URL contents can be found here.	String	No
`ilang`	It specifies the interface language, that is, the language in which the messages in the response will appear.	EN: english ES: spanish	No Default: ES
`mode`	This field will determine how the issues are detected in the text.	all: Returns all errors found in the text. next: Returns only the first error found. In combination with the offset parameter, you can obtain, one by one, all the text errors.	No Default: all
`version`	Version of the API	String	No
`if`	Input format	String	No Default: html
`of`	Output format	xml, json	No Default: json
`offset`	Offset in which to start the revision. This functionality together with the mode=next are used when the application that calls the API needs to receive the issues in a text one by one.	Positive number from 0 to text length.	No Default: 0
`dic`	This parameter will specify the list of active dictionaries that will be used in the review. Each dictionary will be represented with a letter (detailed below). There are two types of dictionaries, thematic dictionaries, with domain specific terms, and language varieties, with terms specific to the language variety in question.	See the dictionaries section.	No Default: chetsdpqr
`pp`	Smart detection of prefixed words.	y: enabled n: disabled	No Default: y
`aqoi`	Smart handling of words written in italics or with quotation marks.	y: enabled n: disabled	No Default: y
`tls`	Warn of too-long sentences.	y: enabled n: disabled	No Default: y
`dpn`	Smart detection of proper nouns.	y: enabled n: disabled	No Default: n
`stme`	Describes how it will behave when it finds sentences with many errors.	0: Check for all 1: Group and ignore 2: Group and warn	No Default: 2
`red`	Check tautology and language misuse.	y: enabled n: disabled	No Default: y
`spa`	Check spacing.	y: enabled n: disabled	No Default: y
`comppunc`	Verify the opening and closing of pairs of signs.	y: enabled n: disabled	No Default: y
`corrpunc`	Check punctuation marks.	y: enabled n: disabled	No Default: y
`alw`	Warn of foreign words to be avoided.	y: enabled n: disabled	No Default: n
`wct`	Warn of confusion between terms.	y: enabled n: disabled	No Default: n
`wps`	Warn of percentage signs (%) not spaced.	y: enabled n: disabled	No Default: n
`psr`	Warn of possible reduction of the consonant clusters ps-.	y: enabled n: disabled	No Default: n
`nsr`	Warn of possible reduction of the consonant clusters -ns-.	y: enabled n: disabled	No Default: n
`bsr`	Warn of possible reduction of the consonant clusters -bs-..	y: enabled n: disabled	No Default: n
`str`	Warn of possible reduction of the consonant clusters -st-..	y: enabled n: disabled	No Default: n
`vr`	Warn of possible vowel reductions.	y: enabled n: disabled	No Default: n
`sdm`	Warn of removing the accent mark from «sólo».	y: enabled n: disabled	No Default: n
`ddm`	Warn of removing the accent mark from demonstratives.	y: enabled n: disabled	No Default: n
`conf`	Field that indicates the minimum confidence required in the responses.	Positive number from 0 to 100	No Default: 60

3.1 Dictionaries

Language	Thematic dictionaries	Language varieties	Default value
Spanish	c: Science and Technology h: Humanities e: Economy t: Natural Sciences s: Social Sciences d: Sport p: Politics q: Colloquial word r: Archaic words	0: Latin American Spanish 1: Northern Latin American Spanish 2: Central American Spanish 3: Southern Latin American Spanish 4: Caribbean Spanish M: Mexican Spanish	chetsdpqr

4 Response

The response contains the information associated with the result of the request. You can find a description of each of its fields in the following table.

Name Description

status

Contains information about the revision 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.

These are the possible status codes and the associated messages:

Code	Message
`0`	OK
`100`	Operation denied
`101`	License expired
`102`	Credits per subscription exceeded
`103`	Request too large
`104`	Request rate limit exceeded
`200`	Missing required parameter(s) - [name of the parameter]
`201`	Language not supported
`202`	Engine internal error
`203`	Cannot connect to service

The limit referred to in status code 103 is set to 50 000 words per request.

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.

result_list

List of issues (errors, warnings or recommendations) found in the text. Each one of these issues is represented in a result element that contains the following fields:

text Text in which the error or warning is located.

type

Type of issue. There are five types or errors defined:

Code	Type
`S`	Spelling error or warning
`G`	Grammar error or warning
`Y`	Style error or warning
`T`	Typography error or warning
`M`	Semantic-related error or warning

inip Initial position of the result, starting on 0

endp End position of the result

level CEFR level of the error.

rule ID of the rule associated to the issue

msg Message that explains the issue

ref

Bibliographical reference(s) for the issue. These are the different possibilities:

RAE 2010:	Ortografía de la lengua española (Real Academia Española, 2010).
RAE 2009:	Nueva gramática de la lengua española (Real Academia Española, 2009).
DPD:	Diccionario panhispánico de dudas. (Real Academia Española, 2005).
De_Sousa:	Diccionario de usos y dudas del español actual (J. Martínez de Sousa, 2003). Ortografía y ortotipografía del español actual. (J. Martínez de Sousa, 2004).
Seco:	Diccionario de dudas y dificultades de la lengua española. (M. Seco, 2002).
Fundéu:	Recomendaciones y dudas [on line] (Fundéu BBVA).
El País:	Libro de estilo EL PAÍS. (VV. AA., 2014).

sug_list

List of possible suggestions to correct the issue. Each suggestion will have two fields:

`form`	Text of the suggestion.
`confidence`	Level of confidence for the suggestion given.

stadistics

This field contains statistics of the text sent. The values included are the following:

`words`	Number of words in the text sent.
`non-repeated_words`	Number of unique words in the text sent.
`characters_without_spaces`	Character count without taking spaces into account.
`total_characters`	Total character count.
`sentences`	Number of sentences in the text sent.
`paragraph`	Number of paragraphs in the text sent.

5 Example

Given the following text:

No vengas hacernos creer que todos vemos los mismos reality shows en television.

The output would be:

{
  "status": {
    "code": "0",
    "msg": "OK"
  },
  "result_list": [
    {
      "text": "vengas hacernos",
      "type": "G",
      "inip": "3",
      "endp": "17",
      "level": "B1",
      "rule": "ReglaVenir+INF",
      "msg": "Posiblemente sea necesario incluir la preposición a.",
      "sug_list": [
        {
          "form": "vengas a hacernos",
          "confidence": "70"
        }
      ]
    },
    {
      "text": "reality shows",
      "type": "T",
      "inip": "52",
      "endp": "64",
      "level": "A1",
      "rule": "ReglaRevisionPalabras-V",
      "msg": "Voz inglesa (debería ir en cursiva).",
      "ref": "Fundéu / El_País",
      "sug_list": [
 {
          "form": "programa de telerrealidad",
          "confidence": "99"
        },
        {
          "form": "telerrealidades",
          "confidence": "99"
        },
        {
          "form": "programa de sucesos",
          "confidence": "99"
        }
      ]
    },
    {
      "text": "television",
      "type": "S",
      "inip": "69",
      "endp": "78",
      "level": "A1",
      "rule": "ReglaRevisionPalabras-1",
      "msg": "Posible error ortográfico.",
      "sug_list": [
        {
          "form": "televisión",
          "confidence": "99"
        }
      ]
    }
  ],
  "statistics": {
    "words": "13",
    "non-repeated_words": "13",
    "characters_without_spaces": "68",
    "total_characters": "80",
    "sentences": "1",
    "paragraphs": "1"
  }
}

6 Use the API

Key:

Please contact us to obtain your demo key.

Text:

URL:

Settings

Output format: (default json)

Input format: (default html)

Language of the interface: (default spanish)

mode:

verbose:

prettyprint:

offset: (default 0)

Dictionaries (letters or numbers of each dictionary in a row without any blank spaces or commas, the codes are in the table that you can find up in the page):

Behaviour when it finds sentences with many errors:

Smart detection of prefixed words:

Smart handling of words written in italics or with quotation marks:

Warn of too-long sentences:

Smart detection of proper nouns:

Check tautology and language misuse:

Check spacing:

Verify the opening and closing of pairs of signs:

Check punctuation marks:

Warn of foreign words to be avoided:

Warn of confusion between terms:

Warn of percentage signs (%) not spaced:

Warn of possible reduction of the consonant clusters ps-:

Warn of possible reduction of the consonant clusters -ns-:

Warn of possible reduction of the consonant clusters -bs-:

Warn of possible reduction of the consonant clusters -st-:

Warn of possible vowel reductions:

Warn of removing the accent mark from «sólo»:

Warn of removing the accent mark from demonstratives:

Confidence:

You can now use the best spelling and grammar checker for Spanish for free.

Use Stilus FOR FREE