2435673dff
Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja> git-svn-id: file:///srv/svn/repo/mai/trunk@66 e410bdd4-646f-c54f-a7ce-fffcc4f439ae
56 lines
1.8 KiB
HTML
56 lines
1.8 KiB
HTML
<!DOCTYPE HTML PUBLIC "//W3C DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<link rel="stylesheet" href="/docs/style.css">
|
|
<meta http-equiv="Content-type" content="text/html; charset=utf-8">
|
|
<meta name="author" content="Izuru Yakumo">
|
|
<title>API Documentation | Mai</title>
|
|
</head>
|
|
<body id="body">
|
|
<h1 id="header">API Documentation</h1>
|
|
<br><hr>
|
|
<h2 class="get">[GET] /api/translate</h2>
|
|
<h2 class="post">[POST] /api/translate</h2>
|
|
<h3>Description</h3>
|
|
<p>Translation endpoint, input must be URL-encoded (e.g. multi-byte characters, words separated by space)</p>
|
|
<h3>Arguments</h3>
|
|
<ul>
|
|
<li>engine</li>
|
|
<li>from</li>
|
|
<li>text</li>
|
|
<li>to</li>
|
|
</ul>
|
|
<h3>Examples</h3>
|
|
<p><pre><code>GET /api/translate?engine=google&from=auto&to=en&text="sonrisa"</code></pre></p>
|
|
<hr>
|
|
<h2 class="get">[GET] /api/source_languages</h2>
|
|
<h2 class="get">[GET] /api/target_languages</h2>
|
|
<h3>Description</h3>
|
|
<p>Get a JSON array of supported source and target languages for a particular engine</p>
|
|
<h3>Arguments</h3>
|
|
<ul>
|
|
<li>engine</li>
|
|
</ul>
|
|
<h3>Examples</h3>
|
|
<p><pre><code>GET /api/source_languages?engine=google</code></pre></p>
|
|
<p><pre><code>GET /api/target_languages?engine=google</code></pre></p>
|
|
<hr>
|
|
<h2 class="get">[GET] /api/tts</h2>
|
|
<h3>Description</h3>
|
|
<p>Obtain text-to-speech audio files from an engine, provided said engine supports them</p>
|
|
<h3>Arguments</h3>
|
|
<ul>
|
|
<li>engine</li>
|
|
<li>lang</li>
|
|
<li>text</li>
|
|
</ul>
|
|
<h3>Examples</h3>
|
|
<p><pre><code>GET /api/tts?engine=google&lang=en&text="hi"</code></pre></p>
|
|
<hr>
|
|
<h2 class="post">[POST] /switchlanguages</h2>
|
|
<h3>Description</h3>
|
|
<p>Switch between source and target languages, as long as the source language isn't "auto"</p>
|
|
<hr>
|
|
</body>
|
|
</html>
|