Buckets:
| <meta charset="utf-8" /><meta name="hf:doc:metadata" content="{"title":"REST API","local":"rest-api","sections":[{"title":"Endpoint overview","local":"endpoint-overview","sections":[],"depth":2},{"title":"Full reference","local":"full-reference","sections":[],"depth":2},{"title":"More complex apps","local":"more-complex-apps","sections":[],"depth":2}],"depth":1}"> | |
| <link href="/docs/reachy_mini/pr_1069/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload"> | |
| <link rel="modulepreload" href="/docs/reachy_mini/pr_1069/en/_app/immutable/entry/start.6cd5df39.js"> | |
| <link rel="modulepreload" href="/docs/reachy_mini/pr_1069/en/_app/immutable/chunks/scheduler.f05771bc.js"> | |
| <link rel="modulepreload" href="/docs/reachy_mini/pr_1069/en/_app/immutable/chunks/singletons.8ab55633.js"> | |
| <link rel="modulepreload" href="/docs/reachy_mini/pr_1069/en/_app/immutable/chunks/index.2528d289.js"> | |
| <link rel="modulepreload" href="/docs/reachy_mini/pr_1069/en/_app/immutable/chunks/paths.a8f2e6ae.js"> | |
| <link rel="modulepreload" href="/docs/reachy_mini/pr_1069/en/_app/immutable/entry/app.405911a4.js"> | |
| <link rel="modulepreload" href="/docs/reachy_mini/pr_1069/en/_app/immutable/chunks/preload-helper.e957381b.js"> | |
| <link rel="modulepreload" href="/docs/reachy_mini/pr_1069/en/_app/immutable/chunks/index.b379be46.js"> | |
| <link rel="modulepreload" href="/docs/reachy_mini/pr_1069/en/_app/immutable/nodes/0.b229c383.js"> | |
| <link rel="modulepreload" href="/docs/reachy_mini/pr_1069/en/_app/immutable/chunks/each.e59479a4.js"> | |
| <link rel="modulepreload" href="/docs/reachy_mini/pr_1069/en/_app/immutable/nodes/7.5b8eca62.js"> | |
| <link rel="modulepreload" href="/docs/reachy_mini/pr_1069/en/_app/immutable/chunks/MermaidChart.svelte_svelte_type_style_lang.c489a506.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{"title":"REST API","local":"rest-api","sections":[{"title":"Endpoint overview","local":"endpoint-overview","sections":[],"depth":2},{"title":"Full reference","local":"full-reference","sections":[],"depth":2},{"title":"More complex apps","local":"more-complex-apps","sections":[],"depth":2}],"depth":1}"><!-- HEAD_svelte-u9bgzb_END --> <p></p> <div class="items-center shrink-0 min-w-[100px] max-sm:min-w-[50px] justify-end ml-auto flex" style="float: right; margin-left: 10px; display: inline-flex; position: relative; z-index: 10;"><div class="inline-flex rounded-md max-sm:rounded-sm"><button class="inline-flex items-center gap-1 h-7 max-sm:h-7 px-2 max-sm:px-1.5 text-sm font-medium text-gray-800 border border-r-0 rounded-l-md max-sm:rounded-l-sm border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-live="polite"><span class="inline-flex items-center justify-center rounded-md p-0.5 max-sm:p-0 hover:text-gray-800 dark:hover:text-gray-200"><svg class="sm:size-3.5 size-3" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg></span> <span>Copy page</span></button> <button class="inline-flex items-center justify-center w-6 max-sm:w-5 h-7 max-sm:h-7 disabled:pointer-events-none text-sm text-gray-500 hover:text-gray-700 dark:hover:text-white rounded-r-md max-sm:rounded-r-sm border border-l transition border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-haspopup="menu" aria-expanded="false" aria-label="Open copy menu"><svg class="transition-transform text-gray-400 overflow-visible sm:size-3.5 size-3 rotate-0" width="1em" height="1em" viewBox="0 0 12 7" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 1L6 6L11 1" stroke="currentColor"></path></svg></button></div> </div> <h1 class="relative group"><a id="rest-api" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#rest-api"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>REST API</span></h1> <p data-svelte-h="svelte-199uy7g">The Reachy Mini daemon exposes an HTTP and WebSocket API at <code>http://<daemon-ip>:8000/api</code>.</p> <ul data-svelte-h="svelte-1nyhge1"><li><strong>Lite</strong> — the daemon runs on your machine: <code>http://localhost:8000</code></li> <li><strong>Wireless</strong> — the daemon runs on the robot: <code>http://reachy-mini.local:8000</code></li></ul> <p data-svelte-h="svelte-1e81r6i">When the daemon is running you can browse the interactive <strong>Swagger UI</strong> at</p> <ul data-svelte-h="svelte-mme9af"><li><a href="http://localhost:8000/docs" rel="nofollow">http://localhost:8000/docs</a> (Lite — daemon on your machine)</li> <li><a href="http://reachy-mini.local:8000/docs" rel="nofollow">http://reachy-mini.local:8000/docs</a> (Wireless — daemon on the robot)</li></ul> <p data-svelte-h="svelte-166s21x">The reference below is generated from the same OpenAPI spec and can be consulted | |
| without a running daemon.</p> <h2 class="relative group"><a id="endpoint-overview" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#endpoint-overview"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Endpoint overview</span></h2> <table data-svelte-h="svelte-8ymbs3"><thead><tr><th>Category</th> <th>Prefix</th> <th>Description</th></tr></thead> <tbody><tr><td><strong>Apps</strong></td> <td><code>/api/apps</code></td> <td>List, install, start and stop apps</td></tr> <tr><td><strong>Daemon</strong></td> <td><code>/api/daemon</code></td> <td>Start, stop and restart the daemon</td></tr> <tr><td><strong>State</strong></td> <td><code>/api/state</code></td> <td>Read head pose, body yaw, antennas, DoA</td></tr> <tr><td><strong>Move</strong></td> <td><code>/api/move</code></td> <td>Goto, set target, play recorded moves</td></tr> <tr><td><strong>Motors</strong></td> <td><code>/api/motors</code></td> <td>Get motor status, set control mode</td></tr> <tr><td><strong>Kinematics</strong></td> <td><code>/api/kinematics</code></td> <td>IK info, URDF and STL mesh files</td></tr> <tr><td><strong>Volume</strong></td> <td><code>/api/volume</code></td> <td>Speaker and microphone volume control</td></tr> <tr><td><strong>HF Auth</strong></td> <td><code>/api/hf-auth</code></td> <td>Hugging Face token management</td></tr></tbody></table> <h2 class="relative group"><a id="full-reference" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#full-reference"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Full reference</span></h2> <iframe src="https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/pollen-robotics/reachy_mini/develop/docs/source/API/openapi.json" style="width:100%; height:80vh; border:none;"></iframe> <p data-svelte-h="svelte-vggt4a"><a href="https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/pollen-robotics/reachy_mini/develop/docs/source/API/openapi.json" rel="nofollow">Open in full page</a> · <a href="https://raw.githubusercontent.com/pollen-robotics/reachy_mini/develop/docs/source/API/openapi.json" rel="nofollow">Download OpenAPI spec (JSON)</a></p> <h2 class="relative group"><a id="more-complex-apps" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#more-complex-apps"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>More complex apps</span></h2> <p data-svelte-h="svelte-rc42c3">See the <a href="../SDK/javascript-sdk">../SDK/javascript-sdk.md</a> page for examples of more complex apps using the JavaScript SDK, which leverages the WebRTC transport and provides higher-level abstractions for video, audio, and robot control.</p> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/pollen-robotics/reachy_mini/blob/main/docs/source/API/rest-api.mdx" target="_blank"><svg class="mr-1" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M31,16l-7,7l-1.41-1.41L28.17,16l-5.58-5.59L24,9l7,7z"></path><path d="M1,16l7-7l1.41,1.41L3.83,16l5.58,5.59L8,23l-7-7z"></path><path d="M12.419,25.484L17.639,6.552l1.932,0.518L14.351,26.002z"></path></svg> <span data-svelte-h="svelte-zjs2n5"><span class="underline">Update</span> on GitHub</span></a> <p></p> | |
| <script> | |
| { | |
| __sveltekit_14cjvgd = { | |
| assets: "/docs/reachy_mini/pr_1069/en", | |
| base: "/docs/reachy_mini/pr_1069/en", | |
| env: {} | |
| }; | |
| const element = document.currentScript.parentElement; | |
| const data = [null,null]; | |
| Promise.all([ | |
| import("/docs/reachy_mini/pr_1069/en/_app/immutable/entry/start.6cd5df39.js"), | |
| import("/docs/reachy_mini/pr_1069/en/_app/immutable/entry/app.405911a4.js") | |
| ]).then(([kit, app]) => { | |
| kit.start(app, element, { | |
| node_ids: [0, 7], | |
| data, | |
| form: null, | |
| error: null | |
| }); | |
| }); | |
| } | |
| </script> | |
Xet Storage Details
- Size:
- 13 kB
- Xet hash:
- 378e20a781a0d5213ce63c656b4a276987172490d02bdb7f8738d239910d55d2
·
Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.