Skip to content

Commit

Permalink
Remove API v1 from PHP backend
Browse files Browse the repository at this point in the history
  • Loading branch information
@starscouts
starscouts committed Aug 26, 2024
1 parent 52c52a0 commit 3b0e3e3
Show file tree
Hide file tree
Showing 5 changed files with 2 additions and 375 deletions.
205 changes: 2 additions & 203 deletions server/docs/v1/index.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,211 +42,10 @@ function getAPIKey(): string {
<br><br>
<h1>Floofi Voice Generator API docs <span class="badge bg-secondary">v1</span></h1>

<div class="alert alert-warning">
<b>Notice:</b> These docs are for version 1 of the API. The latest version is version 2, which you can get docs for <a href="/docs/v2">here</a>. API version 1 may be removed at any time without warning and should be avoided.
<div class="alert alert-danger">
Version 1 of the API is now unavailable, please use a later version instead. The latest version is version 2, which you can get docs for <a href="/docs/v2">here</a>.
</div>

<p>Voice Generator provides a RESTful API that you can use to interact with various features of the AI.</p>

<h3>API limits</h3>
<ul>
<li>All API requests must be authenticated, either with an interactive session or an API key. To get your API key, please check below.</li>
<li>A single user is limited to 2 generations every minute.</li>
<li>Users making an abusive number of requests will get their account blocked.</li>
<li>Remember to follow the Acceptable Use Policy for Voice Generator, namely to properly credit your use of the platform as "Floofi Voice Generator" or "Floofi."</li>
</ul>

<h3>Your API key</h3>
<p>Your API key is <b>strictly personal</b>, sharing it will allow anyone to use on your behalf. It is displayed below, and you can hover over it or tap it to display it.</p>
<ul>
<li><code id="api-key"><?= getAPIKey() ?></code> · <!--suppress JSUnresolvedReference -->
<a onclick="navigator.clipboard.writeText(document.getElementById('api-key').innerText.trim()); return false;" href="#">Copy</a>, <a onclick="return confirm('Are you sure? If you continue, you will need to change your API key in any application that is using it.');" href="/docs/reset.php">Reset</a></li>
</ul>
<p>To authenticate with the API, you need to set the <code>Authorization</code> header to <code>Bearer &lt;API key&gt;</code>. If you are logged into through the website, your session will work on the API, although this is not a recommended way to use the API. If you are using Insomnia, click on the "Auth" tab and select "Bearer Token."</p>

<h3>Output data</h3>
<pre>
error?: {
code: number,
name: string,
see: "https://voice-api.floo.fi/docs/"
}
output: any|null
</pre>

<h3>Error codes</h3>
<table class="table">
<thead>
<tr>
<th>Code</th>
<th>Name</th>
<th>Meaning</th>
</tr>
</thead>
<tbody>
<tr>
<td>400</td>
<td>Bad Request</td>
<td>A required argument for this endpoint is missing or incorrectly formatted.</td>
</tr>
<tr>
<td>401</td>
<td>Unauthorized</td>
<td>No API key was provided with the request. If an API key was provided, it is not valid.</td>
</tr>
<tr>
<td>403</td>
<td>Forbidden</td>
<td>You should normally have access to this endpoint, but your account has been blocked by the administrators.</td>
</tr>
<tr>
<td>404</td>
<td>Not Found</td>
<td>The requested API endpoint does not exist or is not supported in this version of the API.</td>
</tr>
<tr>
<td>405</td>
<td>Method Not Allowed</td>
<td>The HTTP method used at this endpoint is not the one that is expected.</td>
</tr>
<tr>
<td>409</td>
<td>Conflict</td>
<td>You have tried to change the state of an item to a state it is already in.</td>
</tr>
<tr>
<td>413</td>
<td>Payload Too Large</td>
<td>One of the parameters sent to this API endpoint is longer than the allowed length.</td>
</tr>
<tr>
<td>429</td>
<td>Too Many Requests</td>
<td>This API key has exceeded the number of allowed requests in a certain timespan.</td>
</tr>
<tr>
<td>451</td>
<td>Unavailable For Legal Reasons</td>
<td>The request goes against 's content filters and/or terms of use.</td>
</tr>
<tr>
<td>500</td>
<td>Internal Server Error</td>
<td>A server error has occurred while processing this request.</td>
</tr>
<tr>
<td>501</td>
<td>Not Implemented</td>
<td>The version of the API you are trying to use does not exist.</td>
</tr>
</tbody>
</table>

<h3>Endpoints</h3>
<p>All API endpoints take root in https://voice-api.floo.fi/api.</p>
<table class="table">
<thead>
<tr>
<th>Method</th>
<th>Path</th>
<th>Parameters</th>
<th>Description</th>
<th>Output</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>GET</code></td>
<td>v1/status</td>
<td>-</td>
<td>Get system information.</td>
<td><pre>{
"user": string,
"version": string,
"processingUnits": [
{
"id": string,
"pid": number,
"busy": boolean
}
]
}</pre></td>
</tr>
<tr>
<td><code>GET</code><br><span class="badge bg-secondary">New</span></td>
<td>v1/available</td>
<td>-</td>
<td>Check if enqueing a new generation is possible.</td>
<td><pre>{
"available": boolean
}</pre></td>
</tr>
<tr>
<td><code>GET</code></td>
<td>v1/history</td>
<td>URL: <code>amount</code>: number (optional)</td>
<td>Get previous generations associated with this account.</td>
<td><pre>[
{
"id": string,
"version": string,
"author": string,
"status": generation-status,
"input": string,
"filename": string,
"audio_url": string?,
"explicit": boolean
}
]</pre></td>
</tr>
<tr>
<td><code>GET</code></td>
<td>v1/history/<b>:id</b></td>
<td>-</td>
<td>Get a specific generation from its ID.</td>
<td><pre>{
"id": string,
"version": string,
"author": string,
"status": generation-status,
"input": string,
"filename": string,
"audio_url": string?,
"explicit": boolean
}</pre></td>
</tr>
<tr>
<td><code>DELETE</code></td>
<td>v1/history/<b>:id</b></td>
<td>-</td>
<td>Remove a specific generation from your history using its ID.</td>
<td><pre>{
"id": string,
"version": string,
"author": string,
"status": "removed",
"input": string,
"filename": string,
"audio_url": null,
"explicit": boolean
}</pre></td>
</tr>
<tr>
<td><code>POST</code></td>
<td>v1/generate</td>
<td>JSON: <code>input</code>: string</td>
<td>Enqueue a new generation job.</td>
<td><pre>{
"id": string
}</pre></td>
</tr>
</tbody>
</table>

<h3>Types</h3>
<h5>generation-status</h5>
<pre>"removed"|"processed"|"generating"|"queued"|"crashed"</pre>

<br><br><br>
</div>
</html>
9 changes: 0 additions & 9 deletions server/includes/api/v1/available.php
View file

This file was deleted.

74 changes: 0 additions & 74 deletions server/includes/api/v1/generate.php
View file

This file was deleted.

46 changes: 0 additions & 46 deletions server/includes/api/v1/history.php
View file

This file was deleted.

43 changes: 0 additions & 43 deletions server/includes/api/v1/status.php
View file

This file was deleted.

0 comments on commit 3b0e3e3

Please sign in to comment.