This commit is contained in:
Christopher Cookman 2024-09-05 11:25:00 -06:00
parent d7fa61679e
commit ca51e58108
Signed by: ChrisChrome
GPG key ID: A023A26E42C33A42

View file

@ -45,15 +45,11 @@
<body>
<div class="container">
<h1>Roblox Audio Asset API Documentation</h1>
<h1>Roblox Audio Asset API Documentation</h1>
<h2>Endpoint</h2>
<p><strong>URL:</strong> <code>POST /</code></p>
<h2>Request Format</h2>
<p>The request must be sent as JSON with the following format:</p>
<pre>
<h2>Request Format</h2>
<p>The request must be sent as JSON with the following format:</p>
<pre>
{
"type": "batching",
"data": [
@ -65,21 +61,21 @@
}
</pre>
<p><strong>Parameters:</strong></p>
<ul>
<li><code>type</code>: The type of the request. Must be <code>"batching"</code>.</li>
<li><code>data</code>: An array of asset IDs that you want to request.</li>
<li><code>cookie</code>: Optional. A <code>.ROBLOSECURITY</code> cookie. If not provided, you will only be
able to access public assets. The cookie is used once to make the request to Roblox servers and is then
discarded permanently.
You can find more information on obtaining your cookie <a
href="https://noblox.js.org/tutorial-VPS%20Authentication.html">here!</a></li>
</ul>
<p><strong>Parameters:</strong></p>
<ul>
<li><code>type</code>: The type of the request. Must be <code>"batching"</code>.</li>
<li><code>data</code>: An array of asset IDs that you want to request.</li>
<li><code>cookie</code>: Optional. A <code>.ROBLOSECURITY</code> cookie. If not provided, you will only be
able to access public assets. The cookie is used once to make the request to Roblox servers and is then
discarded permanently.
You can find more information on obtaining your cookie <a
href="https://noblox.js.org/tutorial-VPS%20Authentication.html">here!</a></li>
</ul>
<h2>Rate Limit</h2>
<p>There is a limit of 25 requests per minute. If this limit is exceeded, the following error will be returned:
</p>
<pre>
<h2>Rate Limit</h2>
<p>There is a limit of 25 requests per minute. If this limit is exceeded, the following error will be returned:
</p>
<pre>
{
"code": 429,
"error": "Rate limit exceeded",
@ -87,9 +83,9 @@
}
</pre>
<h2>Response Format</h2>
<p>The response will be in JSON format:</p>
<pre>
<h2>Response Format</h2>
<p>The response will be in JSON format:</p>
<pre>
<pre>
{
"type": "batching-response",
@ -107,21 +103,21 @@
}
}
</pre>
</pre>
</pre>
<p><strong>Fields:</strong></p>
<ul>
<li><code>type</code>: Always <code>"batching-response"</code>.</li>
<li><code>data</code>: An object where each key is an asset ID and the value contains the result of the
request.</li>
<li><code>status</code>: Either <code>"success"</code> or <code>"failure"</code>.</li>
<li><code>url</code>: The location of the asset if the request was successful, or an empty string if it
failed.</li>
<li><code>additional</code>: Any additional information, such as error messages.</li>
</ul>
<p><strong>Fields:</strong></p>
<ul>
<li><code>type</code>: Always <code>"batching-response"</code>.</li>
<li><code>data</code>: An object where each key is an asset ID and the value contains the result of the
request.</li>
<li><code>status</code>: Either <code>"success"</code> or <code>"failure"</code>.</li>
<li><code>url</code>: The location of the asset if the request was successful, or an empty string if it
failed.</li>
<li><code>additional</code>: Any additional information, such as error messages.</li>
</ul>
<h2>Example Request</h2>
<pre>
<h2>Example Request</h2>
<pre>
POST /
Content-Type: application/json
@ -137,8 +133,8 @@ Content-Type: application/json
}
</pre>
<h2>Example Response</h2>
<pre>
<h2>Example Response</h2>
<pre>
{
"type": "batching-response",
"data": {