API Documentation

The web api has the following URLs, all requests are done over the HTTP protocol.

GET /languages

Returns a json array of available languages

GET /[language]/

Returns a json array of available configurations

POST /[language]/[configuration]/api/[format]

This is the base point for pure text annotation.

POST /[language]/[configuration]/api/json

Input: Raw plain text encoded using utf-8 in the content body of the post.

Returns: Annotated document in Docforia JSON format.

POST /[language]/[configuration]/api/binary

Input: Raw plain text encoded using utf-8 in the content body of the post.

Returns: Annotated document in Docforia binary format.

POST /[language]/[configuration]/api/annoviz

Internal API used by the visualizer

POST /[language]/[configuration]/api/tsv

Input: Raw plain text encoded using utf-8 in the content body of the post.

Returns: CoNLL-like Tab Seperated Values file encoded using UTF-8

POST /[language]/[configuration]/api/wikipedia/[format]

Same as the pure text variant except that the POST content body is expected to be Wikipedia HTML pages as retrieved using Wikipedia REST services.

Note: The TSV format is not supported for Wikipedia due to the wealth of information.