This reference describes RESTful web methods for interacting with Tisane API using standard HTTP and JSON-based communication.
This reference describes RESTful web methods for interacting with Tisane API using standard HTTP and JSON-based communication.
curl -i -X POST \
https://api.tisane.ai/parse \
-H 'Content-Type: application/json' \
-H 'Ocp-Apim-Subscription-Key: YOUR_API_KEY_HERE' \
-d '{
"language": "en",
"content": "Hello Tisane API!!"
}'{ "text": "Hello Tisane API!", "entities_summary": [ { … } ] }
Retrieve a list of supported languages.
The response includes the following attributes:
id - Language ID.name - Native name.englishName - English name.nativeEncoding - Encoding of the language.preferredFont - Recommended font for display.latin - Whether the language uses Latin script.rightToLeft - Whether the language uses right-to-left script (e.g., Arabic, Hebrew, Persian).curl -i -X GET \
https://api.tisane.ai/languages \
-H 'Content-Type: application/json' \
-H 'Ocp-Apim-Subscription-Key: YOUR_API_KEY_HERE'[ { "isoCode": "ar", "name": "العربية", "englishName": "Arabic", "nativeEncoding": "iso-8859-6", "fontFace": "Arial", "latin": false, "rightToLeft": true }, { "isoCode": "en", "name": "English", "englishName": "English", "nativeEncoding": "iso-8859-1", "fontFace": "Arial", "latin": true }, { "isoCode": "zh-CN", "name": "简体中文", "englishName": "Chinese, Simplified", "nativeEncoding": "gb18030", "fontFace": "NSimSun", "latin": false }, { "isoCode": "zh-TW", "name": "繁體中文", "englishName": "Chinese, Traditional", "nativeEncoding": "iso-8859-1", "fontFace": "Arial Unicode MS", "latin": false }, { "isoCode": "ja", "name": "日本語", "englishName": "Japanese", "nativeEncoding": "ISO-2022", "fontFace": "MS Mincho", "latin": false }, { "isoCode": "ru", "name": "русский", "englishName": "Russian", "nativeEncoding": "iso-8859-1", "fontFace": "Arial", "latin": false } ]
curl -i -X POST \
https://api.tisane.ai/helper/extract_text \
-H 'Content-Type: text/plain' \
-H 'Ocp-Apim-Subscription-Key: YOUR_API_KEY_HERE' \
-d '<p>Clean me up</p> <style>/* Styles are unnecessary for text analysis */</style>'Compares two compound named entities and identifies differences. The request body should include:
language1 (string) - IETF tag for the first entity's language.entity1 (string) - The first entity.language2 (string) - IETF tag for the second entity's language.entity2 (string) - The second entity.type (string) - The entity type (currently only person is supported).More information: Named Entities in the Tisane API Response Guide The response contains:
result (string) - Comparison result:
no_single_entity - One or both entities are invalid.same - Entities are identical (name order might differ).different - Entities differ, with details in differences.differences (array of strings) - Lists detected differences:
given_namesurnametitle (e.g., Mr., Mrs.)social_role (e.g., academic degrees)suffixvariation (e.g., spelling or style differences)curl -i -X POST \
https://api.tisane.ai/compare/entities \
-H 'Content-Type: application/json' \
-H 'Ocp-Apim-Subscription-Key: YOUR_API_KEY_HERE' \
-d '{
"language1": "en",
"entity1": "Gary Youngman MD",
"language2": "en",
"entity2": "Gary Oldman",
"type": "person"
}'{ "result": "different", "differences": [ "surname", "social_role" ] }
Calculate the semantic similarity between two text fragments, either in the same language or in different languages.
The request body should contain:
content1 (string) - The first text fragment.language1 (string) - The IETF language code for content1.content2 (string) - The second text fragment to compare.language2 (string) - The IETF language code for content2.settings (object) - Additional settings as per specifications. More information: Tisane API Configuration And Customization Guide.The response is a number between 0 and 1, representing the similarity of the submitted text fragments.
curl -i -X POST \
https://api.tisane.ai/similarity \
-H 'Content-Type: application/json' \
-H 'Ocp-Apim-Subscription-Key: YOUR_API_KEY_HERE' \
-d '{
"language1": "en",
"content1": "Franz Ferdinand was assassinated by a Serbian revolutionary",
"language2": "en",
"content2": "A Yugoslav radical assassinated Franz Ferdinand",
"settings": {}
}'Detects the languages used in the provided text fragment and returns the breakdown by offsets.
The request body should include:
content (string) - the text fragment to analyze.languages (string, optional) - a vertical bar-delimited list of language codes to use as cues.delimiter (string, optional) - a regular expression for segmenting the fragment; by default, the fragment is not segmented. The response is a JSON structure containing languages, which provides a breakdown of language codes.curl -i -X POST \
https://api.tisane.ai/detectLanguage \
-H 'Content-Type: application/json' \
-H 'Ocp-Apim-Subscription-Key: YOUR_API_KEY_HERE' \
-d '{
"content": "c'\''est la vie"
}'{ "languages": [ { … } ] }
This method translates the input text. The request body should include the following elements:
from (string) - A standard IETF tag for the source language. Use * or a vertical bar-delimited set of language codes to invoke autodetect.to (string) - A standard IETF tag for the target language. If the source and target languages are the same, paraphrasing will be applied.content (string) - The text content to translate.settings (object) - Additional translation settings.More information: Tisane API Configuration And Customization Guide
The response is the transformed text.
curl -i -X POST \
https://api.tisane.ai/transform \
-H 'Content-Type: application/json' \
-H 'Ocp-Apim-Subscription-Key: YOUR_API_KEY_HERE' \
-d '{
"from": "ja",
"to": "en",
"content": "彼女はりんごを食べます",
"settings": {}
}'She is eating an apple