API

<!DOCTYPE html> <html lang="en" class="h-full"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.6.0.785423597182">  <meta name="generator" content="Retype 3.6.0">  <title>API</title> <meta name="title" content="API"> <meta name="description" content="ONESTEP AI provides a public API for all logged-in users. It covers the full functionality of the portal.">  <link rel="canonical" href="https://docs.onestepai.com/api/">  <meta property="og:type" content="website"> <meta property="og:url" content="https://docs.onestepai.com/api/"> <meta property="og:title" content="API"> <meta property="og:description" content="ONESTEP AI provides a public API for all logged-in users. It covers the full functionality of the portal.">  <meta property="twitter:card" content="summary_large_image"> <meta property="twitter:url" content="https://docs.onestepai.com/api/"> <meta property="twitter:title" content="API"> <meta property="twitter:description" content="ONESTEP AI provides a public API for all logged-in users. It covers the full functionality of the portal."> <script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script> <link href="../static/favicon.png" rel="icon"> <link href="../resources/css/retype.css?v=3.6.0.785423597182" rel="stylesheet"> <script data-cfasync="false" src="../resources/js/config.js?v=3.6.0.785423597182" data-turbo-eval="false" defer></script> <script data-cfasync="false" src="../resources/js/retype.js?v=3.6.0" data-turbo-eval="false" defer></script> <script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.6.0.785423597182" data-turbo-eval="false" defer></script> </head> <body> <div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300"> <div class="absolute bottom-0 left-0 bg-gray-100 dark:bg-dark-800" style="top: 5rem; right: 50%"></div> <header id="docs-site-header" class="sticky top-0 z-30 flex w-full h-16 bg-white border-b border-gray-200 md:h-20 dark:bg-dark-850 dark:border-dark-650"> <div class="container relative flex items-center justify-between pr-6 grow md:justify-start">  <button v-cloak class="skeleton docs-mobile-menu-button flex items-center justify-center shrink-0 overflow-hidden dark:text-white focus:outline-none rounded-full w-10 h-10 ml-3.5 md:hidden"><svg xmlns="http://www.w3.org/2000/svg" class="mb-px shrink-0" width="24" height="24" viewBox="0 0 24 24" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor"><path d="M2 4h20v2H2zM2 11h20v2H2zM2 18h20v2H2z"></path></g></svg></button> <div v-cloak id="docs-sidebar-toggle"></div>  <div class="flex items-center justify-between h-full py-2 md:w-75"> <div class="flex items-center px-2 md:px-6"> <a id="docs-site-logo" href="../" class="flex items-center leading-snug text-2xl"> <span class="dark:text-white font-semibold line-clamp-1 md:line-clamp-2">ONESTEP AI</span> </a><span class="hidden px-2 py-1 ml-4 text-sm font-semibold leading-none text-root-logo-label-text bg-root-logo-label-bg rounded-sm md:inline-block">Docs</span> </div> <span class="hidden h-8 border-r md:inline-block dark:border-dark-650"></span> </div> <div class="flex justify-between md:grow">  <nav class="hidden md:flex"> <ul class="flex flex-col mb-4 md:pl-16 md:mb-0 md:flex-row md:items-center"> <li class="mr-6"> <a class="py-2 md:mb-0 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-blue-500 dark:text-blue-400 hover:text-blue-800 dark:hover:text-blue-200" href="https://onestepai.com">Go to ONESTEP AI Portal</a> </li> </ul> </nav>  <div v-cloak class="flex justify-end grow skeleton">  <div class="relative hidden w-40 lg:block lg:max-w-sm lg:ml-auto"> <div class="absolute flex items-center justify-center h-full pl-3 dark:text-dark-300"> <svg xmlns="http://www.w3.org/2000/svg" class="icon-base" width="16" height="16" viewBox="0 0 24 24" aria-labelledby="icon" role="presentation" style="margin-bottom: 1px;"><g fill="currentColor" ><path d="M21.71 20.29l-3.68-3.68A8.963 8.963 0 0020 11c0-4.96-4.04-9-9-9s-9 4.04-9 9 4.04 9 9 9c2.12 0 4.07-.74 5.61-1.97l3.68 3.68c.2.19.45.29.71.29s.51-.1.71-.29c.39-.39.39-1.03 0-1.42zM4 11c0-3.86 3.14-7 7-7s7 3.14 7 7c0 1.92-.78 3.66-2.04 4.93-.01.01-.02.01-.02.01-.01.01-.01.01-.01.02A6.98 6.98 0 0111 18c-3.86 0-7-3.14-7-7z" ></path></g></svg> </div> <input class="w-full h-10 placeholder-gray-400 transition-colors duration-200 ease-in bg-gray-200 border border-transparent rounded md:text-sm hover:bg-white hover:border-gray-300 focus:outline-none focus:bg-white focus:border-gray-500 dark:bg-dark-600 dark:border-dark-600 dark:placeholder-dark-400" style="padding: 0.625rem 0.75rem 0.625rem 2rem" type="text" placeholder="Search"> </div>  <div class="flex items-center justify-center w-10 h-10 lg:hidden"> <svg xmlns="http://www.w3.org/2000/svg" class="shrink-0 icon-base" width="20" height="20" viewBox="0 0 24 24" aria-labelledby="icon" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor" ><path d="M21.71 20.29l-3.68-3.68A8.963 8.963 0 0020 11c0-4.96-4.04-9-9-9s-9 4.04-9 9 4.04 9 9 9c2.12 0 4.07-.74 5.61-1.97l3.68 3.68c.2.19.45.29.71.29s.51-.1.71-.29c.39-.39.39-1.03 0-1.42zM4 11c0-3.86 3.14-7 7-7s7 3.14 7 7c0 1.92-.78 3.66-2.04 4.93-.01.01-.02.01-.02.01-.01.01-.01.01-.01.02A6.98 6.98 0 0111 18c-3.86 0-7-3.14-7-7z" ></path></g></svg> </div>  <div class="w-10 h-10 lg:ml-2"></div>  <div class="flex items-center justify-center w-10 h-10" style="margin-right: -0.625rem;"> <svg xmlns="http://www.w3.org/2000/svg" class="shrink-0 icon-base" width="22" height="22" viewBox="0 0 24 24" aria-labelledby="icon" role="presentation" style="margin-bottom: 0px;"><g fill="currentColor" ><g ><path d="M12.01 6.01c-.55 0-1 .45-1 1V12a1 1 0 00.4.8l3 2.22a.985.985 0 001.39-.2.996.996 0 00-.21-1.4l-2.6-1.92V7.01c.02-.55-.43-1-.98-1z"></path><path d="M12.01 1.91c-5.33 0-9.69 4.16-10.05 9.4l-.29-.26a.997.997 0 10-1.34 1.48l1.97 1.79c.19.17.43.26.67.26s.48-.09.67-.26l1.97-1.79a.997.997 0 10-1.34-1.48l-.31.28c.34-4.14 3.82-7.41 8.05-7.41 4.46 0 8.08 3.63 8.08 8.09s-3.63 8.08-8.08 8.08c-2.18 0-4.22-.85-5.75-2.4a.996.996 0 10-1.42 1.4 10.02 10.02 0 007.17 2.99c5.56 0 10.08-4.52 10.08-10.08.01-5.56-4.52-10.09-10.08-10.09z"></path></g></g></svg> </div> </div> <div v-cloak class="flex justify-end grow"> <div id="docs-mobile-search-button"></div> <doc-search-desktop></doc-search-desktop> <doc-theme-switch class="lg:ml-2"></doc-theme-switch> <doc-history></doc-history> </div> </div> </div> </header> <div class="container relative flex bg-white">  <div v-cloak class="fixed flex flex-col shrink-0 duration-300 ease-in-out bg-gray-100 border-gray-200 sidebar top-20 w-75 border-r h-screen md:sticky transition-transform skeleton dark:bg-dark-800 dark:border-dark-650">  <div class="flex items-center h-16 px-6"> <input class="w-full h-8 px-3 py-2 transition-colors duration-200 ease-linear bg-white border border-gray-200 rounded shadow-none text-sm focus:outline-none focus:border-gray-600 dark:bg-dark-600 dark:border-dark-600" type="text" placeholder="Filter"> </div> <div class="pl-6 mt-1 mb-4"> <div class="w-32 h-3 mb-4 bg-gray-200 rounded-full loading dark:bg-dark-600"></div> <div class="w-48 h-3 mb-4 bg-gray-200 rounded-full loading dark:bg-dark-600"></div> <div class="w-40 h-3 mb-4 bg-gray-200 rounded-full loading dark:bg-dark-600"></div> <div class="w-32 h-3 mb-4 bg-gray-200 rounded-full loading dark:bg-dark-600"></div> <div class="w-48 h-3 mb-4 bg-gray-200 rounded-full loading dark:bg-dark-600"></div> <div class="w-40 h-3 mb-4 bg-gray-200 rounded-full loading dark:bg-dark-600"></div> </div> <div class="shrink-0 mt-auto bg-transparent dark:border-dark-650"> <a class="flex items-center justify-center flex-nowrap h-16 text-gray-400 dark:text-dark-400 hover:text-gray-700 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener"> <span class="text-xs whitespace-nowrap">Powered by</span> <svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg> </a> </div> </div>  <doc-sidebar v-cloak> <template #sidebar-footer> <div class="shrink-0 mt-auto border-t md:bg-transparent md:border-none dark:border-dark-650"> <div class="py-3 px-6 md:hidden border-b dark:border-dark-650"> <nav> <ul class="flex flex-wrap justify-center items-center"> <li class="mr-6"> <a class="block py-1 inline-flex items-center text-sm whitespace-nowrap transition-colors duration-200 ease-linear md:text-blue-500 dark:text-blue-400 hover:text-blue-800 dark:hover:text-blue-200" href="https://onestepai.com">Go to ONESTEP AI Portal</a> </li> </ul> </nav> </div> <a class="flex items-center justify-center flex-nowrap h-16 text-gray-400 dark:text-dark-400 hover:text-gray-700 dark:hover:text-dark-300 transition-colors duration-150 ease-in docs-powered-by" target="_blank" href="https://retype.com/" rel="noopener"> <span class="text-xs whitespace-nowrap">Powered by</span> <svg xmlns="http://www.w3.org/2000/svg" class="ml-2" fill="currentColor" width="96" height="20" overflow="visible"><path d="M0 0v20h13.59V0H0zm11.15 17.54H2.44V2.46h8.71v15.08zM15.8 20h2.44V4.67L15.8 2.22zM20.45 6.89V20h2.44V9.34z"/><g><path d="M40.16 8.44c0 1.49-.59 2.45-1.75 2.88l2.34 3.32h-2.53l-2.04-2.96h-1.43v2.96h-2.06V5.36h3.5c1.43 0 2.46.24 3.07.73s.9 1.27.9 2.35zm-2.48 1.1c.26-.23.38-.59.38-1.09 0-.5-.13-.84-.4-1.03s-.73-.28-1.39-.28h-1.54v2.75h1.5c.72 0 1.2-.12 1.45-.35zM51.56 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92h4.74v1.83h-6.79V5.36h6.64zM60.09 7.15v7.48h-2.06V7.15h-2.61V5.36h7.28v1.79h-2.61zM70.81 14.64h-2.06v-3.66l-3.19-5.61h2.23l1.99 3.45 1.99-3.45H74l-3.19 5.61v3.66zM83.99 6.19c.65.55.97 1.4.97 2.55s-.33 1.98-1 2.51-1.68.8-3.04.8h-1.23v2.59h-2.06V5.36h3.26c1.42 0 2.45.28 3.1.83zm-1.51 3.65c.25-.28.37-.69.37-1.22s-.16-.92-.48-1.14c-.32-.23-.82-.34-1.5-.34H79.7v3.12h1.38c.68 0 1.15-.14 1.4-.42zM95.85 5.36V7.2h-4.59v1.91h4.13v1.76h-4.13v1.92H96v1.83h-6.79V5.36h6.64z"/></g></svg> </a> </div> </template> </doc-sidebar> <div class="grow min-w-0 dark:bg-dark-850">  <div class="flex"> <div class="min-w-0 p-4 grow md:px-16"> <main class="relative pb-12 lg:pt-2"> <div class="docs-markdown" id="docs-content">  <div id="docs-sidebar-right-toggle"></div>  <doc-anchor-target id="api" class="break-words"> <h1> <doc-anchor-trigger class="header-anchor-trigger" to="#api">#</doc-anchor-trigger> <span>API</span> </h1> </doc-anchor-target> <p>ONESTEP AI provides a public API for all logged-in users. It covers the full functionality of the portal.</p> <p><strong>Choose your region:</strong></p> <p><a href="https://app-eu.onestepai.com/api/swagger/index.html" class="no-link inline-flex align-middle items-center font-medium cursor-pointer transition-colors duration-200 ease-out focus:outline-none bg-blue-500 hover:bg-blue-700 text-white px-4 h-10 text-sm rounded-md"> <span>ONESTEP AI EU</span> </a> or <a href="https://app-us.onestepai.com/api/swagger/index.html" class="no-link inline-flex align-middle items-center font-medium cursor-pointer transition-colors duration-200 ease-out focus:outline-none bg-blue-500 hover:bg-blue-700 text-white px-4 h-10 text-sm rounded-md"> <span>ONESTEP AI US</span> </a></p> <p>Authorization is via the OSAI website or <a href="../getting_started/settings/">access token</a>. More detailed instructions can be found in <a href="../how_to_use_api/authorization/">authoriztion article</a> or in the API by clicking on the <code v-pre>Authorize</code> button.</p> <p>HTTP response status codes:</p> <div class="table-wrapper scrollbar overflow-hidden"> <table class="compact"> <thead> <tr> <th>Status code</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>200 - OK</td> <td>The request succeeded.</td> </tr> <tr> <td>400 - Bad Request</td> <td>The server cannot or will not process the request due to something that is perceived to be a client error.</td> </tr> <tr> <td>401 - Unauthorized</td> <td>Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.</td> </tr> </tbody> </table> </div> <p>To familiarize yourself with the API, you can find some examples of how to use the service in the <code v-pre>How to use API</code> section.</p> <p>Click on the one of the following links to download the Python playbook:</p> <p> <div class="mb-6 px-5 py-4 flex justify-between relative border border-gray-300 hover:border-gray-400 dark:border-dark-650 dark:hover:border-dark-450 rounded transition-colors duration-150"> <div class="flex items-center text-blue-500 dark:text-blue-400"> <span class="inline-block mb-px"> <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" role="presentation" fill="currentColor"><path fill="none" d="M0 0h24v24H0z"/><path d="M21 14c-.55 0-1 .45-1 1v4c0 .55-.45 1-1 1H5c-.55 0-1-.45-1-1v-4c0-.55-.45-1-1-1s-1 .45-1 1v4c0 1.65 1.35 3 3 3h14c1.65 0 3-1.35 3-3v-4c0-.55-.45-1-1-1z"/><path d="M11.29 15.71c.09.09.2.17.33.22.12.04.25.07.38.07s.26-.03.38-.08.23-.12.33-.22l5-5a.996.996 0 10-1.41-1.41l-3.3 3.3V3c0-.55-.45-1-1-1s-1 .45-1 1v9.59l-3.29-3.3A.996.996 0 106.3 10.7l4.99 5.01z"/></svg> </span> <span class="inline-block font-medium ml-2">Google Colab</span> </div> <div class="flex items-center text-xs text-gray-400 dark:text-dark-400"> <span>17PJAxxGjN5nXWlo2lFwpk68H_q6u234C?usp=sharing</span> </div> <a href="https://colab.research.google.com/drive/17PJAxxGjN5nXWlo2lFwpk68H_q6u234C?usp=sharing" class="absolute block inset-0"></a> </div> <div class="mb-6 px-5 py-4 flex justify-between relative border border-gray-300 hover:border-gray-400 dark:border-dark-650 dark:hover:border-dark-450 rounded transition-colors duration-150"> <div class="flex items-center text-blue-500 dark:text-blue-400"> <span class="inline-block mb-px"> <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" role="presentation" fill="currentColor"><path fill="none" d="M0 0h24v24H0z"/><path d="M21 14c-.55 0-1 .45-1 1v4c0 .55-.45 1-1 1H5c-.55 0-1-.45-1-1v-4c0-.55-.45-1-1-1s-1 .45-1 1v4c0 1.65 1.35 3 3 3h14c1.65 0 3-1.35 3-3v-4c0-.55-.45-1-1-1z"/><path d="M11.29 15.71c.09.09.2.17.33.22.12.04.25.07.38.07s.26-.03.38-.08.23-.12.33-.22l5-5a.996.996 0 10-1.41-1.41l-3.3 3.3V3c0-.55-.45-1-1-1s-1 .45-1 1v9.59l-3.29-3.3A.996.996 0 106.3 10.7l4.99 5.01z"/></svg> </span> <span class="inline-block font-medium ml-2">Python playbook</span> </div> <div class="flex items-center text-xs text-gray-400 dark:text-dark-400"> <span>upload_dataset_and_train_model.ipynb</span> <span class="inline-block ml-2">19.4MB</span> </div> <a href="../static/upload_dataset_and_train_model.ipynb" class="absolute block inset-0" target="_blank" download="upload_dataset_and_train_model.ipynb"></a> </div> </p> <doc-anchor-target id="webhooks"> <h2> <doc-anchor-trigger class="header-anchor-trigger" to="#webhooks">#</doc-anchor-trigger> <span>Webhooks</span> </h2> </doc-anchor-target> <p>We have implemented a webhook system to streamline working with OSAI using the API. Webhooks are a way for applications or services to send real-time notifications to other applications or services. They work on a simple concept: when a specific event or trigger occurs in an application, it sends an HTTP POST request to a predefined URL, carrying relevant information about the event.</p> <p>Our webhook system retrieves information about the completion of <a href="../glossary/#worker">worker</a> tasks (e.g., conversion, manipulation, prediction, training, re-training, renting a device) and sends it to the specified address. To use this feature, navigate to our API documentation (<a href="https://app-eu.onestepai.com/api/swagger/index.html">EU</a> or <a href="https://app-us.onestepai.com/api/swagger/index.html">US</a>), locate the desired task and provide your URL. Make sure that the URL is reachable, properly configured, and capable of receiving and handling incoming HTTP requests. Once the worker has finished, you will receive an HTTP POST request. This request will let you know if the task was successfully completed or if the worker encountered any problems along the way.</p>  <doc-toolbar-member-filter-no-results></doc-toolbar-member-filter-no-results> </div> <footer class="clear-both"> <nav class="flex mt-14"> <div class="w-1/2"> <a class="px-5 py-4 h-full flex items-center break-normal font-medium text-blue-500 dark:text-blue-400 border border-gray-300 hover:border-gray-400 dark:border-dark-650 dark:hover:border-dark-450 rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../reports/report_details/"> <svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg> <span> <span class="block text-xs font-normal text-gray-400 dark:text-dark-400">Previous</span> <span class="block mt-1">Report details</span> </span> </a> </div> <div class="w-1/2"> <a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-blue-500 dark:text-blue-400 border border-gray-300 hover:border-gray-400 dark:border-dark-650 dark:hover:border-dark-450 rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../how_to_use_api/authorization/"> <span> <span class="block text-xs font-normal text-right text-gray-400 dark:text-dark-400">Next</span> <span class="block mt-1">Authorization</span> </span> <svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg> </a> </div> </nav> </footer> </main> <div class="border-t dark:border-dark-650 pt-6 mb-8"> <footer class="flex flex-wrap items-center justify-between"> <div> <ul class="flex flex-wrap items-center text-sm"> </ul> </div> <div class="docs-copyright py-2 text-gray-500 dark:text-dark-350 text-sm leading-relaxed"><p>Version 1.9.0.1 漏 Copyright 2021-2024. <a href="https://app-eu.onestepai.com">ONESTEP AI</a> All rights reserved.</p></div> </footer> </div> </div>   <div v-cloak class="fixed top-0 bottom-0 right-0 translate-x-full bg-white border-gray-200 lg:sticky lg:border-l lg:shrink-0 lg:pt-6 lg:transform-none sm:w-1/2 lg:w-64 lg:z-0 md:w-104 sidebar-right skeleton dark:bg-dark-850 dark:border-dark-650"> <div class="pl-5"> <div class="w-32 h-3 mb-4 bg-gray-200 dark:bg-dark-600 rounded-full loading"></div> <div class="w-48 h-3 mb-4 bg-gray-200 dark:bg-dark-600 rounded-full loading"></div> <div class="w-40 h-3 mb-4 bg-gray-200 dark:bg-dark-600 rounded-full loading"></div> </div> </div>  <doc-sidebar-right v-cloak></doc-sidebar-right> </div> </div> </div> <doc-search-mobile></doc-search-mobile> <doc-back-to-top></doc-back-to-top> </div> <div id="docs-overlay-target"></div> <script data-cfasync="false">window.__DOCS__ = { "title": "API", level: 1, icon: "file", hasPrism: false, hasMermaid: false, hasMath: false, tocDepth: 23 }</script> </body> </html>

CINXE.COM

API