source: code/trunk/static/docs/index.html@ 64

Last change on this file since 64 was 64, checked in by yakumo.izuru, 17 months ago

Does verbose mode even work, anyways, releasing V1 now

Signed-off-by: Izuru Yakumo <yakumo.izuru@…>
File size: 1.8 KB
Line 
1<!DOCTYPE HTML PUBLIC "//W3C DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html>
3 <head>
4 <link rel="stylesheet" href="/static/docs.css">
5 <meta http-equiv="Content-type" content="text/html; charset=utf-8">
6 <meta name="author" content="Izuru Yakumo">
7 <title>API Documentation | Mai</title>
8 </head>
9 <body id="body">
10 <h1 id="header">Documentation</h1>
11 <br><hr>
12 <h2 class="get">[GET] /api/translate</h2>
13 <h2 class="post">[POST] /api/translate</h2>
14 <h3>Description</h3>
15 <p>Translation endpoint</p>
16 <h3>Arguments</h3>
17 <ul>
18 <li>engine</li>
19 <li>from</li>
20 <li>text</li>
21 <li>to</li>
22 </ul>
23 <h3>Examples</h3>
24 <p><pre><code>GET /api/translate?engine=google&amp;from=auto&amp;to=en&amp;text="sonrisa"</code></pre></p>
25 <hr>
26 <h2 class="get">[GET] /api/source_languages</h2>
27 <h2 class="get">[GET] /api/target_languages</h2>
28 <h3>Description</h3>
29 <p>Get a JSON array of supported source and target languages for a particular engine</p>
30 <h3>Arguments</h3>
31 <ul>
32 <li>engine</li>
33 </ul>
34 <h3>Examples</h3>
35 <p><pre><code>GET /api/source_languages?engine=google</code></pre></p>
36 <p><pre><code>GET /api/target_languages?engine=google</code></pre></p>
37 <hr>
38 <h2 class="get">[GET] /api/tts</h2>
39 <h3>Description</h3>
40 <p>Obtain text-to-speech audio files from an engine, provided said engine supports them</p>
41 <h3>Arguments</h3>
42 <ul>
43 <li>engine</li>
44 <li>lang</li>
45 <li>text</li>
46 </ul>
47 <h3>Examples</h3>
48 <p><pre><code>GET /api/tts?engine=google&amp;lang=en&amp;text="hi"</code></pre></p>
49 <hr>
50 <h2 class="post">[POST] /switchlanguages</h2>
51 <h3>Description</h3>
52 <p>Switch between source and target languages, as long as the source language isn't "auto"</p>
53 <hr>
54 <a href="/">Return to Mai</a>
55 </body>
56</html>
Note: See TracBrowser for help on using the repository browser.