mirror of
https://github.com/mudler/LocalAI.git
synced 2026-10-28 17:18:49 -04:00
* feat(addons): add the add-on runtime, navigation and first-party add-ons Add the add-on runtime to LocalAI: manifests, the host operation broker, admin gating by account role, the add-on UI bundle builder and the SDK for add-on pages. Move the navigation to Chat, Models, Add-ons and Settings, with pinned add-ons in the sidebar and an Add-ons drawer. Ship the first-party add-ons (voice, face, fine-tuning, quantization) as packages for linux/amd64, linux/arm64 and darwin/arm64. Intel macOS (darwin/amd64) is enabled in the platform files. Squashed from the review branch. The tree is unchanged; the pre-squash history is kept on a local backup branch. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(gosec): tighten file modes and annotate false positives Write job state, configs and imported models with mode 0600, clean the paths that are read from disk, and mark the route tables, the header name and the retry jitter as reviewed false positives. Assisted-by: Claude Code:claude-sonnet-5-5 gosec Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(addons): keep API keys off recovery mutations and same-site cookies POST /api/addons/dispatch forwarded the recovery and update mutations to the owner for any administrator key, which skipped the browser-session rule of their own routes. Refuse those actions there. Also apply the same-origin rule to the legacy token cookie, not only the session cookie, because the global CSRF check lets same-site requests through. Do not fail the start of LocalAI when an add-on library cannot be refreshed; log it and keep the installed add-ons up. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(addons): refuse a reinstall that would migrate retained data unbacked An upgrade takes a verified backup before the new package migrates the data. A reinstall over retained data has no running generation to stop, so the new package would migrate it without one. Refuse a reinstall whose data format differs from the retained one. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(addons): release the manager lock while a release is fetched Submit held the state lock across the catalog lookup and the package download, so the apps list and status reads stalled for the whole install. Serialize Submit and Reconcile with their own lock and drop the state lock around the fetch only. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(addons): kill an add-on only after three missed health probes One slow 100 ms probe killed a busy add-on and dropped the work it was serving. Require three misses in a row. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(ui): move settings under the operate hub The Operate hub already has Settings as a tab, so the sidebar no longer shows a separate Settings entry. The /app/settings route stays, and the hub tab still reaches it. The navigation test now expects Chat, Models and Add-ons as the primary items. Assisted-by: Claude Code:claude-sonnet-5-5 node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(addons): accept same-host browser requests that carry no fetch metadata Browsers do not send Sec-Fetch-* headers over plain HTTP on an address that is not localhost, so every add-on request from a LAN address was refused as cross-site. Keep refusing a Sec-Fetch-Site value other than same-origin. When the header is absent, accept the request only if its Origin, or failing that its Referer, names the same host and port as the request. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(ui): show the server's reason when an add-on request is refused A 403 or 400 answer showed a generic message and hid the reason in the response body, so a refusal by the browser guard could not be told from a missing permission. Show error.message from the body as the server sent it, and keep the generic text when the body has none. Assisted-by: Claude Code:claude-sonnet-5-5 node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(addons): run the add-on owner in the normal binary The owner was only enabled when an embedding host set the add-on config, so a normal run answered every add-on request as unavailable. Add --addons-enabled (default true) and --addons-ownership-mode (default named-user, or local-owner; anything else stops startup). The node is its own owner: state lives under the data path, and the carrier uses loopback keys made at each start and kept in memory. --addons-enabled=false turns the owner off completely. Named-user mode needs the account database. With authentication off the owner stays off and a warning says how to use local-owner. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(addons): keep the loopback owner address stable across restarts The single-node loopback transport took a new ephemeral port at each start. The owner stores its address in its identity file and refuses to start when the address differs, so every start after the first failed with "invalid addon owner configuration". Choose the port once, keep it in the add-on state root (loopback-port, mode 0600) and reuse it. If the port is taken at a later start, stop with an error that names the port and --addons-enabled=false, because another port would break the identity check. The keys and certificate stay in memory. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(addons): let add-on pages keep the host modules they were written against A page written for the web UI imports React, the router, i18next and a few shared components. The add-on builder refuses a bundle that holds a host file, so moving such a page into an add-on meant rewriting it. Add a compat mode to the shared builder. It answers those imports from a directory of stand-ins that read the SDK, bundles the dynamic import of the page code into the one output file, and collects the style sheets the page imports. A relative import that is not in the add-on's own source resolves to the file at the same path under the compat directory. Widen the SDK for these pages, without a version change: more host components (spinner, modal, lightbox, model picker) and hooks (models, resources, voice profiles, operations, MCP client), a style on icons, the icon names the pages draw, sdk.navigation.openApp to open a page of the app (only addresses under /app, and the way back as the only state) and sdk.portal. The shell passes the query string to the page. The stand-ins cover the router (the tab in the path, the model in the query), the translator over the host locale files, the core API calls through sdk.core.fetch, and byte copies of the pure helpers, with tests that keep the copies equal to the originals. Assisted-by: Claude Code:claude-sonnet-5-5 node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(addons): ship Studio and Talk as add-ons instead of built-in pages Studio and Talk were compiled into the web bundle and always listed in the Add-ons drawer. They are add-ons now, like Voice, Face, fine-tuning and quantization: a person installs and removes them, the drawer lists them only while they are installed, and they are packaged the same way. Move the pages, their components, hooks and helpers into addons/studio and addons/talk. Each has a manifest, a UI bundle, a release platform matrix and a catalog template, and is built by the compat mode of the shared builder. The core API stays where it is: the pages call it with the signed-in person's session. The history keeps its browser storage keys. The unit tests of the moved helpers move with them. In the core, drop the two pages, the Create group of the sidebar (Chat joins Home and Models in the old layout), the built-in catalog entries (the catalog is empty) and the talk locale namespace. The old addresses (/app/studio, /app/talk and the generator links) redirect to the add-on pages, with the model as ?model=. The Home /studio command is offered only while the Studio add-on is installed and opens it. The release workflow and its tests now list seven add-ons. Assisted-by: Claude Code:claude-sonnet-5-5 go node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(ui): run the Studio and Talk specs against the add-on bundles The pages are add-ons now, so a spec that draws one installs the real built bundle first: the apps list names it and its module and style sheet are served from the build output, the way the add-on owner serves them. studio-addon.js holds that helper, and the Studio and Talk fixtures call it. Update the specs for the new addresses (/app/addons/studio/studio, the model as ?model=), the session permission the add-on route needs, the legacy redirects, the Home /studio command that appears only while the add-on is installed, and the sidebar without a Create group. Add specs for the add-ons themselves: every tab draws with no script error, the shell titles the page once, the old addresses say so when the add-on is not installed, a button of the page reaches a core page with the way back, and the drawer lists both only after they are installed. Assisted-by: Claude Code:claude-sonnet-5-5 node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(ui): centre the icon of a built-in tile in its icon box The drawer drew the icon of a built-in tile (Studio's palette was one) in a bare 40px box. Only the placeholder box was laid out as a centred grid with the 20px size, so the real icon sat in the top-left corner at the size of the page text. Give the built-in tile the same classes as the placeholder box, and check in a browser that the icon is centred. Assisted-by: Claude Code:claude-sonnet-5-5 node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs(addons): describe Studio and Talk as add-ons Replace the built-in list (now empty) with the Studio and Talk add-on sections, the new targets of the old links, the Home command, and the seven packaged add-ons. Describe the SDK additions the pages use: components, hooks, icons, openApp and portal. Say on the Studio page that it is installed from the drawer. Assisted-by: Claude Code:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(ui): click the shell title in the Studio slash-key spec The add-on shell titles the page, and the Studio overview no longer draws a second title, but the generator tabs keep theirs, so a bare h1 locator matched two elements. Click the first, which is the shell's. Assisted-by: Claude Code:claude-sonnet-5-5 node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(addons): read the loopback port file through os.Root The persisted port file was read with a path built from the add-on root, which gosec reports as a file inclusion through a variable. Open it through os.Root so the name cannot leave the root, even by a symbolic link, and require a regular file with no group or other access. A looser file now fails closed instead of being trusted. Assisted-by: Claude Code:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(ui): expect Settings under the Operate hub, not the sidebar Settings moved out of the sidebar into the Operate hub. The navigation spec still expected a sidebar link. Assert that the sidebar has no Settings entry, and that the Operate hub opens Settings as a tab. Assisted-by: Claude Code:claude-sonnet-5-5 playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(ui): drop Settings from the 404 places Settings is a tab of the Operate hub and not a destination of its own, so the 404 page does not list it. Assert that it is absent. Assisted-by: Claude Code:claude-sonnet-5-5 playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(ui): drive the media history and TTS specs through the Studio add-on The image, video, sound and speech generators are pages of the Studio add-on now, and the old addresses redirect to it. Install the add-on with the Studio fixtures, open its pages and use its compose card, so the specs run against the page that exists. Assisted-by: Claude Code:claude-sonnet-5-5 playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(ui): count the first-run steps, not every list item The recommended models are a list inside the second step, so counting all list items read 3 only while the models were still loading. Count the step elements, which does not depend on the load order. Assisted-by: Claude Code:claude-sonnet-5-5 playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(ui): fail the node refresh by state, not by call count The spec served the list to the first request and failed the rest. The first request is not always the one from the page, so the page could get the failure first and show no list. Serve the list until the page shows it, then fail the refreshes. Assisted-by: Claude Code:claude-sonnet-5-5 playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(addons): default to local-owner when auth is off A server without authentication has no accounts, so named-user left the add-on owner off. Resolve the unset mode in one place: local-owner when authentication is off, named-user when it is on. A flag or environment value still wins, and an unknown value is still refused. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(addons): register an official add-on library by default Add gallery/addons/index.yaml, a YAML index of the four first-party add-ons (fine-tuning, quantization, voice, face) in the library format. The entries come from addonpkg catalog over locally built linux/amd64 packages, so the digests pin those images. On the first start, when the owner has no sources.json, register the raw GitHub URL of that index on master as the "official" library and write the file. The file is then the record: a library the admin removes stays removed, and an existing file is never changed. --addons-official-library=false skips the default. Assisted-by: Claude Code:claude-sonnet-5-5 go node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs(addons): document the ownership default and the official library Assisted-by: Claude Code:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(addons): list Studio and Talk in the first-party index Add the Studio and Talk entries to gallery/addons/index.yaml next to the four existing ones. They come from addonpkg catalog over locally built linux/amd64 packages, so the digests pin those images. Assisted-by: Claude Code:claude-sonnet-5-5 go node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(addons): expect Studio and Talk in the official index The official index now lists six add-ons. Update the test that decodes it so it accepts Studio and Talk. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(addons): add a real icon to each first-party add-on Each icon is a 256 by 256 PNG: a rounded square in one colour of the UI kit palette with a white outline glyph from the kit sprite. Fine-tuning uses sliders, quantization layers, voice waveform, face user, studio palette, talk phone and tables database. They were rendered with headless Chrome from the sprite paths. Assisted-by: Claude Code:claude-sonnet-5-5 chrome Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(addons): ship a committed icon.png instead of the generated square The shared UI builder and the Tables builder copy ui/icon.png from the add-on source tree to the package unchanged when the file exists. They write the generated placeholder only when it does not. Add a fixture with an icon and a test for both cases. Assisted-by: Claude Code:claude-sonnet-5-5 node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(addons): list the tables add-on in the first-party index Add the Tables entry to gallery/addons/index.yaml next to the six existing ones. It comes from addonpkg catalog over a locally built linux/amd64 package, so the digest pins that image. The official index test now expects seven add-ons. Assisted-by: Claude Code:claude-sonnet-5-5 go node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(addons): make the Voice add-on one page with tabs The Voice add-on had four pages: recognition, library, create and speech, and the drawer listed two of them. It now has one page, "voice", and one drawer entry. Recognition, Library, Text to speech and From a recording are tabs of that page, drawn with the same tab strip the recognition page already used. The tab is the first path segment (voice/library), as in the Studio add-on, and the form that adds a voice is a view of the Library tab (voice/library/new). The old page names stay declared in the manifest. Each one redirects to its tab and keeps the query string, so saved links still open. Assisted-by: Claude Code:claude-sonnet-5-5 node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(ui): send the old voice routes to the Voice tabs /app/voice, /app/voice-library and /app/voice-library/new now open the matching tab of the Voice add-on page while the add-on is installed and running, and the core pages otherwise. The moved-page helper compares the first segment of the target with the declared pages, so a target can name a tab. The docs and the navigation spec list the new addresses. Assisted-by: Claude Code:claude-sonnet-5-5 node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(addons): cover the Voice tabs and the old page redirects The add-on unit tests render the tabs instead of the four pages. The Playwright spec checks the tab strip, the address of each tab, the missing Library tab for a member, and that the old page addresses of the add-on redirect to their tab with the query string kept. The migration table test follows the new targets. Assisted-by: Claude Code:claude-sonnet-5-5 node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(studio): keep the model menu inside a narrow screen The Home model picker sizes its menu from the viewport, and assumes the picker sits at the page gutter. In the Studio composer card the field is further in, so on a 390px screen the menu of the Sound expansion picker ended 7px past the right edge. Size the menu from the field it opens under instead. Assisted-by: Claude Code:claude-sonnet-5-5 node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(ui): build the add-on bundles once for the whole run Each worker built the Studio and Talk bundles into the same dist directory, and the build empties that directory first. A worker that started, or restarted after a failure, removed the files another worker was serving, so a Studio spec saw "the style sheet of the add-on could not be loaded". Build once in a global setup before the workers start. A run without the setup still builds per worker. Assisted-by: Claude Code:claude-sonnet-5-5 node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(ui): register the worker when the add-node spec says so The mocked roster added the worker on the third read of /api/nodes. The shell and the page both read it, and which one asks first depends on load, so the page could take the new worker as part of the roster it opened with and never show it as found. The worker now joins after the page shows it is listening. Assisted-by: Claude Code:claude-sonnet-5-5 node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(ui): hold the gallery answer until the skeleton is seen The spec delayed the answer by a fixed 800 ms and then looked for the skeleton. The assertion polls at growing intervals, so on a slow machine it could step over that window. The answer now waits until the skeleton has been seen, and the spec then checks that the skeleton goes away. Assisted-by: Claude Code:claude-sonnet-5-5 node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(ui): give the PDF tag the time the other PDF specs have pdf.js and its worker load on first use. The other specs in this file wait up to ten seconds for the result of that load. The first one waited five, and missed the tag on a busy machine. Assisted-by: Claude Code:claude-sonnet-5-5 node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(ui): build the Face and Fine-tuning bundles in the global setup The navigation spec serves the built Fine-tuning bundle, but nothing built it, so two specs failed on a fresh checkout when the dist folder was missing. The spec also built the Face bundle in a hook that every worker runs, and a build rewrites the folder the other workers serve. The global setup now builds Studio, Talk, Face and Fine-tuning once, before the workers start. The spec builds the two bundles itself only when it runs without the global setup. Assisted-by: Claude Code:claude-sonnet-5-5 node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(ui): fix the Home answers in the stale pin spec The spec asserts that the page shows no alert. The Home page raises its own alert when the model list fails or a staging operation has failed, and both answers come from the shared test server. A slow reply or a failed install left there counted as an alert about the pin. The spec now fixes both answers, so the alert count tells only about the pin. The assertions are unchanged. Assisted-by: Claude Code:claude-sonnet-5-5 node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(ui): read the server address in the add-node spec from the page The spec expected the register address to carry port 8089, so it failed on any other port. It now expects the origin the page was opened from. Assisted-by: Claude Code:claude-sonnet-5-5 node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(addons): give the navigation routes spec its own catalog No page is built in today, so the catalog is empty and the three specs that expect the studio and talk entries failed on the list and on the pin seed. They passed only while Studio and Talk were built in. The spec now sets a catalog of two ungated entries for each example and restores the old one afterwards. The assertions are unchanged. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(cli): report a failed write of the MLX hostfile The tunnel callback ignored the error of os.WriteFile and set the hostfile variable even when the file was not written. It now logs the error and leaves the variable alone. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(addons): discard the close error of the held listener errcheck flags the deferred Close of the listener that keeps the port busy. The test has no use for that error, so the defer drops it explicitly. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(addons): move the add-on tool tests to Ginkgo The fine-tuning, quantization and add-on host library tests used t.Errorf, t.Fatal and t.Run, which the forbidigo rule rejects. They now use Describe, It and Gomega, with a suite bootstrap in each package. The cases and the assertions are the same. The tables in the host client and the tool schema tests keep one entry per case. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(addons): move the host operation tests to Ginkgo The hostops tests used the testing package calls that forbidigo rejects. They now run as Ginkgo specs under one suite bootstrap. Every check and every per-operation case is kept. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(addons): move the pin store tests to Ginkgo The pin service, file store, sweep and shared store contract tests used the testing package calls that forbidigo rejects. The store contract is now a function that registers its specs for each store, so the file store, the memory-only store and the database store run the same cases. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(addons): move the remaining add-on tests to Ginkgo The built-in catalog, tool arguments, loopback carrier, host operation contract, packaging, application, config, CLI and endpoint tests used the testing package calls that forbidigo rejects. They now run as Ginkgo specs. The endpoint tests also drop the unchecked Close errors that errcheck reports when the auth tag is on. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(ui): wait for the targeted Reinstall button before the install click The "generic deletion blocks targeted install at confirmation" spec dispatches a popstate to set the target node, then clicks Reinstall with a script click. The click can run before the targeted page has rendered or while the button is still disabled, so no install request is sent and the poll on the install count times out. It failed 1 run in 10 with two workers and on every retry in CI. The spec now waits for the button to be enabled first. The assertions are unchanged. Assisted-by: Claude Code:claude-sonnet-5-5 playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * chore(addons): refresh the voice package digest in the first-party index The Voice add-on became one page with tabs and got a new icon, so the digest in gallery/addons/index.yaml no longer matched the build. Render the entry again with addonpkg catalog over a locally built linux/amd64 package; the main page is now voice. The other entries are unchanged. Assisted-by: Claude Code:claude-sonnet-5-5 go node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(ui): wait for the target node's Reinstall button after the popstate The "generic deletion blocks targeted install at confirmation" spec dispatches a popstate to set the target node, then waits for a button named Reinstall and clicks it. Until React renders the targeted page, the page still draws the generic Reinstall button. It is enabled and has the same name, so the wait passed on it, the click started a global install, and no node install request was sent. The poll on the install count timed out with the confirm dialog still open. With the CPU throttled to 8x, the spec failed on 20 of 20 runs, and the button it clicked had the title "Reinstall". The spec now waits for the button titled "Reinstall on <node>". With the throttle it passes 30 of 30 runs. The assertions are unchanged. Assisted-by: Claude Code:claude-sonnet-5-5 playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(ui): give the Studio hand-off spec a budget for the cold bundle load The "a result made through a hand-off records which result it came from" spec opens the Studio add-on straight from an address, twice. Each is a cold load: the page shows "Loading" until the add-on module has run, and the next assertion had the default five seconds. The load takes about two seconds on an idle run and seven to ten under CPU load, so the spec failed on a loaded machine with the hand-off note not yet drawn. With the CPU throttled to 6x and eight busy loops running, it failed on 21 of 30 runs. The first assertion after each load now waits up to 20 seconds, and the spec then passed 30 of 30 under the same load. The assertions are unchanged. Assisted-by: Claude Code:claude-sonnet-5-5 playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(addons): carry the identity page styles in the Face add-on The Face page is drawn with the shared identity views, but its style sheet held only the clip and error rules. The page, card, model list, known-faces table, enrol sheet and distance scale classes had no rules. They looked right only when the host had already loaded the style sheet of its own Faces page, which a visit through the add-on drawer does not do. Opened that way, the cards had no gap, the model list showed bullets, and the install buttons ran into the names. The Face sheet now holds the same identity rules as the core sheet, so the page looks the same whichever way it is opened. Assisted-by: Claude Code:claude-sonnet-5-5 playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(addons): scope the narrow-screen identity rules of the Voice add-on The rules for narrow screens (single-column pairs, smaller tool padding, compact rank rows) were copied into the Voice style sheet without their media query, so they applied at every width. They now sit in a max-width 720px query, and the reduced-motion rule in its own query, as in the core sheet. Assisted-by: Claude Code:claude-sonnet-5-5 playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(addons): drop the repeated title from the Voice and Face pages The add-on shell already titles the page, so the recognition pages showed the name twice: "Voice" above "Voices", "Face" above "Faces". Keep the supporting line and the model picker, as the Studio page does, and remove the unused title strings. Assisted-by: Claude Code:claude-sonnet-5-5 node playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(ui): replace the Pinned sidebar section with an Apps entry The sidebar no longer lists pinned add-ons. It shows one Apps entry that opens the add-ons drawer, with a Show all link below it that opens the same drawer. Pins are used from the drawer, where a pinned tile keeps its pin and move buttons. The server pins API is unchanged. Remove the PinnedNav component and its locale title, rename the items.addons label to Apps, and update the e2e specs and the add-ons documentation to match. Assisted-by: Claude Code:claude-sonnet-5-5 playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(addons): assert the single shell title on the Voice and Face pages The add-on shell now shows the one title, "Voice" or "Face", and the page no longer repeats it. The tests still looked for the h1 "Voices" and "Faces". Assert that the add-on page has exactly one h1 and that it is the shell title. The core pages keep their own "Voices" and "Faces" titles. Assisted-by: Claude Code:claude-sonnet-5-5 playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(addons): drop the repeated title from the Voice Library and Text to speech pages The add-on shell already titles the page "Voice", so these two tabs showed a second heading below it ("Speech voices", "Speak text"). Keep the supporting line, as the Studio and recognition pages do, and remove the unused title strings. The e2e spec now checks that each tab has exactly one h1, the shell title. Assisted-by: Claude Code:claude-sonnet-5-5 node playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(ui): list pinned apps under Apps in the sidebar A pinned app now shows as an indented child of the Apps entry, with its icon and title, in pin order. Show all stays the last child. The pins come from GET /api/addons/pins through the navigation context, and the apps from the add-on registry, which the drawer feeds on every list read, so the links follow the drawer. A pin without an installed app is not drawn, nothing extra shows when no app is pinned, and the children are hidden when the sidebar is collapsed to the rail. Assisted-by: Claude Code:claude-sonnet-5-5 node playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs(addons): say that pinned apps are listed under Apps in the sidebar The sidebar lists the pinned apps between Apps and Show all, in pin order. The pins section and the navigation section said that pins do not appear in the sidebar. Assisted-by: Claude Code:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(ui): remove the Show all link under Apps in the sidebar The link repeated the Apps entry, which opens the same drawer, and looked redundant when no app was pinned. Apps is now the only add-on entry; pinned apps still list under it in pin order. The link, its locale key and the style comment are gone, and the e2e spec and the add-ons docs now say that Apps is the only entry. Assisted-by: Claude Code:claude-sonnet-5-5 node playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(ui): show a first-run card on Apps when nothing is installed An administrator who opens Apps with no add-on installed now sees a short card with three steps: choose a library, browse and install, start the add-on. Its button opens the Browse tab. The card is hidden once an add-on is installed and for anyone who cannot install. Assisted-by: Claude Code:claude-sonnet-5-5 node playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(ui): hide the pinned apps in the icon rail When the window is narrower than 1024 px the sidebar shrinks to the icon rail by CSS alone, without the collapsed class. The pinned app links were still drawn there, with the indent meant for the full sidebar, so their icons sat to the right of the rail and were cut off. Hide the pinned app links in both rail states. The Apps entry keeps its centred icon. The e2e spec checks that the rail shows no pinned app and that every icon is centred at 1280 px collapsed and at 1000 px. Assisted-by: Claude Code:claude-sonnet-5-5 node playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(ui): stop the backend redirect test racing the installed list The test reads the redirected URL right after the path changes. The Backends page then loads the installed list and drops a selected backend that is not installed, so the backend parameter was sometimes already gone when the test read it. The mock server has no llama-cpp, and about 15 of 40 repeated runs failed on the backend assertion. The redirect itself was correct, including show_all. Serve the selected backend in the installed list, so the page keeps the selection and the assertions stay as strict as before. Assisted-by: Claude Code:claude-sonnet-5-5 node playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(addons): accept a same-host Referer or Origin for human confirmation Browsers send no Sec-Fetch-* headers over plain HTTP on an address that is not localhost, so creating a resource from a LAN address failed with "Creating a resource requires your own browser session". When Sec-Fetch-Site is present it must still be same-origin with an empty destination, as before. When it is absent, Origin or, failing that, Referer must name the request host and port. A destination or mode that is present must still be the expected one. This matches the rule in BrowserProtection. The credential, token cookie, API key and tool-context checks are unchanged. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(ui): keep hub entries off the Apps route in the sidebar The Build hub still owned /app/addons through its legacy Add-ons tab, so the sidebar lit both Apps and Build on the Apps page. A tab whose gate is closed now owns no route when the sidebar asks, so only the Apps entry is active there. The hubs keep their own routes, and the legacy navigation still gives /app/addons to the Build hub. Assisted-by: Claude Code:claude-sonnet-5-5 node playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(ui): label the pin control on app tiles and in the detail view The pin was a small icon-only button and hard to find. Each app tile now shows a button reading Pin, or Pinned with a filled pin, and the detail view has the same control in its header. Both toggle the same stored pin. The Apps grid lists pinned apps first, in pin order, then the others. The sidebar list and the server pins API are unchanged. Assisted-by: Claude Code:claude-sonnet-5-5 node playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(addons): check the Voice From a recording tab has one title The Library and Text to speech tabs already assert that the add-on shell title is the only h1. Do the same for the From a recording tab, so a heading added there later fails the navigation spec. Assisted-by: Claude Code:claude-sonnet-5-5 node playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(ui): stop the add-on shell drawing a title over add-on pages The app decides what its page shows. The shell drew the add-on name as a header above every add-on page, so an add-on could not choose its own title. The shell now draws no header on a live, loading or frozen add-on page; each add-on titles its own pages. The unavailable and missing-page states keep the name, because no add-on page is drawn there. The runtime and shell specs now check that the shell adds no page title. Assisted-by: Claude Code:claude-sonnet-5-5 node playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(addons): let each add-on draw its own page title The shell no longer titles add-on pages, so each add-on draws one h1 per page. Voice titles its tabs "Voices" (Recognition and From a recording), "Speech voices" (Library) and "Speak text" (Text to speech); "Add a speech voice" already had its own. Face draws "Faces", Studio "Studio" and Talk "Talk". Tables promotes the database list and database name from h2 to h1. Fine-tuning and Quantization already drew a title. The add-on unit tests and the navigation and Studio specs now assert exactly one h1 per page, with the page's own title. Assisted-by: Claude Code:claude-sonnet-5-5 node playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(addons): add a kind to library entries and read unknown kinds tolerantly A library entry now has an optional kind: addon (the default when it is absent), backend or model. Every index written before kinds existed stays valid and its entries are add-ons. A reader keeps the entries of the kinds it knows and skips the others without reading their fields, so a newer kind never makes an older host refuse the whole index. The refresh result and the library state report how many entries were skipped and of which kinds, and the refresh logs a warning. A kind that is not a plain kind name still makes the index malformed. Search lists add-ons unless the caller asks for a kind, and Resolve returns add-ons only, so an add-on install cannot be pointed at a backend image. A library policy may name the signer with an anchored identityRegex instead of an exact identity, so builds from master and from tags both verify. An add-on install refuses a policy that carries one. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(backends): install a backend from a library entry A library can now list backends. An entry of kind backend names the image of the backend gallery by digest, and POST /backends/library/install installs it on the local node. The gallery stays the source of truth and its install path is the one used: the library resolves the entry, takes the signature policy from the library, pins the image by digest and calls the same install as the gallery. Installing a name that came from a gallery, another library or by hand is refused and changes nothing. The signature policy of a backend library names the signer with an anchored identityRegex, so images signed by the merge workflow on master and on tags both verify. A pattern that is not anchored is refused. An install is bounded by a size limit per kind: add-ons keep 512 MiB and a backend image defaults to 8 GiB, set with --addons-backend-max-bytes. The limit reads the manifest after the signature check and before any layer is fetched. The metadata of an installed backend records the library it came from. scripts/backends/cmd/backendcatalog renders entries from backend/index.yaml and pins them against the registry. The pilot is the CPU build of local-store, in gallery/backends/index.yaml. The library is registered on the first start only with --addons-backend-library, which is off by default. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(ui): show the kind of library entries and install backends from them The Browse tab lists the entries of every kind this host reads and marks each one as an add-on or a backend. A backend installs through the backend route and not through the add-on lifecycle: the confirmation says that the backend gallery is not changed and that a backend runs native code, and a refusal of the host, such as a name installed from another origin, is shown with its own reason. The details give the kind, the alias and the signer pattern. The library editor can name the signer with a pattern. Without this a save would drop the pattern of a backend library. The Libraries tab reports the entries a refresh skipped because their kind is not read. Assisted-by: Claude Code:claude-sonnet-5-5 node playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs(addons): describe backends in the library Document the entry kinds, how a reader skips a kind it does not know, the backend entry format, the signer identity pattern, the install route, the size limit of each kind, the pilot library and the command that renders it. The backend page links to it. Assisted-by: Claude Code:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(mcp): install a backend from a library entry The backend library route installs a backend from an add-on library entry, and the admin REST surface and the MCP catalog must stay in step. Add the install_library_backend tool with an in-process and an HTTP client, the route map entry, the safety-rule listing and a skill recipe. Listing library entries stays on the add-on routes, which the assistant does not expose, so no list tool is added. Assisted-by: Claude Code:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(ui): carry the add-on library keys in every locale The add-on library and backend library strings existed only in English, so the other locales had no value for them. Add the missing keys of the addons namespace to de, es, id, it, ko, pt-BR and zh-CN. The values are the English text until a translation is contributed. Assisted-by: Claude Code:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(backends): report the steps of a library install as a job A backend install from a library ran inside the request and showed nothing until it ended. It is now a job of the gallery service, the kind the backend gallery installs use. The request answers with the job ID and GET /backends/jobs/{id} reports the step as the phase of the job: resolving, verifying, size, fetching and writing, with the byte progress of the fetch. A job that fails keeps the phase of the step that failed and gives the reason. A second install of the same name is refused while one runs. The downloader and the gallery install report their stages through an optional hook, so the steps are the real ones and not a guess. The Browse tab lists the steps of the entry being installed, marks the one that failed, and omits the signature step for a library that does not require one. The library installer also gets Updates and a route that lists the installed library backends with a newer build in their library, for the next change. Assisted-by: Claude Code:claude-sonnet-5-5 node playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(ui): mark library backends and offer their updates on the Backends page A backend installed from a library now shows the library ID next to its name and, in the detail, the library and the digest that metadata.json pinned. Gallery backends look and behave as before, and the gallery reinstall is not offered for a library backend, because the gallery does not list it. When the cached index of the library lists another build in the channel of the installed version, the row says "Update available" and offers an Update button. The button starts the same install as the Browse tab, and the detail shows its steps. Nothing is upgraded on its own. The check says nothing when the library no longer lists the installed version and has several channels, instead of guessing one. Assisted-by: Claude Code:claude-sonnet-5-5 node playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(mcp): match the library installer to the progress type The MCP install of a library backend was written against the earlier Install signature. The job-based install now takes a Progress value, so the application did not build. The MCP interface drops its unused status callback and the application adapts the installer to it. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(gallery): add the model library entry shape and its reader A model library entry is the shared library envelope (kind, id, name, version, description, license, urls, tags, icon, channel, policy, schemaVersion) plus a model body: url, backend, size, files, configFile, overrides, variants and promptTemplates. The envelope lives in the catalog package so the other kinds can move to it. A gallery entry converts to a library entry and back to the same gallery entry. Floats are written so they read back as floats, and an empty variants list stays distinct from an absent one, because both occur in the real index. The reader is strict: unknown fields, duplicate ids, a second document and a flow-style list are refused. An entry of another kind is skipped and reported, as in the add-on reader. The gallery index stays the default and is not changed. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(gallery): render the model library from the model gallery scripts/models/cmd/modelcatalog reads gallery/index.yaml with the same structs the host reads it with, converts every entry to a library entry and back, and fails if any entry does not come back equal. It writes gallery/models/index.yaml and the golden files for the tests. The output is deterministic, and the gallery is only read. The golden files are a digest pair for every entry (the gallery entry and the library entry made from it) and a readable gallery and library pair for each kind of entry: plain, with variants, with an empty variants list, with a config file, with a size, with a backend, with floats in the overrides, without a url, without files and with a multiline description. All 2212 entries of the index round trip. The gallery struct does not read a few keys (last_checked, parameters and four stray capitalised keys); the host drops them when it loads the index, so the library does not carry them, and the command reports them. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(gallery): add --model-index-source to read the model library --model-index-source selects the file the host reads the models of the official gallery from: gallery (the default) or library. With library the gallery named localai reads the model library, from --model-library-url or the file in the repository, and keeps its configured name and URL on every entry. A gallery the owner added keeps its own index, and add-on and backend galleries never take this path. A library that cannot be fetched or read is an error and not a fall back to the gallery, so the setting is never silent. The tests round trip every entry of the real gallery index, compare it with the golden files, check the rendered library file reads and agrees with itself, and cover the strict reader, the kinds it skips, prompt templates, number types, empty lists and the setting. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(backends): upgrade library backends with the auto-upgrade switch The upgrade checker now installs the newer build of a library backend when auto_upgrade_backends is on, on the same check that upgrades the gallery backends. With the switch off nothing is installed and the Update button stays manual. The switch is read on every check, so a change in the runtime settings applies at the next one. There is no second toggle. The tests cover both states and a host without a library. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(cli): add local-ai library to manage library sources local-ai library has list, add, remove, enable and disable. It works on the source store the server reads (addons/sources.json under the data path), so it also works with the server stopped. A source has a kind (addon, backend or model); the store records whether it is a shipped default, and removing a default leaves a tombstone so it does not come back at the next start. The shipped model and backend gallery indexes are default sources next to the official add-on library. Defaults are added at every start when they have no record yet, and an existing file that holds no default is left alone as before. The --model-index-source and --model-library-url flags are removed: a model library is added as a model source, and the gallery entry says it is a library. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(addons): let a source of your own win an entry over a default When two enabled sources list the same entry (same kind and id), the source the user added wins over a shipped default, and the default is ignored for that entry. When two sources the user added list it, search and resolve are refused with an error that names the entry and both sources, and nothing is picked silently. Among shipped defaults nothing changes. The tests cover a user source over a default, a tie between two user sources, a default ignored once a user source wins, and the case where disabling a source ends the conflict. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(cli): map the gallery flags to library sources at startup --galleries and --backend-galleries keep loading the same JSON. At startup each entry they name also becomes a source the user owns, of kind model or backend, so local-ai library list shows it. The mapping is additive: an entry whose kind and URL is already a source (a shipped default, one added with the CLI, or one mapped at an earlier start) is not added twice, and a derived id never collides with another source. The sources then decide which galleries the server reads: a gallery whose source is disabled or removed is left out, and a model library or gallery added with local-ai library add is added. A list set by the flags still replaces the shipped defaults. If the store cannot be opened, the galleries stay as the flags set them. The autoload switches are not touched. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * refactor(library): use id for every kind and seed the default libraries The backend entries of the library used addonId while the model entries use id. Release now has the field ID, written as id for every kind. ReadIndex reads addonId as a legacy alias for one release, for add-ons and backends, and refuses an entry that holds both names. The backend index and the catalog generator write id. The shipped libraries are default sources. The pilot backend library is now on by default, like the official add-on library, and the model library is a new default model source, official-models. The server reads it next to the localai gallery. A source the user removed stays removed, and a source the user adds is added to the defaults. The model catalog header held a backtick that ended its raw string, so the generator did not build. The header no longer has it. Assisted-by: Claude Code:claude-sonnet-5-5 go node playwright Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(library): choose the default model source by build A build read both the localai gallery and the official-models library by default, so every model was listed twice. Now a build reads one of them. library.ModelSource names it: "library" or "gallery". The model source that is not chosen is still shipped, as a disabled default, and local-ai library enable turns it on. The value is a Go variable set at link time with -ldflags, because the same source tree makes both kinds of build and a constant would need a commit to change. It is "library" in the source, so a build from master, go build and go test read the library. Only the exact value "gallery" selects the gallery, so a mistyped value cannot leave a build without a model source. The Makefile sets it from LOCALAI_MODEL_SOURCE. When that is not set, a commit that carries a tag gets "gallery" and any other commit gets "library". .goreleaser.yaml passes the same variable and defaults to "gallery". The release workflow sets it to "library" on a tag, which is the cutover. A default source is seeded once, so a data directory that an earlier build seeded keeps its enabled flags. Switch it with local-ai library enable and disable. Tests assert the master default, the tagged default before the cutover and after it, and that a mistyped value reads the library. The model library header now says that CI checks it and when a build reads it. Assisted-by: Claude Code:claude-sonnet-5-5 go node Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * ci(library): check the model library and cut over on tag No workflow checked gallery/models/index.yaml, so it could go stale when gallery/index.yaml changed. A new workflow, model-library.yml, runs on pull requests and on master when the gallery, the library, the generator or core/gallery change. It runs the generator tests and the library shape tests (the file decodes, it has the library shape, every real entry round trips), then renders the library again from gallery/index.yaml and fails on any difference with git diff --exit-code. The error message gives the command that fixes it. release.yaml gets the cutover. On a tag, a step sets LOCALAI_MODEL_SOURCE=library before GoReleaser runs, and .goreleaser.yaml links it into the binary. Without that step a tagged build reads the gallery. The step is the one place to remove when the gallery is retired. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(library): make the model library the source of the gallery The library, gallery/models/index.yaml, was rendered from the gallery. Now it is the source and models are edited there. modelcatalog reads the library and writes gallery/index.yaml, a generated copy that stays only so releases before the cutover keep working. The gallery file is written in the shape the host reads: the same field order, floats such as 1.0 keep their form, and an empty variants list stays apart from an absent one. The command converts every library entry to a gallery entry and back, loads its own output the way the host does, and fails when an entry comes back different. The gallery copy drops what the library cannot carry: last_checked, parameters and four capitalised keys (Base Model, Context Length, License, Training Data). The gallery struct has no field for any of them, so the host ignored them on load. Every run lists these keys and how often the file being replaced still had each. Loading the old and the new gallery with the host structs gives equal entries for all 2212 models. The tests that read the library and the golden files follow in the next commit. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * ci(library): check the library and that the gallery is its copy The model-library workflow assumed the gallery was the source. It now checks the library file, the new source. The library decodes, every entry has the library shape, every entry converts to a gallery entry and back, and the gallery reader loads the generated gallery and sees the same names, file uris and digests. The workflow then generates gallery/index.yaml again and fails on any diff with git diff --exit-code. The message says the file is generated, not to edit it by hand, and gives the command that regenerates it. The tests in core/gallery read the library file now. The round trip runs library to gallery and back on all 2212 real entries, a new test compares the checked-in gallery with the generated copy so go test finds a hand edit too, and the golden digests and samples are written from the library. The version of an entry is no longer compared with a digest of its content, since an edit to the library does not change it. The docs say the library is the source, the gallery file is a generated copy for releases before the cutover, and edits go to the library. The agent guide for adding models says the same. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(library): add admin routes for library sources and an official libraries switch The library sources of the add-on, backend and model kinds had a CLI but no HTTP routes. Add them for administrators, on the same store and the same functions as `local-ai library`, so the two cannot drift: GET /api/library/sources POST /api/library/sources POST /api/library/sources/{id}/enable POST /api/library/sources/{id}/disable DELETE /api/library/sources/{id} The list carries kind, default, removed (a tombstone), suspended and the conflict message of a source that clashes with another one. A change to a model or backend source applies to the running server. A deleted source drops its gallery by address; a removed default keeps its record. Add the runtime setting official_libraries (default on), with the flag --official-libraries. When it is off, every shipped default source of the three kinds is suspended: it is not read, stays in the store marked default, and comes back when the setting is on again. Sources the user added are not affected. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(ui): list library sources of all three kinds in the Libraries tab The Libraries tab of the Add-ons page now lists the sources of the add-on, backend and model kinds from the new library routes. It has a kind filter with counts, a Default badge, the state of each source (enabled, disabled, removed, or off while the official libraries are off), turn on and off, a Restore button for a removed default, and the conflict message next to a source that clashes. Adding a source takes a kind and, for backends and models, an index format. Settings gets the toggle "Use official libraries" for the official_libraries setting. Add unit tests for the list and the kind filter, and a Playwright spec that runs on a fresh test server started with --library-sources (its own config, port 8097): it lists the three kinds, adds a model source, disables and removes a default, checks the conflict message and the official libraries toggle. Assisted-by: Claude Code:claude-sonnet-5-5 javascript Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(library): extend the backend body to carry what the gallery carries The backend library entry only held an image and its digest. The backend gallery holds more that matters at install and in the UI, so the library could not replace it. Add the missing fields to the backend kind and keep the strict reader. New fields, all refused on an add-on entry: - mirrors: ordered fallback images of the same backend, each oci://. The install pins them with the digest of the artifact. - capabilities: a map from a host capability to a backend id. An entry with capabilities and no artifact is a meta backend. It has no digest, os or arch, is listed for every platform, and installing it installs the backend its capability names, in the same library and channel. - license, urls, tags: display metadata, bounded and checked as text. - icon: an https URL. The add-on ui.icon stays a path in the package. The host never fetches the icon. - mutable: the artifact is a moving tag, such as a development image. The entry has no digest. The install resolves the tag to a digest, verifies that image and records the digest it installed. - schemaVersion: the envelope version. A higher one is refused. The index bounds grow to 8 MiB and 4000 entries, because the backend library lists every image for every platform. Release now holds lists, so the add-on staging compares it with Equal instead of ==. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(library): render the backend library from the whole backend gallery Add the conversion between a gallery backend and its library entries in core/gallery, and make scripts/backends/cmd/backendcatalog build the library from the gallery and the gallery from the library. The library now holds all 1093 gallery entries as 1088 backends, because five names appear twice in the gallery with the same content and are folded. That is 934 concrete backends and 154 meta backends, written as 1240 entries: a backend built for several platforms has one entry for each, with the digest of that platform image. - 539 release entries are pinned by the digest the registry serves for the platform. - 543 development entries (master-* tags) keep their tag and are mutable. The install pins them. - 4 release entries are not pinned, because the registry has no image for them: cpu-qdrant-store, metal-qdrant-store, cpu-gemxcpp and vulkan-gemxcpp. They are marked mutable and no digest is invented. Render them again with --repin once the images exist. The generator can import a gallery once, pin the release images again, and write the gallery file from the library without the network. Before it writes it converts every backend to the library and back and fails if one does not come back equal. A policy is no longer written on each entry, because the host takes the policy of the library source. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * test(library): check that every backend gallery entry round trips Prove that the backend library can replace the backend gallery. The golden input is the real backend gallery from before the library became the source: 1093 entries, kept under core/gallery/testdata/backend_library with the pins the library holds and the digest of each generated entry. TestBackendLibraryRoundTripsEveryRealGalleryEntry converts each entry to library entries, writes them as an index, reads them as a host does, validates them and converts them back. It asserts that all 1093 entries come back equal on every field the gallery reader uses, and logs the count. The five names that appear twice in the gallery have the same content, so the twin is checked against the first one and folded. The other tests check the library file in the repository: every entry passes the host checks, every backend round trips, every meta backend names concrete backends the library has, a development entry keeps its master-* tag and has no digest, and the golden digests still match. Unit tests cover each field, the fields the library cannot carry, which are refused rather than dropped, and entries of one backend that disagree. An entry with no artifact, digest, os or arch no longer writes them as empty strings, so a meta backend and a mutable entry stay short. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(library): make the backend library the source of the backend gallery Flip the source the way the model library did. The backend library, gallery/backends/index.yaml, is where backends are edited. The backend gallery, backend/index.yaml, is now generated from it by scripts/backends/cmd/backendcatalog and stays only so releases before the cutover keep working. It no longer has anchors or hand-written order, and it holds 1088 backends: the five names that were listed twice with the same content are folded. Which source a build reads is set at build time, like the model source: - core/library.BackendSource is "library" or "gallery". Only the exact value "gallery" selects the gallery, so a mistyped value cannot leave a build with no backend source. - A build from master reads the library. The Makefile reads the gallery for a commit that carries a tag (LOCALAI_BACKEND_SOURCE), and GoReleaser defaults to the gallery. - A step in release.yaml sets LOCALAI_BACKEND_SOURCE=library, so a tagged build cuts over by itself. - Both sources are shipped and one is enabled. With --addons-backend-library=false every build reads the gallery. The server hands the shipped backend library to the gallery reader as a library, so the Backends page lists it and installs from it the way it did from the gallery. A backend library the user adds stays with the add-on catalog. The shipped library is now a backend source, not an add-on one. The new workflow backend-library.yml runs the tests, regenerates backend/index.yaml and fails on a diff. It never reads the registry. backendcatalog --add merges backends written in the gallery shape into the library, so adding a backend does not mean writing platform entries by hand; the agent guide says so. Assisted-by: Claude Code:claude-sonnet-5-5 go Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs(library): describe the backend library as the source of the backends Rewrite the backends and add-ons pages for the backend library. The library file is the source of truth and the backend gallery is a generated copy that is never edited by hand. - backends.md: the library and the generated gallery, which source a build reads (master, tagged before the cutover, tagged after it), the --addons-backend-library switch, how to add a backend and generate the gallery, and what CI checks. - addons.md: the full backend entry with the new fields (mirrors, capabilities, license, urls, tags, icon URL, mutable, schemaVersion), meta backends, development images pinned at install, and the backend library section in place of the pilot one. - compatibility-table.md: point to the library as the source. Assisted-by: Claude Code:claude-sonnet-5-5 Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(library): mirrors on library sources, editable through the API Library sources carry an optional list of mirrors. The mirrors go into the gallery entries the server reads, and a source can be edited with PUT /api/library/sources/:id. The mirror forms accepted are http(s), github:, oci:// and file://, at most eight per source. Sources saved before this change load without mirrors. Assisted-by: Claude:claude-haiku-5-5 [Claude Code] Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(ui): library chips on the model and backend pages The model and backend pages manage their own library sources. Filter chips above the list narrow it to one library, and a panel adds, edits, turns on or off, refreshes and removes sources of that kind. The add-on Libraries tab lists add-on sources only. Settings shows the model and backend galleries as a read-only view of the library sources, with their mirrors. Mirrors are edited in the panel. Assisted-by: Claude:claude-haiku-5-5 [Claude Code] Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * feat(ui): show the library chips when a kind has one library The chips were hidden until a page had two libraries, so a single library had no visible filter. The row now shows whenever a page has a library. Assisted-by: Claude:claude-haiku-5-5 [Claude Code] Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * docs(gallery): state the mirror rule and the cutover for the old index The library no longer has no mirrors: a source can list them, so the note now says that the shipped official-models library has none. The mirror section says that clearing a source's mirrors waits for a restart. The cutover section says the old gallery file is removed in the cutover release. Assisted-by: Claude:claude-haiku-5-5 [Claude Code] Signed-off-by: Ettore Di Giacinto <mudler@localai.io> * fix(gosec): tighten the modes the catalog generators write The generators wrote generated files and sample folders with 0644 and 0755. The generated index copies are tracked by git, which keeps only the executable bit, so the tracked files do not change. Local copies get 0600 and 0750. The library path read in mergeLibrary is the operator's own argument, so that read is annotated. Assisted-by: Claude:claude-haiku-5-5 [Claude Code] Signed-off-by: Ettore Di Giacinto <mudler@localai.io> --------- Signed-off-by: Ettore Di Giacinto <mudler@localai.io> Co-authored-by: Ettore Di Giacinto <mudler@localai.io>
15247 lines
571 KiB
Go
15247 lines
571 KiB
Go
// Package swagger Code generated by swaggo/swag. DO NOT EDIT
|
||
package swagger
|
||
|
||
import "github.com/swaggo/swag"
|
||
|
||
const docTemplate = `{
|
||
"schemes": {{ marshal .Schemes }},
|
||
"swagger": "2.0",
|
||
"info": {
|
||
"description": "{{escape .Description}}",
|
||
"title": "{{.Title}}",
|
||
"contact": {
|
||
"name": "LocalAI",
|
||
"url": "https://localai.io"
|
||
},
|
||
"license": {
|
||
"name": "MIT",
|
||
"url": "https://raw.githubusercontent.com/mudler/LocalAI/master/LICENSE"
|
||
},
|
||
"version": "{{.Version}}"
|
||
},
|
||
"host": "{{.Host}}",
|
||
"basePath": "{{.BasePath}}",
|
||
"paths": {
|
||
"/3d/animate": {
|
||
"post": {
|
||
"tags": [
|
||
"3d"
|
||
],
|
||
"summary": "Creates a 3D animation (binary glTF / GLB).",
|
||
"parameters": [
|
||
{
|
||
"description": "Named conditioning inputs and model-specific parameters",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.Model3DAnimationRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.OpenAIResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/3d/generations": {
|
||
"post": {
|
||
"tags": [
|
||
"3d"
|
||
],
|
||
"summary": "Creates a 3D asset (binary glTF / GLB) from a conditioning image.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.Model3DRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.OpenAIResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/3d/remesh": {
|
||
"post": {
|
||
"consumes": [
|
||
"multipart/form-data"
|
||
],
|
||
"produces": [
|
||
"model/gltf-binary"
|
||
],
|
||
"tags": [
|
||
"3d"
|
||
],
|
||
"summary": "Applies watertight print remeshing to an existing 3D asset.",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "3D model name",
|
||
"name": "model",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "file",
|
||
"description": "Source GLB",
|
||
"name": "mesh",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "number",
|
||
"description": "Detail size as percent of the source bounding-box diagonal (0.35–2.5; default 0.5)",
|
||
"name": "detail",
|
||
"in": "formData"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Remeshed GLB",
|
||
"schema": {
|
||
"type": "file"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/apps": {
|
||
"get": {
|
||
"description": "Returns the installed addons that are enabled, for every authenticated caller who holds the addons feature. The owner decides what a caller sees; hiding an entry is never the control, because every call the entry leads to is authorized again. Each app has its title, description, icon URL, version and installed generation, a process state (running, starting, failed or stopped; the state is an observation, separate from the enabled flag), the path of its main page when its manifest declares a valid one, and a bounded tool summary. A headless addon is listed without a main page. Administrators additionally see installed addons that are disabled and, per app, the start and stop controls and the management link. An app carries update update-pending, separate from state, only when the owner's cached update check says an update is available for the installed package; the list never evaluates a check and never reaches a library.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "List the addon apps the caller may use",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Apps visible to the caller",
|
||
"schema": {
|
||
"$ref": "#/definitions/apps.List"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature or owner policy denied the request",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/apps/{id}/icon": {
|
||
"get": {
|
||
"description": "Streams the immutable icon image of the app at the generation named in the query. The image comes from the verified package on the owner, relayed through the receiving frontend; it is never served from an addon process and never from a URL the manifest names. It is served only for an app the caller may see at the generation that was listed. An unknown app, a hidden app, an app without a verified icon and a stale generation give the same 403. The response is an image with X-Content-Type-Options nosniff and Cache-Control private, no-store.",
|
||
"produces": [
|
||
"image/png",
|
||
"image/webp",
|
||
"image/jpeg"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Read the icon of an addon app",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Addon ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"description": "Installed generation from the apps list",
|
||
"name": "generation",
|
||
"in": "query",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Icon bytes",
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"headers": {
|
||
"Cache-Control": {
|
||
"type": "string",
|
||
"description": "private, no-store"
|
||
},
|
||
"X-Content-Type-Options": {
|
||
"type": "string",
|
||
"description": "nosniff"
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Missing or malformed generation",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature denied, or the app is unknown, hidden, has no icon or the generation is stale",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/apps/{id}/start": {
|
||
"post": {
|
||
"description": "Administrators only. Records the desired state enabled through the same lifecycle manager and owner as the typed enable action; the owner starts the process and health stays a separate observation. The body carries the generation the caller saw in the apps list: a different installed generation is denied before anything is recorded. The operationId is the identity of the change: repeat it to replay safely, and after an outcome_unknown response poll operation-status with it instead of submitting a new operation. Non-administrators are denied (403) whatever the body says.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Start an addon app",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Addon ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Operation and the generation the caller saw",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/apps.StartRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Operation accepted; the payload is the operation status",
|
||
"schema": {
|
||
"$ref": "#/definitions/contract.Result"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed body, missing operationId or generation",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature, administration or generation denied the request",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable, or the outcome is unknown (type outcome_unknown, with operationId)",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/apps/{id}/stop": {
|
||
"post": {
|
||
"description": "Administrators only. Records the desired state disabled through the same lifecycle manager and owner as the typed disable action; the owner drains and stops the process and keeps all data. The body carries the generation the caller saw in the apps list: a different installed generation is denied before anything is recorded. The operationId is the identity of the change: repeat it to replay safely, and after an outcome_unknown response poll operation-status with it instead of submitting a new operation. Non-administrators are denied (403) whatever the body says.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Stop an addon app",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Addon ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Operation and the generation the caller saw",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/apps.StartRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Operation accepted; the payload is the operation status",
|
||
"schema": {
|
||
"$ref": "#/definitions/contract.Result"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed body, missing operationId or generation",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature, administration or generation denied the request",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable, or the outcome is unknown (type outcome_unknown, with operationId)",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/artifacts/{id}": {
|
||
"get": {
|
||
"description": "Returns the caller's own artifact: its state (transferring, complete, failed or cancelled), the sanitized file name, the media type, the exact size and the expiry. Only the principal that requested the result can read it; an unknown identifier and another user's artifact give the same 403, so identifiers cannot be probed. The response never carries a storage path or an addon handle. This is the status lookup of the background transfer; it is read-only.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Read the state of a private addon file result",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Artifact ID (host generated, opaque)",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Artifact state",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.Artifact"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature denied, or the artifact is unknown, expired or not the caller's",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/artifacts/{id}/download": {
|
||
"get": {
|
||
"description": "Streams the caller's own complete artifact as an attachment, relayed through the receiving frontend from the owner that holds the bytes. Access needs the session or key of the principal that requested the result and, at the start and while streaming, current read access to every source resource and a current account. An artifact that is not complete, is expired, belongs to another principal or is unknown gives the same 403. The response is always an attachment (RFC 6266) with a sanitized name, a media type from a fixed allowlist or application/octet-stream, X-Content-Type-Options nosniff and Cache-Control private, no-store; it is never rendered inline. A failure after the first byte aborts the connection, so a truncated file never looks complete. Disabling the addon denies downloads and keeps the bytes until expiry; enabling it again serves unexpired artifacts to principals that still have access.",
|
||
"produces": [
|
||
"application/octet-stream",
|
||
"text/csv",
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Download a private addon file result",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Artifact ID (host generated, opaque)",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Artifact bytes",
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"headers": {
|
||
"Cache-Control": {
|
||
"type": "string",
|
||
"description": "private, no-store"
|
||
},
|
||
"Content-Disposition": {
|
||
"type": "string",
|
||
"description": "attachment with a sanitized filename and filename*"
|
||
},
|
||
"Content-Length": {
|
||
"type": "string",
|
||
"description": "exact size of the artifact"
|
||
},
|
||
"X-Content-Type-Options": {
|
||
"type": "string",
|
||
"description": "nosniff"
|
||
}
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature denied, or the artifact is unknown, expired, incomplete, not the caller's or no longer readable by the caller",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable, or the download bound is reached",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/builtin": {
|
||
"get": {
|
||
"description": "Returns the page add-ons that ship inside the web bundle. The list is empty today: Studio and Talk are packaged add-ons that a person installs from the Add-ons drawer. Each entry carries only its own gate: the route needs an authenticated caller and no ` + "`" + `addons` + "`" + ` feature.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"AddonNavigation"
|
||
],
|
||
"summary": "List the built-in add-ons the caller may open",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Entries the caller may open",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/builtin.Entry"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/conversations/{conversationId}/selection/{addonId}": {
|
||
"get": {
|
||
"description": "Returns the resource the authenticated user selected for the conversation and add-on, with the user's current role and display name. The stored reference is keyed by the authenticated user, the conversation and the add-on, and is never a credential: the owner authorizes it again on every use. A reference that was revoked, deleted or never set is one answer: 404 not_selected. Another user's selection of the same conversation ID is never visible. Read-only. No MCP tool maps to this route.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Read the resource selected for a conversation",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Conversation ID",
|
||
"name": "conversationId",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Add-on ID",
|
||
"name": "addonId",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The selection",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.Selection"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed conversation or add-on ID",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature denied",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Type not_selected",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"put": {
|
||
"description": "Stores which resource the authenticated user chose for the conversation and add-on, so that chat tool calls that name no resource use it. The caller must hold at least the viewer role on the resource now; the stored reference is never a bearer and is authorized again at the owner on every use. It is not process-global, not shared between users or conversations, and not part of the chat history. The store is bounded per user and expires unused entries. No MCP tool maps to this route.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Select the resource a conversation works on",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Conversation ID",
|
||
"name": "conversationId",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Add-on ID",
|
||
"name": "addonId",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "The resource",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.SelectionRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The selection",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.Selection"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed IDs or body",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature denied, or the resource is unknown or not readable by the caller",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"description": "Removes the authenticated user's selection for the conversation and add-on. Clearing a selection that does not exist succeeds. No MCP tool maps to this route.",
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Clear the resource selected for a conversation",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Conversation ID",
|
||
"name": "conversationId",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Add-on ID",
|
||
"name": "addonId",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "Cleared"
|
||
},
|
||
"400": {
|
||
"description": "Malformed conversation or add-on ID",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature denied",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/dispatch": {
|
||
"post": {
|
||
"description": "Authenticates the named caller, checks the addons feature, requires administration for every action except read, and forwards the typed request to the designated addon owner. A mutation is never retried: after an outcome_unknown response keep the operationId and poll operation-status instead of submitting a new mutation. Lifecycle actions are install, upgrade, enable, disable and uninstall (arguments sourceId and version; enable and disable take the generation that was listed). The management reads, all administrator-only and never mutations, are catalog-search (arguments text, kind, sourceId, offset, limit up to 100; kind is addon by default, or backend, or all), catalog-details (addonId plus arguments sourceId and version), catalog-sources and addons-installed. The library changes are catalog-source-save (arguments are one source: id, name, url, enabled, policy, authReference; removed true deletes it and never touches installed addons) and catalog-source-refresh (argument sourceId). A library names a credential only by a reference the owner configured, never a secret. Unknown argument fields are denied. The update actions are update-status and update-check (no arguments; the check fetches the library again and applies nothing) and update-upgrade (arguments expectedDigest and candidateDigest, the pinned upgrade); each answers with a payload {error: {type, message, status}} or {data}, the same from every frontend. The browser pages use the dedicated routes under /api/addons/{id}/update and /api/addons/{id}/upgrade, which accept only an administrator's own browser session.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Submit a typed addon lifecycle operation or read an addon resource",
|
||
"parameters": [
|
||
{
|
||
"description": "Typed addon request",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/contract.Request"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Operation accepted or read result",
|
||
"schema": {
|
||
"$ref": "#/definitions/contract.Result"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed or unknown request fields, or type invalid_request when the add-on refused the request as invalid: nothing was applied and the same call is refused again",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature, administration or owner policy denied the request, or type sdk_incompatible when an install is refused because the add-on needs another SDK version: the message names the range the add-on needs and the SDK version the host provides",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable, or the outcome of a mutation is unknown (type outcome_unknown, with operationId)",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/pins": {
|
||
"get": {
|
||
"description": "Returns the ordered add-on IDs the caller pinned to the sidebar. The route never pins anything by itself; Studio and Talk are pinned once, at upgrade, for the accounts that existed then. The list holds only IDs the caller may see right now: a hidden or removed add-on is left out and the route does not reveal whether it exists. Needs an authenticated caller and no administrator role.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"AddonNavigation"
|
||
],
|
||
"summary": "List the add-ons the caller pinned",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Ordered add-on IDs",
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "The pin store is unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"put": {
|
||
"description": "Replaces the caller's pins with the ordered list in the body. IDs the caller may not see are dropped without any hint, and pins that are only hidden for now are kept. At most 32 IDs are accepted. Needs an authenticated caller from a same-origin browser request or a credential header, and no administrator role.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"AddonNavigation"
|
||
],
|
||
"summary": "Replace the add-ons the caller pinned",
|
||
"parameters": [
|
||
{
|
||
"description": "Ordered add-on IDs",
|
||
"name": "pins",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The saved list the caller can see",
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Not a list of strings, or longer than 32",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "The pin store or the add-on owner is unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/proposals": {
|
||
"get": {
|
||
"description": "Returns the caller's proposals that still wait for a human decision, newest first, at most 32, each with its state, exact effect count, bounded sample, digest and expiry. This is where a change proposed by a chat tool, an agent or a scheduled job waits: only the proposer's own browser session can confirm it. A proposal of another user is never listed, and an expired one is left out. Read-only: it applies nothing. API keys may call it so an unattended agent can see what is waiting; they still cannot confirm.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "List the caller's own pending addon proposals",
|
||
"parameters": [
|
||
{
|
||
"enum": [
|
||
"pending"
|
||
],
|
||
"type": "string",
|
||
"description": "Only pending is supported",
|
||
"name": "state",
|
||
"in": "query",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The caller's pending proposals",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.PendingList"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Missing or unsupported state filter",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature denied",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"post": {
|
||
"description": "A request with action create and no resourceId proposes the creation of a resource: the owner reserves a pending resource for the caller that nobody can reach, shows the requested name, and creates it only on confirmation by the proposer's browser session. Previews the mutation on the addon owner and stores it as a pending proposal with its exact effect count, a bounded sample, the revisions it saw and an expiry. Nothing is applied. The operationId becomes the proposal ID; repeating the same request returns the same proposal. Sharing and database deletion are never proposals. A named session or API key with the addons feature may propose; the proposal can only be applied by Confirm, which requires the proposer's own browser session. No MCP tool confirms a proposal.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Propose an addon data or schema mutation, or a resource creation, for confirmation",
|
||
"parameters": [
|
||
{
|
||
"description": "Typed write, schema or create request",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/contract.Request"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Stored proposal",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.Proposal"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed or unknown request fields, or type invalid_request when the add-on refused the request as invalid: nothing was applied and the same call is refused again",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature, resource policy or request binding denied the proposal. Type outcome_blocked (with blockedBy) when the caller is the owner role of the resource and another operation on it has an unresolved outcome; other callers get the plain denial",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable. Type outcome_unknown (with operationId): the proposal had been handed to the addon and its outcome is unknown, reconcile it. Type proposal_unavailable (with operationId): the owner could not serve this call and this call sent nothing to the addon; read the proposal for its state, which may already be settled, and repeat the same call with the same ID",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/proposals/{id}": {
|
||
"get": {
|
||
"description": "Returns the caller's own proposal with its state, effects, receipt and, for a pending proposal that is blocked, the operation to resolve first. Expiry is recorded when a pending proposal is read after its expiry.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Read a stored addon proposal",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Proposal ID (the operation ID)",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Stored proposal",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.Proposal"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature denied, or the proposal is not the caller's",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/proposals/{id}/cancel": {
|
||
"post": {
|
||
"description": "Withdraws the caller's pending proposal. A cancelled, expired or settled proposal can never run. Cancelling needs only a current identity.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Cancel a pending addon proposal",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Proposal ID (the operation ID)",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Cancelled proposal",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.Proposal"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature denied, the proposal is not the caller's, or it is not pending",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable. Type outcome_unknown (with operationId): the proposal had been handed to the addon and its outcome is unknown, reconcile it. Type proposal_unavailable (with operationId): the owner could not serve this call and this call sent nothing to the addon; read the proposal for its state, which may already be settled, and repeat the same call with the same ID",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/proposals/{id}/confirm": {
|
||
"post": {
|
||
"description": "Applies exactly the stored operation once. This is the only way a stored mutation reaches an addon. It is accepted only from the proposer's own browser session: a same-origin fetch from the host UI that carries the X-LocalAI-Confirm header equal to the proposal ID and the digest of what was shown. API keys, bearer tokens, MCP sessions and requests that carry tool or agent execution markers are refused, and no MCP tool maps to this route. A repeated confirmation returns the stored receipt. If the reply is lost the outcome is outcome_unknown with the original operationId; resolve it with reconcile and never submit the change again.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Confirm and apply a pending addon proposal",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Proposal ID (the operation ID)",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Digest of the displayed proposal",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.ConfirmRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Proposal after the apply, with its receipt",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.Proposal"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed or unknown request fields, or type invalid_request when the add-on refused the request as invalid: nothing was applied and the same call is refused again",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Not a human confirmation surface, feature denied, or the proposal is not pending, is expired, stale, changed or blocked",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable. Type outcome_unknown (with operationId): the proposal had been handed to the addon and its outcome is unknown, reconcile it. Type proposal_unavailable (with operationId): the owner could not serve this call and this call sent nothing to the addon; read the proposal for its state, which may already be settled, and repeat the same call with the same ID",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/proposals/{id}/reconcile": {
|
||
"post": {
|
||
"description": "Looks the operation's receipt up on the owner and records a committed or rejected result. It never applies anything and can be repeated. Use it after an outcome_unknown response. While an outcome is unresolved, other writes on the same resource are denied.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Resolve the outcome of an addon proposal by receipt lookup",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Proposal ID (the operation ID)",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Proposal after the lookup",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.Proposal"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature denied or the proposal is not the caller's",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons, the owner or the addon runtime are unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/proposals/{id}/resolve": {
|
||
"post": {
|
||
"description": "Explicit recovery for an operation whose receipt cannot be found. After outcome_unknown, repeated reconcile calls and the automatic lookups that did not settle it, the owner role of the resource may record that the outcome is not worth waiting for. The proposal becomes abandoned-unknown with the acting owner, the time and the stated reason, and stops blocking writes on the resource. The operation is never submitted again, and a later receipt lookup that says it ran is recorded as applied. The owner is asserting that waiting is not worth it: a change that did run stays in the data, and the revision check of later changes protects against applying on a stale view. Accepted only from a host confirmation surface with the same rules as confirm: the owner's own browser session, a same-origin fetch, the X-LocalAI-Confirm header equal to the proposal ID, and no tool, agent or MCP marker. Installation administrators and API keys have no access through this route, and no MCP tool maps to it.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Abandon an unresolved addon proposal outcome as the resource owner",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Proposal ID (the operation ID)",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Digest of the displayed proposal and the reason",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.ResolveRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Proposal after the acknowledgement, or settled by a final receipt",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.Proposal"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed or unknown request fields, or type invalid_request when the add-on refused the request as invalid: nothing was applied and the same call is refused again",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Not a human confirmation surface, not the resource owner, feature denied, digest changed or the proposal is not unresolved",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable. Always type proposal_unavailable (with operationId), whoever proposed the operation, because resolving is not an apply: the owner could not serve this call and it sent nothing to the addon; read the proposal for its state and repeat the same call with the same ID",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/relay": {
|
||
"post": {
|
||
"description": "Streams the response of the designated addon owner through the receiving frontend, bounded per kind by the configured byte and time limits. The kind selects the response: status (JSON), progress (text/event-stream), json, file (a private file result as an attachment: the handle is the artifact ID that a read returned, never an addon handle) or asset (text/javascript or text/css). An owner decision made before the first byte is returned with the same status from every frontend; a failure after the first byte aborts the stream.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json",
|
||
"text/event-stream",
|
||
"application/octet-stream",
|
||
"text/javascript",
|
||
"text/css"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Relay addon status, lifecycle progress, JSON, attachments or immutable UI assets",
|
||
"parameters": [
|
||
{
|
||
"description": "Relay request",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.RelayRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Relayed response body",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed or unknown request fields, or type invalid_request when the add-on refused the request as invalid: nothing was applied and the same call is refused again",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature or owner policy denied the request",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/resources": {
|
||
"get": {
|
||
"description": "Returns the resources of one add-on that the caller owns or that were shared with the caller, each with the caller's own role, the display name the add-on reported (empty when it could not answer in time), the owner's display name for a shared resource and, for the owner role only, how many people it is shared with and the revision to send back with a rename or a delete. Resources of other people that are not shared with the caller are never listed, whatever the caller's installation role: installation administration is not data access. The answer also carries the installed generation, whether sharing is possible (false in local-owner mode) and the management operations the add-on supports. At most 100 resources are listed (truncated says more exist). Read-only. API keys may call it. No MCP tool maps to this route.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "List the add-on resources the caller may use",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Add-on ID",
|
||
"name": "addonId",
|
||
"in": "query",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Resources the caller may use",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.ResourceList"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Missing or malformed add-on ID",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature denied",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons, the owner or the add-on are unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"post": {
|
||
"description": "Creates a resource through the add-on's create tool as the person's own explicit action, for example a new database. It needs no confirmation card: the request is the intent, and the same admission, quota, receipt and crash reconciliation rules as every mutation apply. The caller becomes the owner and the resource is private. Repeating the same operationId returns the same resource and never creates a second one; after outcome_unknown repeat the same call. The arguments are validated against the add-on's own tool definition. Accepted only from the person's own browser session: a same-origin fetch whose X-LocalAI-Confirm header equals the operationId, with no API key and no tool, agent or MCP marker. No MCP tool maps to this route.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Create an add-on resource (UI only)",
|
||
"parameters": [
|
||
{
|
||
"description": "Create request",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.CreateResourceRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The created resource",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.ResourceInfo"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed request or arguments the add-on's tool does not accept",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Not a human surface, feature or creation authority denied, or type quota_reached",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "Type stale: the generation is not the installed one",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Unavailable, or type outcome_unknown (with operationId) after which the same call is repeated",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/resources/{resourceId}/apply": {
|
||
"post": {
|
||
"description": "Applies one change through a write or schema tool the add-on declares, for example inserting rows or adding a column, as the person's own explicit action in the person's own browser tab. It needs no confirmation card: the request is the intent. It is not a proposal and nothing is stored for later. The same rules as every change apply: the role of the action (the owner and editors write rows, only the owner changes the schema, viewers and installation administrators without a grant get the answer of an unknown resource), the declared tool definition, the resource's admission, the generation and the revision the caller read (409 stale, nothing changed), the add-on's receipt, which makes repeating the same operationId with the same request one change, and a wait behind an unresolved outcome. The tool's arguments must not name the resource, the tool, an actor or any field the tool definition does not declare. Reads, creations, the add-on's rename and delete, administrator tools and tools nobody declared are refused with 400. Accepted only from the person's own browser session: a same-origin fetch whose X-LocalAI-Confirm header equals the resource ID, with no API key and no tool, agent or MCP marker. After outcome_unknown, look the receipt up with kind=apply and the original operationId; never submit a new operation. No MCP tool maps to this route.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Change a resource's data or schema by the person's own action (UI only)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Resource ID",
|
||
"name": "resourceId",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Change request",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.ApplyResourceRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The committed change and its receipt",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.ApplyResult"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed request, a tool that is not a change, or arguments the tool does not accept",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Not a human surface, feature denied, role too low or unknown resource, or type outcome_blocked",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "Type stale: the generation or the revision moved",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Unavailable, or type outcome_unknown (with operationId)",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/resources/{resourceId}/delete": {
|
||
"post": {
|
||
"description": "Permanently deletes the resource, its data and every grant, as the owner's own explicit action. It is never a chat operation and never an uninstall. The request must carry the generation and revision the owner listed and confirm, which must equal the resource's display name exactly. The owner marks the resource as deleting (inaccessible to everyone, no new admission), stops and waits for admitted work, checks the revision, cancels pending proposals, asks the add-on to delete and only then removes the record and the grants. A crash leaves a deleting record that the owner finishes at startup; an unconfirmed one returns to use. A 503 with type outcome_unknown means the deletion is confirmed and being finished: repeat the same call, the resource is inaccessible meanwhile. Accepted only from the owner's own browser session (same-origin fetch, X-LocalAI-Confirm equal to the resource ID). No MCP tool maps to this route and the add-on's delete tool is not offered to any model.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Delete a resource and its data (owner, UI only)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Resource ID",
|
||
"name": "resourceId",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Delete request with the typed confirmation",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.DeleteResourceRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Deleted",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.DeleteResult"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed request, wrong confirmation or unsupported operation",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Not a human surface, feature denied, not the owner role or unknown resource, or type outcome_blocked",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "Type stale",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Unavailable, or type outcome_unknown (with operationId)",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/resources/{resourceId}/grants": {
|
||
"get": {
|
||
"description": "Returns the grants of the whole resource: the immutable account ID, the display name and the role of each grantee. Only the owner role of the resource may read it; installation administrators, editors and viewers get the same denial as for an unknown resource. Local-owner mode has no sharing and answers 409 sharing_disabled. Accepted only from the owner's own browser session (same-origin fetch, X-LocalAI-Confirm equal to the resource ID). No MCP tool maps to this route.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "List who a resource is shared with (owner, UI only)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Resource ID",
|
||
"name": "resourceId",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Grants of the resource",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.GrantList"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Not a human surface, feature denied, not the owner role or unknown resource",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "Type sharing_disabled",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/resources/{resourceId}/grants/{userId}": {
|
||
"put": {
|
||
"description": "Gives the user the viewer or editor role on the whole resource; there are no per-table grants and the owner role cannot be granted. The user is named by the immutable account ID the user picker returned, and must be an active named account that may use add-ons. Lowering a role stops the user's admitted work and cancels the user's pending proposals before it is acknowledged. Local-owner mode answers 409 sharing_disabled. Accepted only from the owner's own browser session (same-origin fetch, X-LocalAI-Confirm equal to the resource ID). Safe to repeat; after outcome_unknown repeat the same call. No MCP tool maps to this route: sharing is never a tool.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Share a whole resource with a named user (owner, UI only)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Resource ID",
|
||
"name": "resourceId",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Account ID of the grantee",
|
||
"name": "userId",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Role",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.SetGrantRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Grants after the change",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.GrantList"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed body or role",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Not a human surface, feature denied, not the owner role, unknown resource or a user that cannot be granted",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "Type sharing_disabled",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Unavailable, or type outcome_unknown (with operationId)",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"description": "Removes the user's grant. It returns only after the user's admitted work stopped and their pending proposals were cancelled; a drain that did not finish in the bound is a 503 and the revocation is already effective for new work. Local-owner mode answers 409 sharing_disabled. Accepted only from the owner's own browser session (same-origin fetch, X-LocalAI-Confirm equal to the resource ID). Safe to repeat. No MCP tool maps to this route.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Stop sharing a resource with a user (owner, UI only)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Resource ID",
|
||
"name": "resourceId",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Account ID of the grantee",
|
||
"name": "userId",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Optional operation ID, returned with outcome_unknown",
|
||
"name": "operationId",
|
||
"in": "query"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Grants after the change",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.GrantList"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Not a human surface, feature denied, not the owner role or unknown resource",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "Type sharing_disabled",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Unavailable, or type outcome_unknown (with operationId)",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/resources/{resourceId}/operations/{operationId}": {
|
||
"get": {
|
||
"description": "Read-only receipt lookup after an outcome_unknown answer. kind is rename (operationId is the one the rename carried), delete or apply (the operationId of a change; any role that may write looks up its own). The state is pending, committed, rejected or unknown; it never applies anything. The owner role may look up a rename or a deletion and the roles that may write look up their own changes, from the owner's own browser session (same-origin fetch, X-LocalAI-Confirm equal to the resource ID). After a deletion finished the resource is gone and the lookup is denied like any unknown resource. No MCP tool maps to this route.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Look up the receipt of a rename or a deletion (owner, UI only)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Resource ID",
|
||
"name": "resourceId",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Operation ID of the rename",
|
||
"name": "operationId",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"enum": [
|
||
"rename",
|
||
"delete",
|
||
"apply"
|
||
],
|
||
"type": "string",
|
||
"description": "Operation kind",
|
||
"name": "kind",
|
||
"in": "query",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Apply only: the requestHash of the request the caller means (64 lowercase hex). A lookup whose hash is not the one the operation ID was used for is a 409 operation_conflict, never the other request's receipt",
|
||
"name": "requestHash",
|
||
"in": "query"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Receipt state",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.OperationStatus"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Unsupported kind or malformed requestHash",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Not a human surface, feature denied, not the owner role or unknown resource",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "Type operation_conflict: the operation ID belongs to another request",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons, the owner or the add-on are unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/resources/{resourceId}/proposals": {
|
||
"get": {
|
||
"description": "Returns the proposals on the resource whose outcome is unresolved (executing, outcome-unknown) or abandoned-unknown, whoever proposed them, so the resource owner can learn the operation ID and digest that resolve needs. Each entry has the proposal ID, state, the proposing user, the action, the exact effect count and the bounded effect sample the proposer saw, the expiry, the digest and the age in seconds. It never returns the proposed arguments or any credential. Read-only. Only the owner role of the resource may call it; installation administrators, editors and viewers are denied. It is accepted only from a host confirmation surface with the rules of resolve: the owner's own browser session, a same-origin fetch, the X-LocalAI-Confirm header equal to the resource ID, and no tool, agent or MCP marker. API keys are refused and no MCP tool maps to this route.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "List the unresolved addon proposals of a resource as its owner",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Resource ID",
|
||
"name": "resourceId",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"enum": [
|
||
"unresolved"
|
||
],
|
||
"type": "string",
|
||
"description": "Only unresolved is supported",
|
||
"name": "state",
|
||
"in": "query",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Unresolved proposals, oldest first",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.ProposalList"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Missing or unsupported state filter",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Not a human confirmation surface, not the owner role of the resource, feature denied or unknown resource",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/resources/{resourceId}/rename": {
|
||
"post": {
|
||
"description": "Renames the resource through the add-on as the owner's own explicit action, with no confirmation card. It still runs under the resource's admission, waits behind an unresolved outcome (403 outcome_blocked for the owner role), is checked against the generation and the revision the owner listed (409 stale, nothing changed) and leaves the add-on's receipt for the operation. Repeating the same operationId never renames twice; after outcome_unknown repeat the same call or look it up with the operation status route. Accepted only from the owner's own browser session (same-origin fetch, X-LocalAI-Confirm equal to the resource ID). No MCP tool maps to this route.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Rename a resource (owner, UI only)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Resource ID",
|
||
"name": "resourceId",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Rename request",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.RenameResourceRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The renamed resource",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.ResourceInfo"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed request or a name the add-on refuses",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Not a human surface, feature denied, not the owner role or unknown resource, or type outcome_blocked",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "Type stale",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Unavailable, or type outcome_unknown (with operationId)",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/resources/{resourceId}/users": {
|
||
"get": {
|
||
"description": "Finds active named accounts that may use add-ons by a prefix of the display name or of the address, 2 to 64 characters, at most 20 results. Each result is an immutable account ID and a display name and nothing else. Only the owner role of the resource may search; the owner and the caller are left out. Local-owner mode answers 409 sharing_disabled. Accepted only from the owner's own browser session (same-origin fetch, X-LocalAI-Confirm equal to the resource ID). No MCP tool maps to this route.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Search the people a resource can be shared with (owner, UI only)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Resource ID",
|
||
"name": "resourceId",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Name or address prefix",
|
||
"name": "q",
|
||
"in": "query",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"description": "At most this many results, up to 20",
|
||
"name": "limit",
|
||
"in": "query"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Matching people",
|
||
"schema": {
|
||
"$ref": "#/definitions/gateway.UserList"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Query too short or too long",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Not a human surface, feature denied, not the owner role or unknown resource",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "Type sharing_disabled",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/{id}/assets/{digest}/{path}": {
|
||
"get": {
|
||
"description": "Streams one file the addon manifest declares as UI code (the entry module or a style sheet) from the verified package on the owner, relayed through the receiving frontend. The digest in the path is the sha256 of the installed package, in lower-case hex, as listed in the ui entry of the apps list. The file is served only while the addon is installed and enabled and the digest is the current one; a file the manifest does not declare, a traversal, a directory, another addon, an older package, a disabled or uninstalled addon and a missing feature all give a denial without any file content, and a denial is never cached. The response is text/javascript or text/css with X-Content-Type-Options nosniff and Cache-Control private, max-age=31536000, immutable: the URL changes with the package, so the file never changes under it. The caller is authenticated by an API key header or by the same-origin browser session; a credential in the URL is never accepted. The addon process is never asked.",
|
||
"produces": [
|
||
"text/javascript",
|
||
"text/css"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Read an immutable file of an addon UI package",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Addon ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Package digest, 64 lower-case hex characters",
|
||
"name": "digest",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Declared package file, for example ui.js",
|
||
"name": "path",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "File bytes",
|
||
"schema": {
|
||
"type": "string"
|
||
},
|
||
"headers": {
|
||
"Cache-Control": {
|
||
"type": "string",
|
||
"description": "private, max-age=31536000, immutable"
|
||
},
|
||
"X-Content-Type-Options": {
|
||
"type": "string",
|
||
"description": "nosniff"
|
||
}
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature denied, or the file, addon or package digest is not currently served",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/{id}/purge": {
|
||
"post": {
|
||
"description": "Administrators only, from their own browser session, with the add-on ID typed as confirm. Removes retained data the scope names: the add-on's data and the owner's records of its resources and shares (data), its backups (backups) and the data copies that restores and failed upgrades set aside (recoveryCopies). The add-on must be uninstalled or disabled. It is not the deletion of a database and not an uninstall; those never remove retained data. The purge is journaled and finished after a crash, and it touches no other add-on. No MCP tool maps to this route.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Purge the retained data of an add-on (administrators, browser session)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Add-on ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Operation, scope and confirmation",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.RecoveryPurgeRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "What was purged, with warnings",
|
||
"schema": {
|
||
"$ref": "#/definitions/recovery.PurgeReceipt"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed request, empty scope or type confirmation_mismatch",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature, administration or browser session denied",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "Type addon_running, operation_conflict or busy",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Unavailable, or outcome_unknown (with operationId)",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/{id}/recovery": {
|
||
"get": {
|
||
"description": "Administrators only. Returns the recovery state of the add-on's data (ready, upgrading, restoring, needs-recovery or purging) with its reason, the backups newest first with their size, creation time, reason (manual, upgrade or restore), the ownership mode and package version they hold and the last recorded verification result (verified, failed or unverified), the backup that is the recovery copy, the receipt and warnings of the last restore, the retention policy, the number of data copies a restore set aside and the operation IDs whose result is recorded. Read-only. No MCP tool maps to this route.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Read the data recovery state and the backups of an add-on (administrators)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Add-on ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Recovery state",
|
||
"schema": {
|
||
"$ref": "#/definitions/recovery.Status"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature or administration denied",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/{id}/recovery/backup": {
|
||
"post": {
|
||
"description": "Administrators only, from their own browser session (same-origin fetch, X-LocalAI-Confirm equal to the operationId). Blocks new admission for the add-on's resources, invalidates its pending proposals, drains admitted work, stops the add-on, makes a consistent copy of its data (every SQLite file with VACUUM INTO, so the write-ahead log is part of it) together with the owner's access state, verifies the copy, publishes it atomically with restricted permissions and starts the add-on again if it was meant to run. A backup that cannot be completed leaves nothing behind. Repeating the operationId returns the same backup. 503 insufficient_storage means the free space did not fit the backup and nothing was changed. No MCP tool maps to this route.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Back up the data of an add-on (administrators, browser session)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Add-on ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Operation",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.RecoveryBackupRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The verified backup",
|
||
"schema": {
|
||
"$ref": "#/definitions/recovery.BackupReceipt"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed request",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature, administration or browser session denied",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Type not_installed",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "Type busy",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Unavailable, insufficient_storage, or outcome_unknown (with operationId)",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/{id}/recovery/delete-backup": {
|
||
"post": {
|
||
"description": "Administrators only, from their own browser session. The only verified copy and the recovery copy of an upgrade are never removed this way (409 sole_recovery_copy); a purge with explicit scope removes them. No MCP tool maps to this route.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Delete one backup of an add-on (administrators, browser session)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Add-on ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Operation and backup",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.RecoveryDeleteBackupRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The deleted backup",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.RecoveryDeleted"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed request",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature, administration or browser session denied",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Type backup_not_found",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "Type sole_recovery_copy or busy",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Unavailable, or outcome_unknown (with operationId)",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/{id}/recovery/prune": {
|
||
"post": {
|
||
"description": "Administrators only, from their own browser session. Removes the backups the configured count and age policy no longer keeps. The newest verified backup and the recovery copy of an upgrade stay, whatever their age. No MCP tool maps to this route.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Apply the backup retention policy now (administrators, browser session)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Add-on ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Operation",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.RecoveryPruneRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The removed backups",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.RecoveryPruned"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed request",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature, administration or browser session denied",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "Type busy",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Unavailable, or outcome_unknown (with operationId)",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/{id}/recovery/restore": {
|
||
"post": {
|
||
"description": "Administrators only, from their own browser session, with the add-on ID typed as confirm. The add-on must not be running. The backup is verified before anything changes, its files are staged and swapped in atomically, and the data they replace stays as a recovery copy until it is purged. Access is not restored as it was: every grant is checked again against the current accounts and the lowerings of access recorded since the backup, so nobody gets back access that was taken away; pending proposals are cancelled and operations with an unknown outcome are looked up by receipt and never applied again. The answer carries warnings: the time the data goes back to, the number of changes made after it that are lost, and the shares that were not restored. A backup made in local-owner mode needs mapping {\"local-owner\": \"\u003caccount id\u003e\"}; a backup of named-user data is refused in local-owner mode. Repeating the operationId returns the same receipt and does not restore again. No MCP tool maps to this route. The backup must belong to the add-on in the path; a backup of another add-on is refused with type invalid_request and nothing is touched.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Restore a backup of an add-on (administrators, browser session)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Add-on ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Operation, backup, mapping and confirmation",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.RecoveryRestoreRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "What was restored, with warnings",
|
||
"schema": {
|
||
"$ref": "#/definitions/recovery.RestoreReceipt"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed request, type confirmation_mismatch or mapping_invalid",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature, administration or browser session denied",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Type backup_not_found",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "Type addon_running, backup_corrupt, incompatible_format, identity_changed, mapping_required, downgrade_unsupported, operation_conflict or busy",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Unavailable, or outcome_unknown (with operationId)",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/{id}/recovery/verify": {
|
||
"post": {
|
||
"description": "Administrators only, from their own browser session. Reads every file of the backup against its manifest digests and runs the SQLite integrity check, and records the result shown in the list. A failed backup stays in place; removing it is a separate explicit action. No MCP tool maps to this route.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Verify a backup of an add-on (administrators, browser session)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Add-on ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Operation and backup",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.RecoveryVerifyRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "The verified backup",
|
||
"schema": {
|
||
"$ref": "#/definitions/recovery.BackupReceipt"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed request",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature, administration or browser session denied",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Type backup_not_found",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "Type backup_corrupt",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Unavailable, or outcome_unknown (with operationId)",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/{id}/update": {
|
||
"get": {
|
||
"description": "Returns the owner's update check for an installed add-on, for every authenticated caller who holds the addons feature and may see the add-on (an administrator any installed add-on, others only an enabled one; anything else is the same 403). The status is computed by the owner from the library the add-on was installed from and never from the browser: state is unknown, up-to-date, update-available, incompatible (with reasons: platform, host-version, api-version, protocol-version, sdk-version or data-format), check-failed (with a redacted error class and the time the library was last read) or integrity-error. A failed check is never up-to-date. A moving channel (development, a branch, latest) compares resolved digests, so a changed digest with the same version label is an update; an immutable version selects only a greater compatible version of the same major. The library and channel never change by themselves. The route never uses the network and never applies anything. Callers who are not administrators get the state, versions and times only, without library, channel or digests. No MCP tool maps to this route.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Read the update status of an addon",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Add-on ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Update status",
|
||
"schema": {
|
||
"$ref": "#/definitions/updates.Status"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature denied, or the add-on is unknown or hidden",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/{id}/update/check": {
|
||
"post": {
|
||
"description": "Administrators only, from their own browser session (same-origin fetch, X-LocalAI-Confirm equal to the operationId). The owner fetches the library the add-on was installed from again, through the credential reference the library is configured with, and answers with the new update status. It is rate limited per add-on and per library: within the interval the last status is returned with throttled true. It applies nothing; an upgrade is a separate explicit request. No MCP tool maps to this route.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Check an addon for updates now (administrators, browser session)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Add-on ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Operation",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.UpdateCheckRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Update status",
|
||
"schema": {
|
||
"$ref": "#/definitions/updates.Status"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed request",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature, administration or browser session denied",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Addons or the owner are unavailable",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/addons/{id}/upgrade": {
|
||
"post": {
|
||
"description": "Administrators only, from their own browser session (same-origin fetch, X-LocalAI-Confirm equal to the operationId). The only action that applies an update. It carries the digest of the installed package the caller saw (expectedDigest) and the digest of the candidate the check resolved (candidateDigest). The owner re-resolves the library the add-on came from and refuses, before it records anything, an installed package that is not the expected one (409 stale_installed), a candidate that is not the one it resolves now (409 candidate_changed), an incompatible candidate (409 incompatible), a rewritten immutable version (409 integrity_error) and the same transition under another operation ID (409 upgrade_conflict). It never changes the library or the channel. The upgrade then follows the lifecycle of an add-on: the candidate is staged and verified, the data is backed up and migrated when the add-on has any, and the new generation is published only when it starts. A failure or cancellation keeps the last good generation or leaves an explicit recovery state; the previous installation is never deleted. Repeating the operationId returns the recorded result and never runs again; after outcome_unknown read operation-status with the same operationId. No MCP tool maps to this route.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"Addons"
|
||
],
|
||
"summary": "Upgrade an addon to the candidate that was checked (administrators, browser session)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Add-on ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Operation and the pinned digests",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.UpgradeRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Operation accepted; the payload is the operation status",
|
||
"schema": {
|
||
"$ref": "#/definitions/contract.Result"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Malformed request",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Named authentication required",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Feature, administration or browser session denied",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "Type stale_installed, candidate_changed, incompatible, integrity_error, upgrade_conflict, upgrade_failed or operation_conflict",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Unavailable, check_failed, or outcome_unknown (with operationId)",
|
||
"schema": {
|
||
"$ref": "#/definitions/addons.AddonErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/agent/jobs": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"agent-jobs"
|
||
],
|
||
"summary": "List agent jobs",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Filter by task ID",
|
||
"name": "task_id",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Filter by status (pending, running, completed, failed, cancelled)",
|
||
"name": "status",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"description": "Max number of jobs to return",
|
||
"name": "limit",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Set to 'true' for admin cross-user listing",
|
||
"name": "all_users",
|
||
"in": "query"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "jobs",
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.Job"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/agent/jobs/execute": {
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"agent-jobs"
|
||
],
|
||
"summary": "Execute an agent job",
|
||
"parameters": [
|
||
{
|
||
"description": "Job execution request",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.JobExecutionRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"201": {
|
||
"description": "job created",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.JobExecutionResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "error",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/agent/jobs/{id}": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"agent-jobs"
|
||
],
|
||
"summary": "Get an agent job",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Job ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "job",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.Job"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "error",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"agent-jobs"
|
||
],
|
||
"summary": "Delete an agent job",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Job ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "message",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "error",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/agent/jobs/{id}/cancel": {
|
||
"post": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"agent-jobs"
|
||
],
|
||
"summary": "Cancel an agent job",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Job ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "message",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "error",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "error",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/agent/tasks": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"agent-jobs"
|
||
],
|
||
"summary": "List agent tasks",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Set to 'true' for admin cross-user listing",
|
||
"name": "all_users",
|
||
"in": "query"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "tasks",
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.Task"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"agent-jobs"
|
||
],
|
||
"summary": "Create a new agent task",
|
||
"parameters": [
|
||
{
|
||
"description": "Task definition",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.Task"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"201": {
|
||
"description": "id",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "error",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/agent/tasks/{id}": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"agent-jobs"
|
||
],
|
||
"summary": "Get an agent task",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Task ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "task",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.Task"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "error",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"put": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"agent-jobs"
|
||
],
|
||
"summary": "Update an agent task",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Task ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Updated task definition",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.Task"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "message",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "error",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "error",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"agent-jobs"
|
||
],
|
||
"summary": "Delete an agent task",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Task ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "message",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "error",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/agent/tasks/{name}/execute": {
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"agent-jobs"
|
||
],
|
||
"summary": "Execute an agent task by name",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Task name",
|
||
"name": "name",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Optional template parameters",
|
||
"name": "parameters",
|
||
"in": "body",
|
||
"schema": {
|
||
"type": "object"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"201": {
|
||
"description": "job created",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.JobExecutionResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "error",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "error",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/aliases": {
|
||
"get": {
|
||
"tags": [
|
||
"models"
|
||
],
|
||
"summary": "List model aliases",
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/localai.AliasInfo"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/backend-logs": {
|
||
"get": {
|
||
"description": "Returns a sorted list of model IDs that have captured backend process output",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"monitoring"
|
||
],
|
||
"summary": "List models with backend logs",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Model IDs with logs",
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/backend-logs/{modelId}": {
|
||
"get": {
|
||
"description": "Returns all captured log lines (stdout/stderr) for the specified model's backend process",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"monitoring"
|
||
],
|
||
"summary": "Get backend logs for a model",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Model ID",
|
||
"name": "modelId",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Log lines",
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/model.BackendLogLine"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/backend-logs/{modelId}/clear": {
|
||
"post": {
|
||
"description": "Removes all captured log lines for the specified model's backend process",
|
||
"tags": [
|
||
"monitoring"
|
||
],
|
||
"summary": "Clear backend logs for a model",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Model ID",
|
||
"name": "modelId",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "Logs cleared"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/backend-traces": {
|
||
"get": {
|
||
"description": "Returns a bounded, newest-first page of captured backend traces (LLM calls, embeddings, TTS, etc). The heavy body and data fields are omitted unless full=true; fetch them per-trace from /api/backend-traces/{id}. Paging metadata is returned in the X-Total-Count, X-Trace-Offset and X-Trace-Limit headers.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"monitoring"
|
||
],
|
||
"summary": "List backend operation traces",
|
||
"parameters": [
|
||
{
|
||
"type": "integer",
|
||
"description": "Maximum entries to return (default 50, max 1000, 0 for all)",
|
||
"name": "limit",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"description": "Number of entries to skip (default 0)",
|
||
"name": "offset",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "boolean",
|
||
"description": "Include the body and data payloads (default false)",
|
||
"name": "full",
|
||
"in": "query"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Backend operation traces",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/backend-traces/clear": {
|
||
"post": {
|
||
"description": "Removes all captured backend operation traces from the buffer",
|
||
"tags": [
|
||
"monitoring"
|
||
],
|
||
"summary": "Clear backend traces",
|
||
"responses": {
|
||
"204": {
|
||
"description": "Traces cleared"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/backend-traces/{id}": {
|
||
"get": {
|
||
"description": "Returns a single captured backend trace, including the body and data payloads omitted from the list response",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"monitoring"
|
||
],
|
||
"summary": "Get one backend operation trace",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Trace ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Backend operation trace",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Trace not found",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/branding": {
|
||
"get": {
|
||
"description": "Returns the configured instance name, tagline, and asset URLs. Public — no authentication required.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"branding"
|
||
],
|
||
"summary": "Get instance branding",
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.BrandingResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/branding/asset/{kind}": {
|
||
"post": {
|
||
"description": "Upload a custom logo, horizontal logo, or favicon. The file replaces any previous override for that kind.",
|
||
"consumes": [
|
||
"multipart/form-data"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"branding"
|
||
],
|
||
"summary": "Upload a branding asset",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Asset kind: logo, logo_horizontal, or favicon",
|
||
"name": "kind",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "file",
|
||
"description": "Image file (png, jpeg, svg, webp, ico — up to 5MiB)",
|
||
"name": "file",
|
||
"in": "formData",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.BrandingResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"description": "Remove a custom branding asset; the UI falls back to the bundled LocalAI default.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"branding"
|
||
],
|
||
"summary": "Reset a branding asset to default",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Asset kind: logo, logo_horizontal, or favicon",
|
||
"name": "kind",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.BrandingResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/conversations": {
|
||
"get": {
|
||
"description": "Returns the live conversations, newest first, and in ` + "`" + `deleted` + "`" + ` the conversations the user deleted. A client must drop any local copy whose id appears in ` + "`" + `deleted` + "`" + ` instead of uploading it again.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"chat-history"
|
||
],
|
||
"summary": "List chat conversations",
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ConversationList"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"post": {
|
||
"description": "Stores the conversation and returns it with its new server-assigned ` + "`" + `version` + "`" + `. ` + "`" + `createdAt` + "`" + `/` + "`" + `updatedAt` + "`" + ` are kept as sent (Unix ms). Writing a conversation the user deleted returns 410 and does not bring it back.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"chat-history"
|
||
],
|
||
"summary": "Save a chat conversation (upsert)",
|
||
"parameters": [
|
||
{
|
||
"description": "Conversation payload",
|
||
"name": "body",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.Conversation"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.Conversation"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid id or body",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"410": {
|
||
"description": "Deleted",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"chat-history"
|
||
],
|
||
"summary": "Delete all chat conversations for the current user",
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/conversations/bulk": {
|
||
"put": {
|
||
"description": "Upserts every conversation in the payload and deletes the user's other live conversations. Ids the user deleted earlier are not written and are listed in ` + "`" + `skipped` + "`" + `.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"chat-history"
|
||
],
|
||
"summary": "Replace all chat conversations",
|
||
"parameters": [
|
||
{
|
||
"description": "Conversations",
|
||
"name": "body",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ConversationBulkRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ConversationBulkResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid id or body",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/conversations/{id}": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"chat-history"
|
||
],
|
||
"summary": "Get a chat conversation",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Conversation ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.Conversation"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Never existed",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"410": {
|
||
"description": "Deleted",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"put": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"chat-history"
|
||
],
|
||
"summary": "Save a chat conversation by id (upsert)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Conversation ID (overrides the body id)",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Conversation payload",
|
||
"name": "body",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.Conversation"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.Conversation"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid id or body",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"410": {
|
||
"description": "Deleted",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"description": "Deletes the conversation and keeps a tombstone so no client can write it back. Deleting an unknown or already deleted id succeeds.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"chat-history"
|
||
],
|
||
"summary": "Delete a chat conversation",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Conversation ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Invalid id",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/failover": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"failover"
|
||
],
|
||
"summary": "List failover chains and the health of their targets",
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.FailoverChainsResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/failover/events": {
|
||
"get": {
|
||
"description": "The first event is \"snapshot\" with the full state, then \"chain.switched\" and \"target.state\" events.",
|
||
"produces": [
|
||
"text/event-stream"
|
||
],
|
||
"tags": [
|
||
"failover"
|
||
],
|
||
"summary": "Stream failover events (server-sent events)",
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/failover/{chain}": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"failover"
|
||
],
|
||
"summary": "Get one failover chain",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Chain name",
|
||
"name": "chain",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/failover.ChainStatus"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Not Found",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/failover/{chain}/pin": {
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"failover"
|
||
],
|
||
"summary": "Pin a failover chain to one target",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Chain name",
|
||
"name": "chain",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Target to pin",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.FailoverPinRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/failover.ChainStatus"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Not Found",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"failover"
|
||
],
|
||
"summary": "Remove the pin from a failover chain",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Chain name",
|
||
"name": "chain",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/failover.ChainStatus"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Not Found",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/instructions": {
|
||
"get": {
|
||
"description": "Returns a compact list of instruction areas with descriptions and URLs for detailed guides",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"instructions"
|
||
],
|
||
"summary": "List available API instruction areas",
|
||
"responses": {
|
||
"200": {
|
||
"description": "instructions list with hint",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/instructions/{name}": {
|
||
"get": {
|
||
"description": "Returns a markdown guide (default) or filtered OpenAPI fragment (format=json) for a named instruction",
|
||
"produces": [
|
||
"application/json",
|
||
"text/markdown"
|
||
],
|
||
"tags": [
|
||
"instructions"
|
||
],
|
||
"summary": "Get an instruction's API guide or OpenAPI fragment",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Instruction name (e.g. chat-inference, config-management)",
|
||
"name": "name",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Response format: json for OpenAPI fragment, omit for markdown",
|
||
"name": "format",
|
||
"in": "query"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "instruction documentation",
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.APIInstructionResponse"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "instruction not found",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/library/sources": {
|
||
"get": {
|
||
"description": "Every library source of the add-on, backend and model kinds, with its state: kind, id, name, url, enabled (what the host does with it), default (shipped), removed (a default the user removed; a tombstone), suspended (a default while the official libraries are off), the conflict message when it clashes with another source, and the last fetch state when there is one. Administrators only.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"library"
|
||
],
|
||
"summary": "List the library sources",
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.LibrarySourcesResponse"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"post": {
|
||
"description": "Adds a source of your own. kind is addon, backend or model; format is library (default) or gallery. The id is derived from the name or URL when it is empty. A source with the same kind and URL is refused (409), as is a taken id. Administrators only.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"library"
|
||
],
|
||
"summary": "Add a library source",
|
||
"responses": {
|
||
"201": {
|
||
"description": "Created",
|
||
"schema": {
|
||
"$ref": "#/definitions/library.Info"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/library/sources/{id}": {
|
||
"delete": {
|
||
"description": "A source of your own is deleted. A shipped default is not: it stays as a tombstone (removed true), so it does not come back at the next start; enabling it brings it back. Administrators only.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"library"
|
||
],
|
||
"summary": "Remove a library source",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Source id",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/library/sources/{id}/disable": {
|
||
"post": {
|
||
"description": "Enabling a removed default brings it back. Administrators only.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"library"
|
||
],
|
||
"summary": "Turn a library source on or off",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Source id",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/library.Info"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/library/sources/{id}/enable": {
|
||
"post": {
|
||
"description": "Enabling a removed default brings it back. Administrators only.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"library"
|
||
],
|
||
"summary": "Turn a library source on or off",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Source id",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/library.Info"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/models/config-json/{name}": {
|
||
"patch": {
|
||
"description": "Deep-merges the JSON patch body into the existing model config",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"config"
|
||
],
|
||
"summary": "Partially update a model configuration",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Model name",
|
||
"name": "name",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "success message",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/models/config-metadata": {
|
||
"get": {
|
||
"description": "Returns config field metadata. Use ?section=\u003cid\u003e to filter by section, or omit for a section index.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"config"
|
||
],
|
||
"summary": "List model configuration field metadata",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Section ID to filter (e.g. 'general', 'llm', 'parameters') or 'all' for everything",
|
||
"name": "section",
|
||
"in": "query"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Section index or filtered field metadata",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/models/config-metadata/autocomplete/{provider}": {
|
||
"get": {
|
||
"description": "Returns runtime-resolved values for dynamic providers (backends, models)",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"config"
|
||
],
|
||
"summary": "Get dynamic autocomplete values for a config field",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Provider name (backends, models, models:chat, models:tts, models:transcript, models:vad)",
|
||
"name": "provider",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "values array",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/models/storage": {
|
||
"get": {
|
||
"description": "Per-model disk usage, shared-file relations and missing references under the models path",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"models"
|
||
],
|
||
"summary": "Report model storage usage on disk",
|
||
"responses": {
|
||
"200": {
|
||
"description": "storage report",
|
||
"schema": {
|
||
"$ref": "#/definitions/gallery.StorageIndex"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/models/toggle-pinned/{name}/{action}": {
|
||
"put": {
|
||
"description": "Pin or unpin a model. Pinned models stay loaded and are excluded from automatic eviction.",
|
||
"tags": [
|
||
"config"
|
||
],
|
||
"summary": "Toggle model pinned status",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Model name",
|
||
"name": "name",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Action: 'pin' or 'unpin'",
|
||
"name": "action",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.ModelResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.ModelResponse"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Not Found",
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.ModelResponse"
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error",
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.ModelResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/models/vram-estimate": {
|
||
"post": {
|
||
"description": "Estimates VRAM based on model weight files at multiple context sizes",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"config"
|
||
],
|
||
"summary": "Estimate VRAM usage for a model",
|
||
"parameters": [
|
||
{
|
||
"description": "VRAM estimation parameters",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/modeladmin.VRAMRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "VRAM estimate",
|
||
"schema": {
|
||
"$ref": "#/definitions/modeladmin.VRAMResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/models/{id}/load-cancel": {
|
||
"post": {
|
||
"description": "Cancels the load attempt named by ` + "`" + `job_id` + "`" + ` and stops its remote work. 200 means the attempt is gone or the worker confirmed the stop. 202 means the cancel is recorded and the stop is pending; the model is released after ` + "`" + `retry_after` + "`" + ` seconds regardless. 409 means a different attempt is current and carries its ` + "`" + `current_job_id` + "`" + `. Repeating the call is safe and does not extend the hold.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"models"
|
||
],
|
||
"summary": "Cancel one distributed model load.",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Model ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "The exact attempt to cancel",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ModelLoadCancelRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Stopped, or no such load any more",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ModelLoadCancelResponse"
|
||
}
|
||
},
|
||
"202": {
|
||
"description": "Cancel recorded; stop pending",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ModelLoadCancelResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "Unauthorized",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Forbidden",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Unknown model",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "A different attempt is current",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ModelLoadCancelResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/models/{id}/load-status": {
|
||
"get": {
|
||
"description": "Returns the live state of a distributed cold load: job id, phase, node, byte progress, ETA, lease freshness, and for a failed attempt the cause, whether the stop is pending and when the model is released. 404 means no load exists for the model. A database error is 503, never an empty answer. This is the same ` + "`" + `loading` + "`" + ` object the 503 response carries while a model is still staging.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"models"
|
||
],
|
||
"summary": "Report the progress of an in-flight model load.",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Model ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Live load progress",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ModelLoadingStatus"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "No load is running for this model",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "The job table could not be read",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/models/{name}/{action}": {
|
||
"put": {
|
||
"description": "Enable or disable a model from being loaded on demand. Disabled models remain installed but cannot be loaded.",
|
||
"tags": [
|
||
"config"
|
||
],
|
||
"summary": "Toggle model enabled/disabled status",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Model name",
|
||
"name": "name",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Action: 'enable' or 'disable'",
|
||
"name": "action",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.ModelResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.ModelResponse"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Not Found",
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.ModelResponse"
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error",
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.ModelResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/motion/sessions": {
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"motion"
|
||
],
|
||
"summary": "Create a motion capture session",
|
||
"parameters": [
|
||
{
|
||
"description": "Model, output profile and source clock origin",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.MotionSessionRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"201": {
|
||
"description": "Created",
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.MotionSessionInfo"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/motion/sessions/{id}": {
|
||
"get": {
|
||
"tags": [
|
||
"motion"
|
||
],
|
||
"summary": "Get motion session status",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Session ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.MotionSessionInfo"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"tags": [
|
||
"motion"
|
||
],
|
||
"summary": "Close a motion session",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Session ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "No Content"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/motion/sessions/{id}/poses": {
|
||
"get": {
|
||
"tags": [
|
||
"motion"
|
||
],
|
||
"summary": "Stream motion frames and poses over a duplex WebSocket",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Session ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"101": {
|
||
"description": "Switching Protocols"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/motion/sessions/{id}/tickets": {
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"motion"
|
||
],
|
||
"summary": "Issue a motion WebSocket ticket (30 seconds, single use)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Session ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "Browser origin",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.MotionTicketRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"201": {
|
||
"description": "Created",
|
||
"schema": {
|
||
"$ref": "#/definitions/auth.WebSocketTicketResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/nodes/models": {
|
||
"get": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "List all loaded models cluster-wide",
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/nodes.NodeModel"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/nodes/{id}/max-replicas-per-model": {
|
||
"put": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "Update a node's max replicas per model",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Node ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "New value",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.UpdateMaxReplicasPerModelRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "value must be \u003e= 1",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "node not found",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "Reset a node's max replicas per model to the worker default",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Node ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "node not found",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/nodes/{id}/vram-budget": {
|
||
"put": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "Update a node's VRAM allocation budget",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Node ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "New value (\\",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.UpdateVRAMBudgetRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "invalid budget",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "node not found",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"tags": [
|
||
"Nodes"
|
||
],
|
||
"summary": "Reset a node's VRAM budget to the worker default",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Node ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "node not found",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/p2p": {
|
||
"get": {
|
||
"tags": [
|
||
"p2p"
|
||
],
|
||
"summary": "Returns available P2P nodes",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.P2PNodesResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/p2p/token": {
|
||
"get": {
|
||
"tags": [
|
||
"p2p"
|
||
],
|
||
"summary": "Show the P2P token",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/pii/analyze": {
|
||
"post": {
|
||
"description": "Runs the configured PII detectors (NER and/or pattern tiers) over the supplied text and returns the matched entity spans with the policy action that would fire. Detection only — the text is not modified and no block is enforced. Select detectors explicitly via ` + "`" + `detectors` + "`" + `, or pass a consuming ` + "`" + `model` + "`" + ` to use its effective policy: the model's own ` + "`" + `pii.detectors` + "`" + `, else the instance-wide ` + "`" + `pii_default_detectors` + "`" + `. A model with PII disabled, or enabled with nothing to scan with, is a 400. The raw matched value is never returned; admins may set ` + "`" + `reveal:true` + "`" + ` for the audit hash prefix.",
|
||
"tags": [
|
||
"pii"
|
||
],
|
||
"summary": "Detect PII entities in a string (no mutation).",
|
||
"parameters": [
|
||
{
|
||
"description": "text + detector selection",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.PIIAnalyzeRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Detected entities",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.PIIAnalyzeResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/pii/redact": {
|
||
"post": {
|
||
"description": "Runs the configured PII detectors over the text and applies each detector model's policy: masked spans are replaced with ` + "`" + `[REDACTED:\u003cid\u003e]` + "`" + `, allow spans pass through, and a single block action causes a 400 (type ` + "`" + `pii_blocked` + "`" + `) carrying the offending entities — the text is never returned in that case. Select detectors via ` + "`" + `detectors` + "`" + `, or a consuming ` + "`" + `model` + "`" + `'s effective policy (its own ` + "`" + `pii.detectors` + "`" + `, else the instance-wide ` + "`" + `pii_default_detectors` + "`" + `; PII must be enabled on the model). Records audit events (origin ` + "`" + `pii_redact` + "`" + `) visible at /api/pii/events.",
|
||
"tags": [
|
||
"pii"
|
||
],
|
||
"summary": "Redact PII in a string by applying the configured policy.",
|
||
"parameters": [
|
||
{
|
||
"description": "text + detector selection",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.PIIAnalyzeRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Redacted text + entities",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.PIIRedactResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/router/decide": {
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"router"
|
||
],
|
||
"summary": "Classify a prompt against a router model's policies (decision oracle)",
|
||
"parameters": [
|
||
{
|
||
"description": "decide params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.RouterDecideRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.RouterDecideResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Not Found",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"503": {
|
||
"description": "Service Unavailable",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/router/{name}/corpus": {
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"router"
|
||
],
|
||
"summary": "Seed the KNN routing corpus with labelled example prompts",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "router model name",
|
||
"name": "name",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "labelled exemplars",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.RouterCorpusAddRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.RouterCorpusAddResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Not Found",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"router"
|
||
],
|
||
"summary": "Clear a router's KNN corpus",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "router model name",
|
||
"name": "name",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.RouterCorpusClearResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Not Found",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/router/{name}/corpus/stats": {
|
||
"get": {
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"router"
|
||
],
|
||
"summary": "Inspect a router's KNN corpus (label counts only, never texts)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "router model name",
|
||
"name": "name",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.RouterCorpusStatsResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Not Found",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/traces": {
|
||
"get": {
|
||
"description": "Returns a bounded, newest-first page of captured API exchange traces. Request and response bodies plus headers are omitted unless full=true; fetch them per-trace from /api/traces/{id}. Paging metadata is returned in the X-Total-Count, X-Trace-Offset and X-Trace-Limit headers.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"monitoring"
|
||
],
|
||
"summary": "List API request/response traces",
|
||
"parameters": [
|
||
{
|
||
"type": "integer",
|
||
"description": "Maximum entries to return (default 50, max 1000, 0 for all)",
|
||
"name": "limit",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"description": "Number of entries to skip (default 0)",
|
||
"name": "offset",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "boolean",
|
||
"description": "Include request/response bodies and headers (default false)",
|
||
"name": "full",
|
||
"in": "query"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Traced API exchanges",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/traces/clear": {
|
||
"post": {
|
||
"description": "Removes all captured API request/response traces from the buffer",
|
||
"tags": [
|
||
"monitoring"
|
||
],
|
||
"summary": "Clear API traces",
|
||
"responses": {
|
||
"204": {
|
||
"description": "Traces cleared"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/traces/summary": {
|
||
"get": {
|
||
"description": "Returns request, failure and latency totals over a recent window, plus a bucketed series for sparklines. Exists so callers wanting three numbers do not have to fetch the whole trace list and count it themselves.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"monitoring"
|
||
],
|
||
"summary": "Summarize recent API traces",
|
||
"parameters": [
|
||
{
|
||
"type": "integer",
|
||
"description": "Window in hours (default 24, max 168)",
|
||
"name": "hours",
|
||
"in": "query"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Counted trace totals",
|
||
"schema": {
|
||
"$ref": "#/definitions/middleware.TraceSummary"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/traces/{id}": {
|
||
"get": {
|
||
"description": "Returns a single captured API exchange, including the request and response bodies omitted from the list response",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"monitoring"
|
||
],
|
||
"summary": "Get one API trace",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Trace ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Traced API exchange",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Trace not found",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/voice-profiles": {
|
||
"get": {
|
||
"description": "List saved voice-cloning references without exposing filesystem paths.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"audio",
|
||
"voice-profiles"
|
||
],
|
||
"summary": "List voice profiles",
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.VoiceProfileListResponse"
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"post": {
|
||
"description": "Save a consent-confirmed PCM WAV reference clip and exact transcript for voice cloning. Admin-only.",
|
||
"consumes": [
|
||
"multipart/form-data",
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"audio",
|
||
"voice-profiles"
|
||
],
|
||
"summary": "Create a voice profile",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Display name",
|
||
"name": "name",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Optional description",
|
||
"name": "description",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Optional language tag",
|
||
"name": "language",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Exact transcript of the reference clip",
|
||
"name": "transcript",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "boolean",
|
||
"description": "Confirms authorization to clone the voice",
|
||
"name": "consent_confirmed",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "file",
|
||
"description": "16-bit PCM WAV, preferably mono 24 kHz, 1-120 seconds, up to 50 MiB",
|
||
"name": "audio",
|
||
"in": "formData",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"201": {
|
||
"description": "Created",
|
||
"schema": {
|
||
"$ref": "#/definitions/voiceprofile.Profile"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
},
|
||
"413": {
|
||
"description": "Request Entity Too Large",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/voice-profiles/{id}": {
|
||
"delete": {
|
||
"description": "Permanently remove a saved voice-cloning profile. Admin-only.",
|
||
"tags": [
|
||
"audio",
|
||
"voice-profiles"
|
||
],
|
||
"summary": "Delete a voice profile",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Voice profile UUID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "No Content"
|
||
},
|
||
"404": {
|
||
"description": "Not Found",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/voice-profiles/{id}/audio": {
|
||
"get": {
|
||
"description": "Stream the saved reference WAV for an authenticated TTS user.",
|
||
"produces": [
|
||
"audio/x-wav"
|
||
],
|
||
"tags": [
|
||
"audio",
|
||
"voice-profiles"
|
||
],
|
||
"summary": "Preview voice profile audio",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Voice profile UUID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Not Found",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/audio/transform": {
|
||
"post": {
|
||
"description": "Runs an audio-in / audio-out transform conditioned on an optional auxiliary reference signal. Concrete transforms include AEC + noise suppression + dereverberation (LocalVQE), voice conversion (reference = target speaker), and pitch shifting. The backend determines the operation; pass model-specific tuning via repeated ` + "`" + `params[\u003ckey\u003e]=\u003cvalue\u003e` + "`" + ` form fields.",
|
||
"consumes": [
|
||
"multipart/form-data"
|
||
],
|
||
"produces": [
|
||
"audio/x-wav"
|
||
],
|
||
"tags": [
|
||
"audio"
|
||
],
|
||
"summary": "Transform audio (echo cancellation, noise suppression, voice conversion, etc.)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "model",
|
||
"name": "model",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "file",
|
||
"description": "primary input audio file",
|
||
"name": "audio",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "file",
|
||
"description": "auxiliary reference audio (loopback for AEC, target voice for conversion, etc.)",
|
||
"name": "reference",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "wav | mp3 | ogg | flac",
|
||
"name": "response_format",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"description": "desired output sample rate in Hz; omit for the backend's own rate, otherwise 8000-192000",
|
||
"name": "sample_rate",
|
||
"in": "formData"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "transformed audio file",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/audio/transformations": {
|
||
"post": {
|
||
"description": "Runs an audio-in / audio-out transform conditioned on an optional auxiliary reference signal. Concrete transforms include AEC + noise suppression + dereverberation (LocalVQE), voice conversion (reference = target speaker), and pitch shifting. The backend determines the operation; pass model-specific tuning via repeated ` + "`" + `params[\u003ckey\u003e]=\u003cvalue\u003e` + "`" + ` form fields.",
|
||
"consumes": [
|
||
"multipart/form-data"
|
||
],
|
||
"produces": [
|
||
"audio/x-wav"
|
||
],
|
||
"tags": [
|
||
"audio"
|
||
],
|
||
"summary": "Transform audio (echo cancellation, noise suppression, voice conversion, etc.)",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "model",
|
||
"name": "model",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "file",
|
||
"description": "primary input audio file",
|
||
"name": "audio",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "file",
|
||
"description": "auxiliary reference audio (loopback for AEC, target voice for conversion, etc.)",
|
||
"name": "reference",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "wav | mp3 | ogg | flac",
|
||
"name": "response_format",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"description": "desired output sample rate in Hz; omit for the backend's own rate, otherwise 8000-192000",
|
||
"name": "sample_rate",
|
||
"in": "formData"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "transformed audio file",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/audio/transformations/stream": {
|
||
"get": {
|
||
"description": "Streams binary PCM frames in (interleaved stereo: ch0=audio, ch1=reference) and out (mono). The model must support the audio_transform use case. Any-to-any models such as liquid-audio use the OpenAI Realtime API instead. The first message must be a JSON ` + "`" + `session.update` + "`" + ` envelope describing model + sample format + frame size + backend params. Server emits binary PCM on the same cadence.",
|
||
"tags": [
|
||
"audio"
|
||
],
|
||
"summary": "Bidirectional realtime audio transform over WebSocket.",
|
||
"responses": {}
|
||
}
|
||
},
|
||
"/backend/load": {
|
||
"post": {
|
||
"description": "Loads the named model (or, for a realtime pipeline, all of its sub-models) into memory so subsequent requests pay no cold-start cost. The inverse of /backend/shutdown.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"monitoring"
|
||
],
|
||
"summary": "Pre-load a model into memory",
|
||
"parameters": [
|
||
{
|
||
"description": "Model to load",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ModelLoadRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Model loaded",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ModelLoadResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Missing model name",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ModelLoadResponse"
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Load failed (Loaded lists any sub-models that did load)",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ModelLoadResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/backend/monitor": {
|
||
"get": {
|
||
"tags": [
|
||
"monitoring"
|
||
],
|
||
"summary": "Backend monitor endpoint",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Name of the model to monitor",
|
||
"name": "model",
|
||
"in": "query",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/proto.StatusResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/backend/shutdown": {
|
||
"post": {
|
||
"tags": [
|
||
"monitoring"
|
||
],
|
||
"summary": "Backend shutdown endpoint",
|
||
"parameters": [
|
||
{
|
||
"description": "Backend statistics request",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.BackendMonitorRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {}
|
||
}
|
||
},
|
||
"/backends": {
|
||
"get": {
|
||
"tags": [
|
||
"backends"
|
||
],
|
||
"summary": "List all Backends",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/gallery.GalleryBackend"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/backends/apply": {
|
||
"post": {
|
||
"tags": [
|
||
"backends"
|
||
],
|
||
"summary": "Install backends to LocalAI.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.GalleryBackend"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.BackendResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Backend installation is disabled on this server (code backend_install_disabled)",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "Hardware-specific build in distributed mode (code concrete_backend_requires_target)",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/backends/available": {
|
||
"get": {
|
||
"tags": [
|
||
"backends"
|
||
],
|
||
"summary": "List all available Backends",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/gallery.GalleryBackend"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/backends/delete/{name}": {
|
||
"post": {
|
||
"tags": [
|
||
"backends"
|
||
],
|
||
"summary": "delete backends from LocalAI.",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Backend name",
|
||
"name": "name",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.BackendResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/backends/galleries": {
|
||
"get": {
|
||
"tags": [
|
||
"backends"
|
||
],
|
||
"summary": "List all Galleries",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/config.Gallery"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/backends/jobs": {
|
||
"get": {
|
||
"tags": [
|
||
"backends"
|
||
],
|
||
"summary": "Returns all the jobs status progress",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"$ref": "#/definitions/galleryop.OpStatus"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/backends/jobs/{uuid}": {
|
||
"get": {
|
||
"tags": [
|
||
"backends"
|
||
],
|
||
"summary": "Returns the job status",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/galleryop.OpStatus"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/backends/known": {
|
||
"get": {
|
||
"tags": [
|
||
"backends"
|
||
],
|
||
"summary": "List all known Backends (importer registry + curated pref-only + installed-on-disk)",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.KnownBackend"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/backends/library/install": {
|
||
"post": {
|
||
"tags": [
|
||
"backends"
|
||
],
|
||
"summary": "Install a backend from a library entry on this node.",
|
||
"parameters": [
|
||
{
|
||
"description": "library, backend name and version",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.BackendLibraryInstallRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "the job; read its status at the status URL",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.BackendResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "the request does not name an entry",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "the same backend is already being installed",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/backends/library/updates": {
|
||
"get": {
|
||
"tags": [
|
||
"backends"
|
||
],
|
||
"summary": "List the installed library backends with a newer build in their library.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "updates",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/backendlib.Update"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/backends/upgrade/{name}": {
|
||
"post": {
|
||
"tags": [
|
||
"backends"
|
||
],
|
||
"summary": "Upgrade a backend",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Backend name",
|
||
"name": "name",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.BackendResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Backend installation is disabled on this server (code backend_install_disabled)",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/backends/upgrades": {
|
||
"get": {
|
||
"tags": [
|
||
"backends"
|
||
],
|
||
"summary": "Get available backend upgrades",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"$ref": "#/definitions/gallery.UpgradeInfo"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/backends/upgrades/check": {
|
||
"post": {
|
||
"tags": [
|
||
"backends"
|
||
],
|
||
"summary": "Force backend upgrade check",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"$ref": "#/definitions/gallery.UpgradeInfo"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/branding/asset/{kind}": {
|
||
"get": {
|
||
"description": "Serves the admin-uploaded logo, horizontal logo, or favicon. 404 when no override is set.",
|
||
"produces": [
|
||
"image/*"
|
||
],
|
||
"tags": [
|
||
"branding"
|
||
],
|
||
"summary": "Serve a custom branding asset",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Asset kind: logo, logo_horizontal, or favicon",
|
||
"name": "kind",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK"
|
||
},
|
||
"404": {
|
||
"description": "Not Found"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/metrics": {
|
||
"get": {
|
||
"produces": [
|
||
"text/plain"
|
||
],
|
||
"tags": [
|
||
"monitoring"
|
||
],
|
||
"summary": "Prometheus metrics endpoint",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Prometheus metrics",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/models/apply": {
|
||
"post": {
|
||
"tags": [
|
||
"models"
|
||
],
|
||
"summary": "Install models to LocalAI.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.GalleryModel"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.GalleryResponse"
|
||
}
|
||
},
|
||
"409": {
|
||
"description": "The model's backend is not installed and backend installation is disabled (code backend_not_installed)",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/models/available": {
|
||
"get": {
|
||
"tags": [
|
||
"models"
|
||
],
|
||
"summary": "List installable models.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/gallery.Metadata"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/models/delete/{name}": {
|
||
"post": {
|
||
"tags": [
|
||
"models"
|
||
],
|
||
"summary": "delete models to LocalAI.",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Model name",
|
||
"name": "name",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.GalleryResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/models/galleries": {
|
||
"get": {
|
||
"tags": [
|
||
"models"
|
||
],
|
||
"summary": "List all Galleries",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/config.Gallery"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/models/import": {
|
||
"post": {
|
||
"description": "Writes the posted model configuration. A config referencing\nremote assets (download_files entries, URI-valued model/mmproj)\nis enqueued on the gallery job queue and answered with a job id\nplus status URL to poll, like a gallery install; a config with\nno downloads is written synchronously and answered with a\nplain success response. A queued import runs the gallery\ninstaller, which also adds recommended inference defaults the\nconfig leaves unset and installs the backend when automatic\nbackend installation is enabled; the synchronous path stores\nthe body as posted.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"models"
|
||
],
|
||
"summary": "Import a model from a raw YAML or JSON configuration",
|
||
"parameters": [
|
||
{
|
||
"description": "model configuration (YAML or JSON body)",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"type": "object"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "remote assets present: job id and status URL",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.GalleryResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "invalid or incomplete configuration",
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.ModelResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/models/jobs": {
|
||
"get": {
|
||
"tags": [
|
||
"models"
|
||
],
|
||
"summary": "Returns all the jobs status progress",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"$ref": "#/definitions/galleryop.OpStatus"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/models/jobs/{uuid}": {
|
||
"get": {
|
||
"tags": [
|
||
"models"
|
||
],
|
||
"summary": "Returns the job status",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/galleryop.OpStatus"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/system": {
|
||
"get": {
|
||
"tags": [
|
||
"monitoring"
|
||
],
|
||
"summary": "Show the LocalAI instance information",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.SystemInformationResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/tokenMetrics": {
|
||
"get": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"audio/x-wav"
|
||
],
|
||
"tags": [
|
||
"tokenize"
|
||
],
|
||
"summary": "Get TokenMetrics for Active Slot.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "generated audio/wav file",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/tts": {
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"audio/x-wav"
|
||
],
|
||
"tags": [
|
||
"audio"
|
||
],
|
||
"summary": "Generates audio from the input text.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.TTSRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "generated audio/wav file",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/audio/classification": {
|
||
"post": {
|
||
"consumes": [
|
||
"multipart/form-data"
|
||
],
|
||
"tags": [
|
||
"audio"
|
||
],
|
||
"summary": "Classify sound events in audio (audio tagging).",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "model",
|
||
"name": "model",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "file",
|
||
"description": "audio file",
|
||
"name": "file",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"description": "number of top tags to return (0 = backend default)",
|
||
"name": "top_k",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "number",
|
||
"description": "drop tags scoring below this value",
|
||
"name": "threshold",
|
||
"in": "formData"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.SoundClassificationResult"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/audio/diarization": {
|
||
"post": {
|
||
"description": "JSON accepts model, file (raw base64 audio), include_text, include_speaker_profiles, include_sounds and response_format. Profiles require voice-recognition permission and json or verbose_json; unsupported backends return 501.",
|
||
"consumes": [
|
||
"multipart/form-data",
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"audio"
|
||
],
|
||
"summary": "Identify speakers in audio (who spoke when).",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "model",
|
||
"name": "model",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "file",
|
||
"description": "audio file",
|
||
"name": "file",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"description": "exact speaker count (\u003e0 forces; 0 = auto)",
|
||
"name": "num_speakers",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"description": "lower bound when auto-detecting",
|
||
"name": "min_speakers",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"description": "upper bound when auto-detecting",
|
||
"name": "max_speakers",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "number",
|
||
"description": "clustering distance threshold when num_speakers is unknown",
|
||
"name": "clustering_threshold",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "number",
|
||
"description": "discard segments shorter than this (seconds)",
|
||
"name": "min_duration_on",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "number",
|
||
"description": "merge gaps shorter than this (seconds)",
|
||
"name": "min_duration_off",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "audio language hint (only meaningful for backends that bundle ASR)",
|
||
"name": "language",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "boolean",
|
||
"description": "export portable biometric profiles (voice-recognition permission; JSON formats only)",
|
||
"name": "include_speaker_profiles",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "boolean",
|
||
"description": "include per-segment transcript when the backend supports it",
|
||
"name": "include_text",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "boolean",
|
||
"description": "include closed sound events (start, end, label, confidence) when the model has a sound_model companion; otherwise 501 include_sounds_unsupported (JSON formats only)",
|
||
"name": "include_sounds",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "json (default), verbose_json, or rttm",
|
||
"name": "response_format",
|
||
"in": "formData"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.DiarizationResult"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/audio/speech": {
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"audio/x-wav"
|
||
],
|
||
"tags": [
|
||
"audio"
|
||
],
|
||
"summary": "Generates audio from the input text.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.TTSRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "generated audio/wav file",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/audio/transcriptions": {
|
||
"post": {
|
||
"consumes": [
|
||
"multipart/form-data"
|
||
],
|
||
"tags": [
|
||
"audio"
|
||
],
|
||
"summary": "Transcribes audio into the input language.",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "model",
|
||
"name": "model",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "file",
|
||
"description": "file",
|
||
"name": "file",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "number",
|
||
"description": "sampling temperature",
|
||
"name": "temperature",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
},
|
||
"collectionFormat": "csv",
|
||
"description": "timestamp granularities (word, segment)",
|
||
"name": "timestamp_granularities",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "boolean",
|
||
"description": "stream partial results as SSE",
|
||
"name": "stream",
|
||
"in": "formData"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/audio/voices": {
|
||
"get": {
|
||
"description": "List named voices and their language and gender metadata. Use the optional model query parameter to filter the response.",
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"audio"
|
||
],
|
||
"summary": "List text-to-speech voices",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Installed model name",
|
||
"name": "model",
|
||
"in": "query"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/localai.TTSVoicesResponse"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Not Found",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ErrorResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/chat/completions": {
|
||
"post": {
|
||
"tags": [
|
||
"inference"
|
||
],
|
||
"summary": "Generate a chat completions for a given prompt and model.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.OpenAIRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.OpenAIResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/completions": {
|
||
"post": {
|
||
"tags": [
|
||
"inference"
|
||
],
|
||
"summary": "Generate completions for a given prompt and model.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.OpenAIRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.OpenAIResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/decisions": {
|
||
"post": {
|
||
"description": "Uses the same local decision and NER execution as SystemOne. Supports inline images on capable backends; confidence is not OpenAI calibrated.",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"systemone"
|
||
],
|
||
"summary": "Answer ordered predicate, choice and score questions.",
|
||
"parameters": [
|
||
{
|
||
"description": "input + questions + model",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.DecisionsRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.DecisionsResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/depth": {
|
||
"post": {
|
||
"tags": [
|
||
"depth"
|
||
],
|
||
"summary": "Estimates per-pixel depth (and optionally pose/points) from an image.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.DepthRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.DepthResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/detection": {
|
||
"post": {
|
||
"tags": [
|
||
"detection"
|
||
],
|
||
"summary": "Detects objects in the input image.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.DetectionRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.DetectionResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/detokenize": {
|
||
"post": {
|
||
"tags": [
|
||
"tokenize"
|
||
],
|
||
"summary": "Detokenize the input.",
|
||
"parameters": [
|
||
{
|
||
"description": "Request",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.DetokenizeRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.DetokenizeResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/edits": {
|
||
"post": {
|
||
"tags": [
|
||
"inference"
|
||
],
|
||
"summary": "OpenAI edit endpoint",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.OpenAIRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.OpenAIResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/embeddings": {
|
||
"post": {
|
||
"tags": [
|
||
"embeddings"
|
||
],
|
||
"summary": "Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.OpenAIRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.OpenAIResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/face/analyze": {
|
||
"post": {
|
||
"tags": [
|
||
"face-recognition"
|
||
],
|
||
"summary": "Analyze demographic attributes (age, gender, ...) of faces.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.FaceAnalyzeRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.FaceAnalyzeResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/face/embed": {
|
||
"post": {
|
||
"tags": [
|
||
"face-recognition"
|
||
],
|
||
"summary": "Extract a face embedding from an image.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.FaceEmbedRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.FaceEmbedResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/face/forget": {
|
||
"post": {
|
||
"tags": [
|
||
"face-recognition"
|
||
],
|
||
"summary": "Remove a previously-registered face by ID.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.FaceForgetRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "No Content"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/face/identify": {
|
||
"post": {
|
||
"tags": [
|
||
"face-recognition"
|
||
],
|
||
"summary": "Identify a face against the registered database (1:N recognition).",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.FaceIdentifyRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.FaceIdentifyResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/face/register": {
|
||
"post": {
|
||
"tags": [
|
||
"face-recognition"
|
||
],
|
||
"summary": "Register a face for 1:N identification.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.FaceRegisterRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.FaceRegisterResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/face/verify": {
|
||
"post": {
|
||
"tags": [
|
||
"face-recognition"
|
||
],
|
||
"summary": "Verify that two images depict the same person.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.FaceVerifyRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.FaceVerifyResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/images/generations": {
|
||
"post": {
|
||
"tags": [
|
||
"images"
|
||
],
|
||
"summary": "Creates an image given a prompt.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.OpenAIRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.OpenAIResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/images/inpainting": {
|
||
"post": {
|
||
"description": "Perform image inpainting. Accepts multipart/form-data with ` + "`" + `image` + "`" + ` and ` + "`" + `mask` + "`" + ` files.",
|
||
"consumes": [
|
||
"multipart/form-data"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"images"
|
||
],
|
||
"summary": "Image inpainting",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Model identifier",
|
||
"name": "model",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Text prompt guiding the generation",
|
||
"name": "prompt",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"description": "Number of inference steps (default 25)",
|
||
"name": "steps",
|
||
"in": "formData"
|
||
},
|
||
{
|
||
"type": "file",
|
||
"description": "Original image file",
|
||
"name": "image",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "file",
|
||
"description": "Mask image file (white = area to inpaint)",
|
||
"name": "mask",
|
||
"in": "formData",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.OpenAIResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/images/upscale": {
|
||
"post": {
|
||
"description": "Upscale an image using a specified model (e.g. stable-diffusion-x4-upscaler). Accepts multipart/form-data.",
|
||
"consumes": [
|
||
"multipart/form-data"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"images"
|
||
],
|
||
"summary": "Image upscaling",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Upscaler model identifier (e.g. stable-diffusion-x4-upscaler)",
|
||
"name": "model",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "file",
|
||
"description": "Input image file",
|
||
"name": "image",
|
||
"in": "formData",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"description": "Upscale factor: integer from 1 to 16; must match the model native scale",
|
||
"name": "scale",
|
||
"in": "formData",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.OpenAIResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/mcp/chat/completions": {
|
||
"post": {
|
||
"tags": [
|
||
"mcp"
|
||
],
|
||
"summary": "MCP chat completions with automatic tool execution",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.OpenAIRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.OpenAIResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/messages": {
|
||
"post": {
|
||
"tags": [
|
||
"inference"
|
||
],
|
||
"summary": "Generate a message response for the given messages and model.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.AnthropicRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.AnthropicResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/models": {
|
||
"get": {
|
||
"tags": [
|
||
"models"
|
||
],
|
||
"summary": "List and describe the various models available in the API.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ModelsDataResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/models/capabilities": {
|
||
"get": {
|
||
"tags": [
|
||
"models"
|
||
],
|
||
"summary": "List available models enriched with capabilities and input/output modalities.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ModelCapabilitiesResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/moderations": {
|
||
"post": {
|
||
"tags": [
|
||
"moderation"
|
||
],
|
||
"summary": "Classify text for potentially harmful content.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ModerationRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ModerationResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/rerank": {
|
||
"post": {
|
||
"tags": [
|
||
"rerank"
|
||
],
|
||
"summary": "Reranks a list of phrases by relevance to a given text query.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.JINARerankRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.JINARerankResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/responses": {
|
||
"post": {
|
||
"tags": [
|
||
"inference"
|
||
],
|
||
"summary": "Create a response using the Open Responses API",
|
||
"parameters": [
|
||
{
|
||
"description": "Request body",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.OpenResponsesRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ORResponseResource"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/responses/{id}": {
|
||
"get": {
|
||
"description": "Retrieve a response by ID. Can be used for polling background responses or resuming streaming responses.",
|
||
"tags": [
|
||
"inference"
|
||
],
|
||
"summary": "Get a response by ID",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Response ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "Set to 'true' to resume streaming",
|
||
"name": "stream",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"description": "Sequence number to resume from (for streaming)",
|
||
"name": "starting_after",
|
||
"in": "query"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ORResponseResource"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Not Found",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/responses/{id}/cancel": {
|
||
"post": {
|
||
"description": "Cancel a background response if it's still in progress",
|
||
"tags": [
|
||
"inference"
|
||
],
|
||
"summary": "Cancel a response",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Response ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ORResponseResource"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Not Found",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/slots/restore": {
|
||
"post": {
|
||
"description": "Loads the prompt cache that a save call returned an ID for into one slot of a llama-cpp model. The ID must have been issued for this model. The state is only as fresh as the save. Admin only.",
|
||
"tags": [
|
||
"inference"
|
||
],
|
||
"summary": "Restore a slot's prompt cache by ID.",
|
||
"parameters": [
|
||
{
|
||
"description": "Request",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.SlotCacheRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.SlotCacheResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/slots/save": {
|
||
"post": {
|
||
"description": "Writes the prompt cache (KV state) of one slot of a llama-cpp model under the directory set by the model's slot_save_path option, and returns an ID for it. The server issues the ID; the client cannot choose a name or a path. The server keeps at most 32 saves per model and deletes the oldest one beyond that. Admin only.",
|
||
"tags": [
|
||
"inference"
|
||
],
|
||
"summary": "Save a slot's prompt cache.",
|
||
"parameters": [
|
||
{
|
||
"description": "Request",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.SlotCacheRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.SlotCacheResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/sound-generation": {
|
||
"post": {
|
||
"tags": [
|
||
"audio"
|
||
],
|
||
"summary": "Generates audio from the input text.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.ElevenLabsSoundGenerationRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/systemone": {
|
||
"post": {
|
||
"description": "Runs zero-shot NER over the supplied state and answers each question. Question types: noul (binary entity presence), choice (pick one option), score (pick one level).",
|
||
"tags": [
|
||
"systemone"
|
||
],
|
||
"summary": "Answer structured-extraction questions over state text.",
|
||
"parameters": [
|
||
{
|
||
"description": "state + questions",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.SystemOneRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.SystemOneResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/systemone/permute": {
|
||
"post": {
|
||
"description": "Re-runs one choice question under n_perm option orders. Reports per-order probabilities, argmax stability, and spread.",
|
||
"tags": [
|
||
"systemone"
|
||
],
|
||
"summary": "Re-run a choice question under multiple option orders.",
|
||
"parameters": [
|
||
{
|
||
"description": "request + question + n_perm + seed",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.SystemOnePermuteRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.SystemOnePermuteResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/systemone/separate": {
|
||
"post": {
|
||
"description": "Runs N independent NER passes, one per question, against the same state. Response shape matches /v1/systemone.",
|
||
"tags": [
|
||
"systemone"
|
||
],
|
||
"summary": "Answer each question in a separate NER pass.",
|
||
"parameters": [
|
||
{
|
||
"description": "state + questions",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.SystemOneRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.SystemOneResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/text-to-speech/{voice-id}": {
|
||
"post": {
|
||
"tags": [
|
||
"audio"
|
||
],
|
||
"summary": "Generates audio from the input text.",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Account ID",
|
||
"name": "voice-id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.TTSRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/tokenMetrics": {
|
||
"get": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"audio/x-wav"
|
||
],
|
||
"tags": [
|
||
"tokenize"
|
||
],
|
||
"summary": "Get TokenMetrics for Active Slot.",
|
||
"responses": {
|
||
"200": {
|
||
"description": "generated audio/wav file",
|
||
"schema": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/tokenize": {
|
||
"post": {
|
||
"tags": [
|
||
"tokenize"
|
||
],
|
||
"summary": "Tokenize the input.",
|
||
"parameters": [
|
||
{
|
||
"description": "Request",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.TokenizeRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.TokenizeResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/voice/analyze": {
|
||
"post": {
|
||
"tags": [
|
||
"voice-recognition"
|
||
],
|
||
"summary": "Analyze demographic attributes (age, gender, emotion) from a voice clip.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.VoiceAnalyzeRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.VoiceAnalyzeResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/voice/embed": {
|
||
"post": {
|
||
"tags": [
|
||
"voice-recognition"
|
||
],
|
||
"summary": "Extract a speaker embedding from an audio clip.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.VoiceEmbedRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.VoiceEmbedResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/voice/forget": {
|
||
"post": {
|
||
"tags": [
|
||
"voice-recognition"
|
||
],
|
||
"summary": "Remove a previously-registered speaker by ID.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.VoiceForgetRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "No Content"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/voice/identify": {
|
||
"post": {
|
||
"tags": [
|
||
"voice-recognition"
|
||
],
|
||
"summary": "Identify a speaker against the registered database (1:N recognition).",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.VoiceIdentifyRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.VoiceIdentifyResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/voice/register": {
|
||
"post": {
|
||
"description": "Supply either audio or speaker_profiles plus an explicit numeric speaker_slot. The selected model must expose matching trusted encoder metadata for portable enrollment. Registrations are global and ephemeral, with a fresh ID for each request.",
|
||
"tags": [
|
||
"voice-recognition"
|
||
],
|
||
"summary": "Register a speaker for 1:N identification.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.VoiceRegisterRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.VoiceRegisterResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/v1/voice/verify": {
|
||
"post": {
|
||
"tags": [
|
||
"voice-recognition"
|
||
],
|
||
"summary": "Verify that two audio clips were spoken by the same person.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.VoiceVerifyRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.VoiceVerifyResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/vad": {
|
||
"post": {
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"audio"
|
||
],
|
||
"summary": "Detect voice fragments in an audio stream",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.VADRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/proto.VADResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/video": {
|
||
"post": {
|
||
"tags": [
|
||
"video"
|
||
],
|
||
"summary": "Creates a video from a prompt and optional image or audio conditioning.",
|
||
"parameters": [
|
||
{
|
||
"description": "query params",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.VideoRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "Response",
|
||
"schema": {
|
||
"$ref": "#/definitions/schema.OpenAIResponse"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/ws/backend-logs/{modelId}": {
|
||
"get": {
|
||
"description": "Opens a WebSocket connection for real-time backend log streaming. Sends an initial batch of existing lines (type \"initial\"), then streams new lines as they appear (type \"line\"). Supports ping/pong keepalive.",
|
||
"tags": [
|
||
"monitoring"
|
||
],
|
||
"summary": "Stream backend logs via WebSocket",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "Model ID",
|
||
"name": "modelId",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {}
|
||
}
|
||
}
|
||
},
|
||
"definitions": {
|
||
"addons.AddonError": {
|
||
"type": "object",
|
||
"properties": {
|
||
"blockedBy": {
|
||
"description": "BlockedBy is the unresolved operation that blocks the write. It is\npresent only with type outcome_blocked, and only for the owner role of\nthe resource.",
|
||
"type": "string"
|
||
},
|
||
"code": {
|
||
"description": "Code repeats the HTTP status. It is absent from outcome_unknown responses.",
|
||
"type": "integer"
|
||
},
|
||
"message": {
|
||
"description": "Message describes the failure and never carries owner details.",
|
||
"type": "string"
|
||
},
|
||
"operationId": {
|
||
"description": "OperationID is the original operation, which is the proposal ID for a\nproposal call. It is present only with type outcome_unknown or\nproposal_unavailable.",
|
||
"type": "string"
|
||
},
|
||
"type": {
|
||
"description": "Type is addon_error, outcome_unknown when a mutation may have run,\nproposal_unavailable when a proposal call could not be served and the\nsame call can be repeated by the same proposal ID after reading it, or\noutcome_blocked (403) when another operation on the resource has an\nunresolved outcome and the caller is the resource's owner role. The\nresource management routes add sharing_disabled (409, local-owner mode\nhas no named users to share with), stale (409, the generation or the\nrevision the caller saw is out of date), operation_conflict (409, the\noperation ID was used for another request and nothing was applied),\ninvalid_request (400, for\nexample a missing deletion confirmation or an unsupported operation),\nquota_reached (403) and not_selected (404, no resource is selected for\nthe conversation).",
|
||
"type": "string",
|
||
"example": "outcome_unknown"
|
||
}
|
||
}
|
||
},
|
||
"addons.AddonErrorResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"error": {
|
||
"$ref": "#/definitions/addons.AddonError"
|
||
}
|
||
}
|
||
},
|
||
"addons.ConfirmRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"digest": {
|
||
"description": "Digest is the digest of the proposal as it was displayed.",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"addons.RecoveryBackupRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"operationId": {
|
||
"description": "OperationID identifies the request. Repeating it returns the backup it\nmade and makes no second one.",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"addons.RecoveryDeleteBackupRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"backupId": {
|
||
"type": "string"
|
||
},
|
||
"operationId": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"addons.RecoveryDeleted": {
|
||
"type": "object",
|
||
"properties": {
|
||
"deleted": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"addons.RecoveryPruneRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"operationId": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"addons.RecoveryPruned": {
|
||
"type": "object",
|
||
"properties": {
|
||
"removed": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"addons.RecoveryPurgeRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"confirm": {
|
||
"description": "Confirm is the add-on's ID, typed.",
|
||
"type": "string"
|
||
},
|
||
"operationId": {
|
||
"type": "string"
|
||
},
|
||
"scope": {
|
||
"$ref": "#/definitions/recovery.PurgeScope"
|
||
}
|
||
}
|
||
},
|
||
"addons.RecoveryRestoreRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"backupId": {
|
||
"type": "string"
|
||
},
|
||
"confirm": {
|
||
"description": "Confirm is the add-on's ID, typed.",
|
||
"type": "string"
|
||
},
|
||
"mapping": {
|
||
"description": "Mapping names the current account that takes the data of a backup made\nin another ownership mode, as {\"local-owner\": \"\u003caccount id\u003e\"}. It is\nexplicit: there is no wildcard and no default.",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"operationId": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"addons.RecoveryVerifyRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"backupId": {
|
||
"type": "string"
|
||
},
|
||
"operationId": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"addons.ResolveRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"digest": {
|
||
"description": "Digest is the digest of the proposal as it was displayed.",
|
||
"type": "string"
|
||
},
|
||
"reason": {
|
||
"description": "Reason is why the owner stops waiting. Required, at most 512 characters.",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"addons.UpdateCheckRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"operationId": {
|
||
"description": "OperationID identifies the request and is the confirmation header.",
|
||
"type": "string",
|
||
"example": "check-notes-1"
|
||
}
|
||
}
|
||
},
|
||
"addons.UpgradeRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"candidateDigest": {
|
||
"description": "CandidateDigest is the digest of the candidate the check resolved.",
|
||
"type": "string",
|
||
"example": "sha256:fedcba9876543210fedcba9876543210fedcba9876543210fedcba9876543210"
|
||
},
|
||
"expectedDigest": {
|
||
"description": "ExpectedDigest is the digest of the installed package the caller saw.",
|
||
"type": "string",
|
||
"example": "sha256:0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
|
||
},
|
||
"generation": {
|
||
"description": "Generation is the installed generation the caller saw, when it knows it.",
|
||
"type": "integer",
|
||
"example": 1
|
||
},
|
||
"operationId": {
|
||
"description": "OperationID is the identity of the upgrade: repeat it to replay safely\nand, after an outcome_unknown answer, poll operation-status with it. The\nsame transition under another operation ID is refused.",
|
||
"type": "string",
|
||
"example": "upgrade-notes-1"
|
||
}
|
||
}
|
||
},
|
||
"apps.AdminView": {
|
||
"type": "object",
|
||
"properties": {
|
||
"canStart": {
|
||
"type": "boolean"
|
||
},
|
||
"canStop": {
|
||
"type": "boolean"
|
||
},
|
||
"managementUrl": {
|
||
"description": "ManagementURL opens the management view of the addon.",
|
||
"type": "string",
|
||
"example": "/app/addons?manage=notes"
|
||
}
|
||
}
|
||
},
|
||
"apps.App": {
|
||
"type": "object",
|
||
"properties": {
|
||
"admin": {
|
||
"description": "Admin is present only for administrators.",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/apps.AdminView"
|
||
}
|
||
]
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"example": "Keep notes."
|
||
},
|
||
"descriptions": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"enabled": {
|
||
"description": "Enabled is the durable desired state. Health is State, a separate\nobservation: an enabled app can be failed.",
|
||
"type": "boolean"
|
||
},
|
||
"generation": {
|
||
"description": "Generation is the installed generation. A Start or Stop request must\ncarry the value that was listed; a stale value is denied.",
|
||
"type": "integer",
|
||
"example": 3
|
||
},
|
||
"hasUI": {
|
||
"description": "HasUI is true when the addon contributes any UI.",
|
||
"type": "boolean"
|
||
},
|
||
"icon": {
|
||
"description": "Icon is a same-origin URL of the verified immutable icon of this\ngeneration. It is absent when the manifest declares none.",
|
||
"type": "string",
|
||
"example": "/api/addons/apps/notes/icon?generation=3"
|
||
},
|
||
"id": {
|
||
"description": "ID is the addon identifier and Name its stable machine name. They are\nthe same in version one: the receipt records no separate catalog name.",
|
||
"type": "string",
|
||
"example": "notes"
|
||
},
|
||
"launchMode": {
|
||
"type": "string",
|
||
"example": "always"
|
||
},
|
||
"mainPage": {
|
||
"description": "MainPage is the path the Open action navigates to. It is present only\nfor an enabled addon whose manifest declares a main page that is one of\nits pages.",
|
||
"type": "string",
|
||
"example": "/app/addons/notes/home"
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"example": "notes"
|
||
},
|
||
"state": {
|
||
"description": "State is running, starting, failed or stopped: the observation of the\nprocess, never an update.",
|
||
"type": "string",
|
||
"enum": [
|
||
"running",
|
||
"starting",
|
||
"failed",
|
||
"stopped"
|
||
],
|
||
"example": "running"
|
||
},
|
||
"title": {
|
||
"description": "Title and Description are the default-language text of the manifest.\nTitles and Descriptions carry every language when the manifest\nlocalizes the text, keyed by BCP 47 tag; they are absent otherwise.",
|
||
"type": "string",
|
||
"example": "Notes"
|
||
},
|
||
"titles": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"toolCount": {
|
||
"type": "integer"
|
||
},
|
||
"toolDefinitions": {
|
||
"description": "ToolDefinitions are the model-facing definitions the manifest declares:\nthe argument schema and the kind of each tool. The host serves them to\nchat from the verified manifest; the add-on process is never asked.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/contract.ToolDefinition"
|
||
}
|
||
},
|
||
"tools": {
|
||
"description": "Tools are the tool names of the manifest, at most 32. ToolCount is the\nfull number. The manifest carries no tool descriptions.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"ui": {
|
||
"description": "UI describes what the shell loads for this app. It is present only for\nan enabled addon with a UI whose installed package has a sha256 digest.",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/apps.UIView"
|
||
}
|
||
]
|
||
},
|
||
"update": {
|
||
"description": "Update is update-pending when the owner's cached update check says an\nupdate is available for the installed package. It is a separate\nobservation from State and is absent otherwise: an unchecked, failed\nor up to date add-on has none. The list never reaches a library.",
|
||
"type": "string",
|
||
"enum": [
|
||
"update-pending"
|
||
],
|
||
"example": "update-pending"
|
||
},
|
||
"version": {
|
||
"type": "string",
|
||
"example": "1.2.3"
|
||
}
|
||
}
|
||
},
|
||
"apps.ChatActionView": {
|
||
"type": "object",
|
||
"properties": {
|
||
"component": {
|
||
"type": "string",
|
||
"example": "SummaryPanel"
|
||
},
|
||
"icon": {
|
||
"description": "Icon is a host icon name, or the empty string when the action uses the\npackaged icon of the app (see the icon of the app).",
|
||
"type": "string",
|
||
"example": "sparkles"
|
||
},
|
||
"id": {
|
||
"description": "ID is the manifest identifier of the action.",
|
||
"type": "string",
|
||
"example": "summarize"
|
||
},
|
||
"label": {
|
||
"description": "Label is the default-language text; Labels carries every language when\nthe manifest localizes it.",
|
||
"type": "string",
|
||
"example": "Summarize"
|
||
},
|
||
"labels": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"packagedIcon": {
|
||
"description": "PackagedIcon is true when the action draws the packaged app icon.",
|
||
"type": "boolean"
|
||
},
|
||
"placement": {
|
||
"description": "Placement is composer or message.",
|
||
"type": "string",
|
||
"enum": [
|
||
"composer",
|
||
"message"
|
||
],
|
||
"example": "composer"
|
||
},
|
||
"tool": {
|
||
"description": "Tool is the own tool the action calls, or Component the exported\ncomponent it opens. Exactly one is set.",
|
||
"type": "string",
|
||
"example": "summarize"
|
||
}
|
||
}
|
||
},
|
||
"apps.List": {
|
||
"type": "object",
|
||
"properties": {
|
||
"apps": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/apps.App"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"apps.SlotView": {
|
||
"type": "object",
|
||
"properties": {
|
||
"component": {
|
||
"type": "string",
|
||
"example": "NotesSettings"
|
||
},
|
||
"id": {
|
||
"type": "string",
|
||
"example": "notes-nav"
|
||
},
|
||
"slot": {
|
||
"type": "string",
|
||
"enum": [
|
||
"chat.composer.actions",
|
||
"chat.message.actions",
|
||
"app.nav",
|
||
"settings.sections"
|
||
],
|
||
"example": "settings.sections"
|
||
}
|
||
}
|
||
},
|
||
"apps.StartRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"generation": {
|
||
"description": "Generation is the installed generation the caller saw in the list.",
|
||
"type": "integer",
|
||
"example": 3
|
||
},
|
||
"operationId": {
|
||
"description": "OperationID names the lifecycle operation. Repeating it never runs the\nchange twice and, after an outcome_unknown answer, it is the identifier\nto poll.",
|
||
"type": "string",
|
||
"example": "start-notes-1"
|
||
}
|
||
}
|
||
},
|
||
"apps.UIView": {
|
||
"type": "object",
|
||
"properties": {
|
||
"actions": {
|
||
"description": "Actions are the chat actions that declare a placement and a target.\nSlots and Renderers are the other declared contributions. The manifest\nwas validated at install: every tool named here is a tool of the addon,\nevery slot is a host slot and every icon is a host icon name or the\npackaged icon. The host draws them only while the addon is enabled and\nusable by the caller.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/apps.ChatActionView"
|
||
}
|
||
},
|
||
"chatActions": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"css": {
|
||
"description": "CSS are the URLs of the declared style sheets.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"entry": {
|
||
"description": "Entry is the URL of the packaged ES module. Every asset URL names the\npackage digest, so a new package is a new URL.",
|
||
"type": "string",
|
||
"example": "/api/addons/notes/assets/0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef/ui.js"
|
||
},
|
||
"navigation": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"pages": {
|
||
"description": "Pages, Navigation and ChatActions are the identifiers the manifest\ndeclares. The host decides where each one is shown.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"renderers": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/contract.Renderer"
|
||
}
|
||
},
|
||
"sdk": {
|
||
"description": "SDK is the range of host SDK versions the module accepts.",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/contract.VersionRange"
|
||
}
|
||
]
|
||
},
|
||
"slots": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/apps.SlotView"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"auth.WebSocketTicketResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"expires_at": {
|
||
"type": "string"
|
||
},
|
||
"ticket": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"backendlib.Update": {
|
||
"type": "object",
|
||
"properties": {
|
||
"digest": {
|
||
"type": "string"
|
||
},
|
||
"installedDigest": {
|
||
"type": "string"
|
||
},
|
||
"installedVersion": {
|
||
"description": "InstalledVersion and InstalledDigest are what metadata.json pins.",
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"description": "Name is the backend name.",
|
||
"type": "string"
|
||
},
|
||
"signed": {
|
||
"description": "Signed says the library requires a signature, so the install of the\nupdate has a verifying step.",
|
||
"type": "boolean"
|
||
},
|
||
"sourceId": {
|
||
"description": "SourceID is the library the backend came from.",
|
||
"type": "string"
|
||
},
|
||
"version": {
|
||
"description": "Version and Digest are the build the library lists now. Version is what\nan install of the update names.",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"builtin.Entry": {
|
||
"type": "object",
|
||
"properties": {
|
||
"adminOnly": {
|
||
"type": "boolean"
|
||
},
|
||
"feature": {
|
||
"type": "string"
|
||
},
|
||
"icon": {
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"kind": {
|
||
"$ref": "#/definitions/builtin.Kind"
|
||
},
|
||
"mainPath": {
|
||
"type": "string"
|
||
},
|
||
"titleKey": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"builtin.Kind": {
|
||
"type": "string",
|
||
"enum": [
|
||
"page"
|
||
],
|
||
"x-enum-varnames": [
|
||
"KindPage"
|
||
]
|
||
},
|
||
"catalog.Kind": {
|
||
"type": "string",
|
||
"enum": [
|
||
"addon",
|
||
"backend",
|
||
"model",
|
||
"all"
|
||
],
|
||
"x-enum-varnames": [
|
||
"KindAddon",
|
||
"KindBackend",
|
||
"KindModel",
|
||
"QueryAllKinds"
|
||
]
|
||
},
|
||
"catalog.RefreshState": {
|
||
"type": "object",
|
||
"properties": {
|
||
"checkedAt": {
|
||
"type": "string"
|
||
},
|
||
"count": {
|
||
"type": "integer"
|
||
},
|
||
"failed": {
|
||
"description": "Failed is true when the latest fetch failed; the previous releases are\nnot served in that case.",
|
||
"type": "boolean"
|
||
},
|
||
"lastSuccess": {
|
||
"type": "string"
|
||
},
|
||
"skipped": {
|
||
"description": "Skipped and SkippedKinds are as in RefreshResult.",
|
||
"type": "integer"
|
||
},
|
||
"skippedKinds": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"catalog.VerificationPolicy": {
|
||
"type": "object",
|
||
"properties": {
|
||
"identity": {
|
||
"type": "string"
|
||
},
|
||
"identityRegex": {
|
||
"description": "IdentityRegex is an anchored pattern for the signer identity, used\ninstead of Identity so that master and tagged builds both verify. Only a\nlibrary that serves backends may use it; an add-on install refuses it.",
|
||
"type": "string"
|
||
},
|
||
"issuer": {
|
||
"type": "string"
|
||
},
|
||
"requireSignature": {
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"config.Gallery": {
|
||
"type": "object",
|
||
"properties": {
|
||
"artifact_verification": {
|
||
"description": "ArtifactVerification overrides Verification only for the gallery OCI artifact.\nBackend images keep their separate Verification policy.",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/config.GalleryVerification"
|
||
}
|
||
]
|
||
},
|
||
"library": {
|
||
"description": "Library says the URL is a model library (the shared library entry\nshape), not a gallery index.",
|
||
"type": "boolean"
|
||
},
|
||
"mirrors": {
|
||
"description": "Mirrors are tried in order when URL cannot be fetched. They are a\nfallback for availability, not a load-balancing pool: the primary is\nalways preferred, and a mirror is only consulted after the one before\nit fails. Any URI the gallery loader understands works here\n(https://, github:, file://, oci://).",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"url": {
|
||
"type": "string"
|
||
},
|
||
"verification": {
|
||
"$ref": "#/definitions/config.GalleryVerification"
|
||
}
|
||
}
|
||
},
|
||
"config.GalleryVerification": {
|
||
"type": "object",
|
||
"properties": {
|
||
"identity": {
|
||
"type": "string"
|
||
},
|
||
"identity_regex": {
|
||
"type": "string"
|
||
},
|
||
"issuer": {
|
||
"type": "string"
|
||
},
|
||
"issuer_regex": {
|
||
"type": "string"
|
||
},
|
||
"not_before": {
|
||
"description": "NotBefore is an RFC3339 timestamp. Empty disables the time check.",
|
||
"type": "string"
|
||
},
|
||
"source_repository": {
|
||
"description": "SourceRepository is an https URL compared exactly against the\ncertificate's source-repository extension. Empty skips the check.",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"config.TTSVoice": {
|
||
"type": "object",
|
||
"properties": {
|
||
"gender": {
|
||
"type": "string"
|
||
},
|
||
"language": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"contract.OutputDescription": {
|
||
"type": "object",
|
||
"properties": {
|
||
"handle": {
|
||
"type": "string"
|
||
},
|
||
"mediaType": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"size": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"contract.Receipt": {
|
||
"type": "object",
|
||
"properties": {
|
||
"operationId": {
|
||
"type": "string"
|
||
},
|
||
"result": {
|
||
"$ref": "#/definitions/contract.Result"
|
||
},
|
||
"revision": {
|
||
"$ref": "#/definitions/contract.Revision"
|
||
},
|
||
"state": {
|
||
"$ref": "#/definitions/contract.ReceiptState"
|
||
}
|
||
}
|
||
},
|
||
"contract.ReceiptState": {
|
||
"type": "string",
|
||
"enum": [
|
||
"pending",
|
||
"committed",
|
||
"rejected",
|
||
"unknown"
|
||
],
|
||
"x-enum-varnames": [
|
||
"ReceiptPending",
|
||
"ReceiptCommitted",
|
||
"ReceiptRejected",
|
||
"ReceiptUnknown"
|
||
]
|
||
},
|
||
"contract.Renderer": {
|
||
"type": "object",
|
||
"properties": {
|
||
"component": {
|
||
"type": "string"
|
||
},
|
||
"kind": {
|
||
"type": "string"
|
||
},
|
||
"tool": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"contract.Request": {
|
||
"type": "object",
|
||
"properties": {
|
||
"action": {
|
||
"type": "string"
|
||
},
|
||
"addonId": {
|
||
"type": "string"
|
||
},
|
||
"arguments": {
|
||
"type": "object"
|
||
},
|
||
"generation": {
|
||
"type": "integer"
|
||
},
|
||
"operationId": {
|
||
"type": "string"
|
||
},
|
||
"resourceId": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"contract.Result": {
|
||
"type": "object",
|
||
"properties": {
|
||
"outputs": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/contract.OutputDescription"
|
||
}
|
||
},
|
||
"payload": {
|
||
"type": "object"
|
||
}
|
||
}
|
||
},
|
||
"contract.Revision": {
|
||
"type": "object",
|
||
"properties": {
|
||
"data": {
|
||
"type": "integer"
|
||
},
|
||
"schema": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"contract.ToolDefinition": {
|
||
"type": "object",
|
||
"properties": {
|
||
"description": {
|
||
"description": "Description is plain text for the model.",
|
||
"type": "string"
|
||
},
|
||
"inputSchema": {
|
||
"description": "InputSchema is the JSON schema of the arguments object. It is an\nobject schema with explicit properties, additionalProperties false at\nthe top level and the keywords the host allows only.",
|
||
"type": "object"
|
||
},
|
||
"kind": {
|
||
"description": "Kind is read, write, schema or create.",
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"description": "Name is one of capabilities.tools.",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"contract.VersionRange": {
|
||
"type": "object",
|
||
"properties": {
|
||
"max": {
|
||
"type": "integer"
|
||
},
|
||
"min": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"failover.ChainState": {
|
||
"type": "string",
|
||
"enum": [
|
||
"primary",
|
||
"fallback",
|
||
"degraded"
|
||
],
|
||
"x-enum-varnames": [
|
||
"ChainPrimary",
|
||
"ChainFallback",
|
||
"ChainDegraded"
|
||
]
|
||
},
|
||
"failover.ChainStatus": {
|
||
"type": "object",
|
||
"properties": {
|
||
"active": {
|
||
"type": "string"
|
||
},
|
||
"active_since": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"pinned": {
|
||
"type": "string"
|
||
},
|
||
"state": {
|
||
"$ref": "#/definitions/failover.ChainState"
|
||
},
|
||
"targets": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/failover.TargetStatus"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"failover.Kind": {
|
||
"type": "string",
|
||
"enum": [
|
||
"local",
|
||
"remote"
|
||
],
|
||
"x-enum-varnames": [
|
||
"KindLocal",
|
||
"KindRemote"
|
||
]
|
||
},
|
||
"failover.TargetState": {
|
||
"type": "string",
|
||
"enum": [
|
||
"healthy",
|
||
"down",
|
||
"recovering",
|
||
"missing"
|
||
],
|
||
"x-enum-varnames": [
|
||
"StateHealthy",
|
||
"StateDown",
|
||
"StateRecovering",
|
||
"StateMissing"
|
||
]
|
||
},
|
||
"failover.TargetStatus": {
|
||
"type": "object",
|
||
"properties": {
|
||
"consecutive_ok": {
|
||
"type": "integer"
|
||
},
|
||
"kind": {
|
||
"$ref": "#/definitions/failover.Kind"
|
||
},
|
||
"last_error": {
|
||
"type": "string"
|
||
},
|
||
"last_probe": {
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"state": {
|
||
"$ref": "#/definitions/failover.TargetState"
|
||
},
|
||
"warm": {
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"functions.Function": {
|
||
"type": "object",
|
||
"properties": {
|
||
"description": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"parameters": {
|
||
"type": "object",
|
||
"additionalProperties": {}
|
||
},
|
||
"strict": {
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"functions.Item": {
|
||
"type": "object",
|
||
"properties": {
|
||
"properties": {
|
||
"type": "object",
|
||
"additionalProperties": {}
|
||
},
|
||
"type": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"functions.JSONFunctionStructure": {
|
||
"type": "object",
|
||
"properties": {
|
||
"$defs": {
|
||
"type": "object",
|
||
"additionalProperties": {}
|
||
},
|
||
"anyOf": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/functions.Item"
|
||
}
|
||
},
|
||
"oneOf": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/functions.Item"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"functions.Tool": {
|
||
"type": "object",
|
||
"properties": {
|
||
"function": {
|
||
"$ref": "#/definitions/functions.Function"
|
||
},
|
||
"type": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"gallery.File": {
|
||
"type": "object",
|
||
"properties": {
|
||
"filename": {
|
||
"type": "string"
|
||
},
|
||
"sha256": {
|
||
"type": "string"
|
||
},
|
||
"uri": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"gallery.GalleryBackend": {
|
||
"type": "object",
|
||
"properties": {
|
||
"alias": {
|
||
"type": "string"
|
||
},
|
||
"backend": {
|
||
"description": "Backend is the resolved backend engine for this model (e.g. \"llama-cpp\").\nPopulated at load time from overrides, inline config, or the URL-referenced config file.",
|
||
"type": "string"
|
||
},
|
||
"capabilities": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"description": {
|
||
"type": "string"
|
||
},
|
||
"files": {
|
||
"description": "AdditionalFiles are used to add additional files to the model",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/gallery.File"
|
||
}
|
||
},
|
||
"gallery": {
|
||
"description": "Gallery is a reference to the gallery which contains the model",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/config.Gallery"
|
||
}
|
||
]
|
||
},
|
||
"icon": {
|
||
"type": "string"
|
||
},
|
||
"installed": {
|
||
"description": "Installed is used to indicate if the model is installed or not",
|
||
"type": "boolean"
|
||
},
|
||
"license": {
|
||
"type": "string"
|
||
},
|
||
"mirrors": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"sha256": {
|
||
"description": "SHA256 is the expected sha256 of the backend tarball at URI / Mirrors.\nEmpty disables the integrity check; OCI URIs carry their own digest.",
|
||
"type": "string"
|
||
},
|
||
"size": {
|
||
"description": "Size is an optional hardcoded model size string (e.g. \"500MB\", \"14.5GB\").\nUsed when the size cannot be estimated automatically.",
|
||
"type": "string"
|
||
},
|
||
"tags": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"uri": {
|
||
"type": "string"
|
||
},
|
||
"url": {
|
||
"type": "string"
|
||
},
|
||
"urls": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"version": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"gallery.Metadata": {
|
||
"type": "object",
|
||
"properties": {
|
||
"backend": {
|
||
"description": "Backend is the resolved backend engine for this model (e.g. \"llama-cpp\").\nPopulated at load time from overrides, inline config, or the URL-referenced config file.",
|
||
"type": "string"
|
||
},
|
||
"description": {
|
||
"type": "string"
|
||
},
|
||
"files": {
|
||
"description": "AdditionalFiles are used to add additional files to the model",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/gallery.File"
|
||
}
|
||
},
|
||
"gallery": {
|
||
"description": "Gallery is a reference to the gallery which contains the model",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/config.Gallery"
|
||
}
|
||
]
|
||
},
|
||
"icon": {
|
||
"type": "string"
|
||
},
|
||
"installed": {
|
||
"description": "Installed is used to indicate if the model is installed or not",
|
||
"type": "boolean"
|
||
},
|
||
"license": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"size": {
|
||
"description": "Size is an optional hardcoded model size string (e.g. \"500MB\", \"14.5GB\").\nUsed when the size cannot be estimated automatically.",
|
||
"type": "string"
|
||
},
|
||
"tags": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"url": {
|
||
"type": "string"
|
||
},
|
||
"urls": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"gallery.ModelStorage": {
|
||
"type": "object",
|
||
"properties": {
|
||
"files": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"missing": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"shared_bytes": {
|
||
"type": "integer"
|
||
},
|
||
"size_bytes": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"gallery.NodeDriftInfo": {
|
||
"type": "object",
|
||
"properties": {
|
||
"digest": {
|
||
"type": "string"
|
||
},
|
||
"node_id": {
|
||
"type": "string"
|
||
},
|
||
"node_name": {
|
||
"type": "string"
|
||
},
|
||
"version": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"gallery.StorageFile": {
|
||
"type": "object",
|
||
"properties": {
|
||
"missing": {
|
||
"type": "boolean"
|
||
},
|
||
"models": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"path": {
|
||
"description": "Path is relative to the models directory.",
|
||
"type": "string"
|
||
},
|
||
"size_bytes": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"gallery.StorageIndex": {
|
||
"type": "object",
|
||
"properties": {
|
||
"errors": {
|
||
"description": "Errors carries per-config failures (malformed YAML, path escapes),\nreported rather than fatal so one broken config cannot blank the\nwhole report.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"files": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/gallery.StorageFile"
|
||
}
|
||
},
|
||
"models": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/gallery.ModelStorage"
|
||
}
|
||
},
|
||
"total_bytes": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"gallery.UpgradeInfo": {
|
||
"type": "object",
|
||
"properties": {
|
||
"available_digest": {
|
||
"type": "string"
|
||
},
|
||
"available_version": {
|
||
"type": "string"
|
||
},
|
||
"backend_name": {
|
||
"type": "string"
|
||
},
|
||
"installed_digest": {
|
||
"type": "string"
|
||
},
|
||
"installed_version": {
|
||
"type": "string"
|
||
},
|
||
"node_drift": {
|
||
"description": "NodeDrift lists nodes whose installed version or digest differs from\nthe cluster majority. Non-empty means the cluster has diverged and an\nupgrade will realign it. Empty in single-node mode.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/gallery.NodeDriftInfo"
|
||
}
|
||
},
|
||
"reason": {
|
||
"description": "Reason says why the backend is flagged when version and digest alone\nwould not flag it: the backend failed a request in a way that shows it\nis older than the server. Empty for ordinary version or digest upgrades.",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"gallery.Variant": {
|
||
"type": "object",
|
||
"properties": {
|
||
"model": {
|
||
"description": "Model is the name of a gallery entry that declares no variants of its own.",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"galleryop.NodeProgress": {
|
||
"type": "object",
|
||
"properties": {
|
||
"current": {
|
||
"type": "string"
|
||
},
|
||
"error": {
|
||
"type": "string"
|
||
},
|
||
"file_name": {
|
||
"type": "string"
|
||
},
|
||
"node_id": {
|
||
"type": "string"
|
||
},
|
||
"node_name": {
|
||
"type": "string"
|
||
},
|
||
"percentage": {
|
||
"type": "number"
|
||
},
|
||
"phase": {
|
||
"type": "string"
|
||
},
|
||
"status": {
|
||
"type": "string"
|
||
},
|
||
"total": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"galleryop.OpStatus": {
|
||
"type": "object",
|
||
"properties": {
|
||
"cancellable": {
|
||
"description": "Cancellable is true if the operation can be cancelled",
|
||
"type": "boolean"
|
||
},
|
||
"cancelled": {
|
||
"description": "Cancelled is true if the operation was cancelled",
|
||
"type": "boolean"
|
||
},
|
||
"current_bytes": {
|
||
"type": "integer"
|
||
},
|
||
"deletion": {
|
||
"description": "Deletion is true if the operation is a deletion",
|
||
"type": "boolean"
|
||
},
|
||
"downloaded_size": {
|
||
"type": "string"
|
||
},
|
||
"file_name": {
|
||
"type": "string"
|
||
},
|
||
"file_size": {
|
||
"type": "string"
|
||
},
|
||
"gallery_element_name": {
|
||
"type": "string"
|
||
},
|
||
"message": {
|
||
"type": "string"
|
||
},
|
||
"nodes": {
|
||
"description": "Nodes is the per-node breakdown for a fanned-out backend install.\nPopulated by DistributedBackendManager (per-node terminal status)\nand by the Phase 2 progress bridge (per-byte ticks). The\n/api/operations handler surfaces this so the UI can render an\nexpandable per-node view of an in-flight install.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/galleryop.NodeProgress"
|
||
}
|
||
},
|
||
"phase": {
|
||
"type": "string"
|
||
},
|
||
"processed": {
|
||
"type": "boolean"
|
||
},
|
||
"progress": {
|
||
"type": "number"
|
||
},
|
||
"total_bytes": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"gateway.ApplyResourceRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"arguments": {
|
||
"description": "Arguments are the tool's own arguments without the resource, which the\npath names, and without the tool, which Tool names.",
|
||
"type": "object"
|
||
},
|
||
"generation": {
|
||
"description": "Generation is the installed generation the caller listed.",
|
||
"type": "integer",
|
||
"example": 3
|
||
},
|
||
"operationId": {
|
||
"description": "OperationID names the change. Repeating it with the same request\nreturns the same receipt and never applies twice; after an\noutcome_unknown answer it is what to repeat.",
|
||
"type": "string",
|
||
"example": "apply-1"
|
||
},
|
||
"revision": {
|
||
"description": "Revision is the revision the caller read. A moved revision is a stale\ndenial and nothing is changed.",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/contract.Revision"
|
||
}
|
||
]
|
||
},
|
||
"tool": {
|
||
"description": "Tool is a write or schema tool the add-on declares.",
|
||
"type": "string",
|
||
"example": "rows-insert"
|
||
}
|
||
}
|
||
},
|
||
"gateway.ApplyResult": {
|
||
"type": "object",
|
||
"properties": {
|
||
"operationId": {
|
||
"type": "string"
|
||
},
|
||
"requestHash": {
|
||
"description": "RequestHash binds the operation ID to the request: the SHA-256 of the\nresource, the tool and the canonical arguments. A lookup of the\noperation reports it, so a client can tell its own request from\nanother one that used the same ID.",
|
||
"type": "string",
|
||
"example": "3f786850e387550fdab836ed7e6dc881de23001b3f786850e387550fdab836ed"
|
||
},
|
||
"resourceId": {
|
||
"type": "string"
|
||
},
|
||
"result": {
|
||
"description": "Result is what the add-on's receipt reported, for example the count\nand the identifiers of the changed rows.",
|
||
"type": "object"
|
||
},
|
||
"revision": {
|
||
"description": "Revision is the revision after the change.",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/contract.Revision"
|
||
}
|
||
]
|
||
}
|
||
}
|
||
},
|
||
"gateway.Artifact": {
|
||
"type": "object",
|
||
"properties": {
|
||
"addonId": {
|
||
"description": "AddonID and Generation name the addon build that produced the result.",
|
||
"type": "string"
|
||
},
|
||
"createdAt": {
|
||
"type": "string"
|
||
},
|
||
"expiresAt": {
|
||
"description": "ExpiresAt is when the artifact stops being served and is removed.",
|
||
"type": "string"
|
||
},
|
||
"generation": {
|
||
"type": "integer"
|
||
},
|
||
"id": {
|
||
"description": "ID is the host-generated opaque identifier. It is the only handle a\nclient ever holds for the file.",
|
||
"type": "string"
|
||
},
|
||
"mediaType": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"description": "Name is the sanitized attachment name and MediaType the safe media type\nthe download is served with.",
|
||
"type": "string"
|
||
},
|
||
"operationId": {
|
||
"description": "OperationID is the operation of the request that produced the output.",
|
||
"type": "string"
|
||
},
|
||
"principal": {
|
||
"description": "Principal is the user who requested the result. Only this user can read\nor download the artifact.",
|
||
"type": "string"
|
||
},
|
||
"reason": {
|
||
"description": "Reason says why a transfer failed or was cancelled. It never carries\naddon text.",
|
||
"type": "string"
|
||
},
|
||
"size": {
|
||
"description": "Size is the exact number of bytes of a complete artifact.",
|
||
"type": "integer"
|
||
},
|
||
"sources": {
|
||
"description": "Sources are the resources the bytes were produced from. Every one of\nthem must still be readable by the principal at completion and at each\ndownload.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/gateway.ArtifactResource"
|
||
}
|
||
},
|
||
"state": {
|
||
"$ref": "#/definitions/gateway.ArtifactState"
|
||
}
|
||
}
|
||
},
|
||
"gateway.ArtifactResource": {
|
||
"type": "object",
|
||
"properties": {
|
||
"addonId": {
|
||
"type": "string"
|
||
},
|
||
"resourceId": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"gateway.ArtifactState": {
|
||
"type": "string",
|
||
"enum": [
|
||
"transferring",
|
||
"complete",
|
||
"failed",
|
||
"cancelled"
|
||
],
|
||
"x-enum-varnames": [
|
||
"ArtifactTransferring",
|
||
"ArtifactComplete",
|
||
"ArtifactFailed",
|
||
"ArtifactCancelled"
|
||
]
|
||
},
|
||
"gateway.BlockingProposal": {
|
||
"type": "object",
|
||
"properties": {
|
||
"action": {
|
||
"type": "string"
|
||
},
|
||
"addonId": {
|
||
"type": "string"
|
||
},
|
||
"ageSeconds": {
|
||
"description": "AgeSeconds is how long the outcome has been unresolved, counted from\nthe hand-over to the addon.",
|
||
"type": "integer"
|
||
},
|
||
"createdAt": {
|
||
"type": "string"
|
||
},
|
||
"digest": {
|
||
"description": "Digest is what the owner names to resolve the proposal.",
|
||
"type": "string"
|
||
},
|
||
"effects": {
|
||
"$ref": "#/definitions/gateway.ProposalEffects"
|
||
},
|
||
"expiresAt": {
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"description": "ID is the proposal identifier, which is its operation identifier.",
|
||
"type": "string"
|
||
},
|
||
"proposerId": {
|
||
"description": "ProposerID is the user who proposed the operation.",
|
||
"type": "string"
|
||
},
|
||
"reason": {
|
||
"description": "Reason says why the outcome is unresolved.",
|
||
"type": "string"
|
||
},
|
||
"resolution": {
|
||
"description": "Resolution is present once the owner stopped waiting.",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/gateway.ProposalResolution"
|
||
}
|
||
]
|
||
},
|
||
"resourceId": {
|
||
"type": "string"
|
||
},
|
||
"state": {
|
||
"description": "State is executing, outcome-unknown or abandoned-unknown.",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/gateway.ProposalState"
|
||
}
|
||
]
|
||
}
|
||
}
|
||
},
|
||
"gateway.CreateResourceRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"addonId": {
|
||
"description": "AddonID names the add-on whose resource is created.",
|
||
"type": "string",
|
||
"example": "tables"
|
||
},
|
||
"arguments": {
|
||
"description": "Arguments are the create arguments the add-on's create tool takes, for\nexample the name. They are validated against its tool definition.",
|
||
"type": "object"
|
||
},
|
||
"generation": {
|
||
"description": "Generation is the installed generation the caller listed.",
|
||
"type": "integer",
|
||
"example": 3
|
||
},
|
||
"operationId": {
|
||
"description": "OperationID names the creation. Repeating it never creates a second\nresource and, after an outcome_unknown answer, it is what to repeat.",
|
||
"type": "string",
|
||
"example": "create-budget-1"
|
||
}
|
||
}
|
||
},
|
||
"gateway.DeleteResourceRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"confirm": {
|
||
"description": "Confirm must equal the display name of the resource exactly: the person\ntypes it to confirm. Deletion removes the data and every grant, cannot\nbe undone and is never a chat operation.",
|
||
"type": "string",
|
||
"example": "Budget"
|
||
},
|
||
"generation": {
|
||
"type": "integer",
|
||
"example": 3
|
||
},
|
||
"operationId": {
|
||
"type": "string",
|
||
"example": "delete-1"
|
||
},
|
||
"revision": {
|
||
"$ref": "#/definitions/contract.Revision"
|
||
}
|
||
}
|
||
},
|
||
"gateway.DeleteResult": {
|
||
"type": "object",
|
||
"properties": {
|
||
"deleted": {
|
||
"description": "Deleted is true once the add-on confirmed that the data is gone and\nthe grants were removed.",
|
||
"type": "boolean"
|
||
},
|
||
"resourceId": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"gateway.Grant": {
|
||
"type": "object",
|
||
"properties": {
|
||
"displayName": {
|
||
"type": "string",
|
||
"example": "Bob"
|
||
},
|
||
"role": {
|
||
"type": "string",
|
||
"enum": [
|
||
"viewer",
|
||
"editor"
|
||
],
|
||
"example": "viewer"
|
||
},
|
||
"userId": {
|
||
"description": "UserID is the immutable account identifier of the grantee.",
|
||
"type": "string",
|
||
"example": "4f1c"
|
||
}
|
||
}
|
||
},
|
||
"gateway.GrantList": {
|
||
"type": "object",
|
||
"properties": {
|
||
"grants": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/gateway.Grant"
|
||
}
|
||
},
|
||
"resourceId": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"gateway.OperationStatus": {
|
||
"type": "object",
|
||
"properties": {
|
||
"operationId": {
|
||
"type": "string"
|
||
},
|
||
"requestHash": {
|
||
"type": "string",
|
||
"example": "3f786850e387550fdab836ed7e6dc881de23001b3f786850e387550fdab836ed"
|
||
},
|
||
"state": {
|
||
"description": "State is pending, committed, rejected or unknown.",
|
||
"type": "string",
|
||
"enum": [
|
||
"pending",
|
||
"committed",
|
||
"rejected",
|
||
"unknown"
|
||
]
|
||
},
|
||
"tool": {
|
||
"description": "Tool and RequestHash name the request the operation ID was first\nused for, as the host recorded it when it dispatched the change (kind\napply only). They are absent when the host no longer holds the\nrequest, for example after a restart. Compare RequestHash with the\nhash of your own request before you believe a committed state.",
|
||
"type": "string",
|
||
"example": "rows-insert"
|
||
}
|
||
}
|
||
},
|
||
"gateway.PendingList": {
|
||
"type": "object",
|
||
"properties": {
|
||
"proposals": {
|
||
"description": "Proposals are the caller's own proposals that still wait for a human\ndecision, newest first. A proposal of another user is never listed.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/gateway.Proposal"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"gateway.Proposal": {
|
||
"type": "object",
|
||
"properties": {
|
||
"action": {
|
||
"type": "string"
|
||
},
|
||
"addonId": {
|
||
"type": "string"
|
||
},
|
||
"arguments": {
|
||
"description": "Arguments are the canonical stored arguments. They are the only\narguments that can ever be submitted for this proposal.",
|
||
"type": "object"
|
||
},
|
||
"blocked": {
|
||
"description": "Blocked reports that another operation on the resource has an\nunresolved outcome, so confirming is denied until it is resolved. The\noperation itself belongs to its proposer and is shown only to the\nresource's owner role, in the unresolved listing and in the denial.",
|
||
"type": "boolean"
|
||
},
|
||
"createdAt": {
|
||
"type": "string"
|
||
},
|
||
"digest": {
|
||
"description": "Digest binds a confirmation to exactly what was shown.",
|
||
"type": "string"
|
||
},
|
||
"effects": {
|
||
"$ref": "#/definitions/gateway.ProposalEffects"
|
||
},
|
||
"expiresAt": {
|
||
"type": "string"
|
||
},
|
||
"generation": {
|
||
"type": "integer"
|
||
},
|
||
"id": {
|
||
"description": "ID is the proposal identifier. It is the operation identifier of the\nstored operation, so a lost reply is always resolved by the same ID.",
|
||
"type": "string"
|
||
},
|
||
"operationId": {
|
||
"type": "string"
|
||
},
|
||
"reason": {
|
||
"description": "Reason says why a proposal is cancelled, expired or rejected.",
|
||
"type": "string"
|
||
},
|
||
"receipt": {
|
||
"description": "Receipt is present once the runtime answered.",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/contract.Receipt"
|
||
}
|
||
]
|
||
},
|
||
"resolution": {
|
||
"description": "Resolution is present once the resource owner stopped waiting for an\nunresolved outcome. It stays after a late receipt is recorded.",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/gateway.ProposalResolution"
|
||
}
|
||
]
|
||
},
|
||
"resourceId": {
|
||
"type": "string"
|
||
},
|
||
"revision": {
|
||
"description": "Revision is the schema and data revision the preview saw. The runtime\nrefuses the apply when it moved.",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/contract.Revision"
|
||
}
|
||
]
|
||
},
|
||
"state": {
|
||
"$ref": "#/definitions/gateway.ProposalState"
|
||
}
|
||
}
|
||
},
|
||
"gateway.ProposalEffects": {
|
||
"type": "object",
|
||
"properties": {
|
||
"count": {
|
||
"description": "Count is the exact number of effects the operation would have.",
|
||
"type": "integer"
|
||
},
|
||
"sample": {
|
||
"description": "Sample is a bounded excerpt of the effects, or the whole preview summary\nwhen the addon did not separate one.",
|
||
"type": "object"
|
||
}
|
||
}
|
||
},
|
||
"gateway.ProposalList": {
|
||
"type": "object",
|
||
"properties": {
|
||
"proposals": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/gateway.BlockingProposal"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"gateway.ProposalResolution": {
|
||
"type": "object",
|
||
"properties": {
|
||
"actorId": {
|
||
"description": "ActorID is the resource owner who acknowledged the unknown outcome.",
|
||
"type": "string"
|
||
},
|
||
"at": {
|
||
"description": "At is when the acknowledgement was recorded.",
|
||
"type": "string"
|
||
},
|
||
"reason": {
|
||
"description": "Reason is the owner's stated reason.",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"gateway.ProposalState": {
|
||
"type": "string",
|
||
"enum": [
|
||
"pending",
|
||
"cancelled",
|
||
"expired",
|
||
"executing",
|
||
"applied",
|
||
"rejected",
|
||
"outcome-unknown",
|
||
"abandoned-unknown"
|
||
],
|
||
"x-enum-varnames": [
|
||
"ProposalPending",
|
||
"ProposalCancelled",
|
||
"ProposalExpired",
|
||
"ProposalExecuting",
|
||
"ProposalApplied",
|
||
"ProposalRejected",
|
||
"ProposalOutcomeUnknown",
|
||
"ProposalAbandoned"
|
||
]
|
||
},
|
||
"gateway.RelayRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"digest": {
|
||
"description": "Digest names the installed package an asset belongs to: the lower-case\nhex of its sha256. Only the kind \"asset\" uses it.",
|
||
"type": "string"
|
||
},
|
||
"handle": {
|
||
"type": "string"
|
||
},
|
||
"kind": {
|
||
"type": "string"
|
||
},
|
||
"request": {
|
||
"$ref": "#/definitions/contract.Request"
|
||
}
|
||
}
|
||
},
|
||
"gateway.RenameResourceRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"generation": {
|
||
"type": "integer",
|
||
"example": 3
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"example": "Budget 2027"
|
||
},
|
||
"operationId": {
|
||
"type": "string",
|
||
"example": "rename-1"
|
||
},
|
||
"revision": {
|
||
"description": "Revision is the revision the caller listed. A moved revision is a\nstale denial and nothing is changed.",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/contract.Revision"
|
||
}
|
||
]
|
||
}
|
||
}
|
||
},
|
||
"gateway.ResourceInfo": {
|
||
"type": "object",
|
||
"properties": {
|
||
"addonId": {
|
||
"type": "string",
|
||
"example": "tables"
|
||
},
|
||
"id": {
|
||
"description": "ID is the opaque resource identifier.",
|
||
"type": "string",
|
||
"example": "r0123456789abcdef0123456789abcde"
|
||
},
|
||
"name": {
|
||
"description": "Name is the display name the add-on reported. It is empty when the\nadd-on could not answer in time.",
|
||
"type": "string",
|
||
"example": "Budget"
|
||
},
|
||
"owner": {
|
||
"description": "Owner is the display name of the owner, shown to people the resource\nis shared with. It is empty in local-owner mode.",
|
||
"type": "string",
|
||
"example": "Alice"
|
||
},
|
||
"revision": {
|
||
"description": "Revision is the schema and data revision the listing saw. It is\npresent for the owner role and goes back with a rename or a delete.",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/contract.Revision"
|
||
}
|
||
]
|
||
},
|
||
"role": {
|
||
"description": "Role is the caller's own role: viewer, editor or owner.",
|
||
"type": "string",
|
||
"enum": [
|
||
"viewer",
|
||
"editor",
|
||
"owner"
|
||
],
|
||
"example": "owner"
|
||
},
|
||
"sharedWith": {
|
||
"description": "SharedWith is the number of people the resource is shared with. It is\npresent for the owner role only.",
|
||
"type": "integer",
|
||
"example": 2
|
||
}
|
||
}
|
||
},
|
||
"gateway.ResourceList": {
|
||
"type": "object",
|
||
"properties": {
|
||
"addonId": {
|
||
"type": "string",
|
||
"example": "tables"
|
||
},
|
||
"generation": {
|
||
"description": "Generation is the installed generation the listing saw. Rename, delete\nand create carry it; a stale tab is denied.",
|
||
"type": "integer",
|
||
"example": 3
|
||
},
|
||
"noun": {
|
||
"description": "Noun is the singular word the add-on uses for its resources.",
|
||
"type": "string",
|
||
"example": "database"
|
||
},
|
||
"operations": {
|
||
"description": "Operations lists the management operations the add-on supports.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"enum": [
|
||
"create",
|
||
"rename",
|
||
"delete"
|
||
]
|
||
}
|
||
},
|
||
"resources": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/gateway.ResourceInfo"
|
||
}
|
||
},
|
||
"sharing": {
|
||
"description": "Sharing is false in local-owner mode, where nothing can be shared.",
|
||
"type": "boolean"
|
||
},
|
||
"truncated": {
|
||
"description": "Truncated says more resources exist than the bound lists.",
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"gateway.Selection": {
|
||
"type": "object",
|
||
"properties": {
|
||
"addonId": {
|
||
"type": "string",
|
||
"example": "tables"
|
||
},
|
||
"conversationId": {
|
||
"type": "string",
|
||
"example": "chat-1"
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"example": "Budget"
|
||
},
|
||
"resourceId": {
|
||
"type": "string",
|
||
"example": "r0123456789abcdef0123456789abcde"
|
||
},
|
||
"role": {
|
||
"type": "string",
|
||
"enum": [
|
||
"viewer",
|
||
"editor",
|
||
"owner"
|
||
]
|
||
}
|
||
}
|
||
},
|
||
"gateway.SelectionRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"resourceId": {
|
||
"description": "ResourceID is the resource to use in the conversation. The caller must\nhold at least the viewer role on it now.",
|
||
"type": "string",
|
||
"example": "r0123456789abcdef0123456789abcde"
|
||
}
|
||
}
|
||
},
|
||
"gateway.SetGrantRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"operationId": {
|
||
"description": "OperationID is optional. It is returned with outcome_unknown, and the\nchange is safe to repeat.",
|
||
"type": "string",
|
||
"example": "grant-1"
|
||
},
|
||
"role": {
|
||
"description": "Role is viewer or editor. The owner role cannot be granted.",
|
||
"type": "string",
|
||
"enum": [
|
||
"viewer",
|
||
"editor"
|
||
],
|
||
"example": "viewer"
|
||
}
|
||
}
|
||
},
|
||
"gateway.UserList": {
|
||
"type": "object",
|
||
"properties": {
|
||
"users": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/gateway.UserRef"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"gateway.UserRef": {
|
||
"type": "object",
|
||
"properties": {
|
||
"displayName": {
|
||
"type": "string",
|
||
"example": "Bob"
|
||
},
|
||
"id": {
|
||
"type": "string",
|
||
"example": "4f1c"
|
||
}
|
||
}
|
||
},
|
||
"library.Info": {
|
||
"type": "object",
|
||
"properties": {
|
||
"authReference": {
|
||
"type": "string"
|
||
},
|
||
"conflict": {
|
||
"description": "Conflict explains how this source clashes with another one, when it does.",
|
||
"type": "string"
|
||
},
|
||
"default": {
|
||
"type": "boolean"
|
||
},
|
||
"enabled": {
|
||
"description": "Enabled is what the host does with the source: false for a source that\nis turned off, removed, or a shipped default while the official\nlibraries are off. Suspended tells the last case apart.",
|
||
"type": "boolean"
|
||
},
|
||
"format": {
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"kind": {
|
||
"$ref": "#/definitions/catalog.Kind"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"policy": {
|
||
"$ref": "#/definitions/catalog.VerificationPolicy"
|
||
},
|
||
"refresh": {
|
||
"$ref": "#/definitions/catalog.RefreshState"
|
||
},
|
||
"removed": {
|
||
"type": "boolean"
|
||
},
|
||
"suspended": {
|
||
"type": "boolean"
|
||
},
|
||
"url": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"localai.APIInstructionResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"description": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"swagger_fragment": {
|
||
"type": "object",
|
||
"additionalProperties": {}
|
||
},
|
||
"tags": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"localai.AliasInfo": {
|
||
"type": "object",
|
||
"properties": {
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"target": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"localai.BackendLibraryInstallRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"name": {
|
||
"description": "Name is the backend name of the entry.",
|
||
"type": "string"
|
||
},
|
||
"sourceId": {
|
||
"description": "SourceID is the library the entry comes from.",
|
||
"type": "string"
|
||
},
|
||
"version": {
|
||
"description": "Version is the version or the channel of the entry.",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"localai.BrandingResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"favicon_url": {
|
||
"type": "string"
|
||
},
|
||
"instance_name": {
|
||
"type": "string"
|
||
},
|
||
"instance_tagline": {
|
||
"type": "string"
|
||
},
|
||
"logo_horizontal_url": {
|
||
"type": "string"
|
||
},
|
||
"logo_url": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"localai.FailoverChainsResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"chains": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/failover.ChainStatus"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"localai.FailoverPinRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"target": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"localai.GalleryBackend": {
|
||
"type": "object",
|
||
"properties": {
|
||
"force": {
|
||
"description": "Force reinstalls the backend even when it is already installed and\nrunnable. Off by default so apply stays idempotent for supervising\napps that ensure their backend on every boot.",
|
||
"type": "boolean"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"localai.GalleryModel": {
|
||
"type": "object",
|
||
"properties": {
|
||
"backend": {
|
||
"description": "Backend is the resolved backend engine for this model (e.g. \"llama-cpp\").\nPopulated at load time from overrides, inline config, or the URL-referenced config file.",
|
||
"type": "string"
|
||
},
|
||
"config_file": {
|
||
"description": "config_file is read in the situation where URL is blank - and therefore this is a base config.",
|
||
"type": "object",
|
||
"additionalProperties": {}
|
||
},
|
||
"description": {
|
||
"type": "string"
|
||
},
|
||
"files": {
|
||
"description": "AdditionalFiles are used to add additional files to the model",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/gallery.File"
|
||
}
|
||
},
|
||
"gallery": {
|
||
"description": "Gallery is a reference to the gallery which contains the model",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/config.Gallery"
|
||
}
|
||
]
|
||
},
|
||
"icon": {
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"installed": {
|
||
"description": "Installed is used to indicate if the model is installed or not",
|
||
"type": "boolean"
|
||
},
|
||
"license": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"overrides": {
|
||
"description": "Overrides are used to override the configuration of the model located at URL",
|
||
"type": "object",
|
||
"additionalProperties": {}
|
||
},
|
||
"size": {
|
||
"description": "Size is an optional hardcoded model size string (e.g. \"500MB\", \"14.5GB\").\nUsed when the size cannot be estimated automatically.",
|
||
"type": "string"
|
||
},
|
||
"tags": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"url": {
|
||
"type": "string"
|
||
},
|
||
"urls": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"variant": {
|
||
"description": "Variant installs one specific build of an entry that declares variants,\nnamed as it appears in the entry's ` + "`" + `variants` + "`" + ` list (see the ` + "`" + `variants` + "`" + `\nand ` + "`" + `auto_variant` + "`" + ` fields of the gallery listing). Leave it empty to let\nLocalAI auto-select the largest build this host can actually run.",
|
||
"type": "string"
|
||
},
|
||
"variants": {
|
||
"description": "Variants is an optional, UNORDERED list of alternative builds of the same\nmodel (other backends such as MLX or vLLM, other quantizations) that the\ninstaller may pick instead of this entry's own payload. Authoring is\ndeliberately dumb: name the models, and the selector works out which one\nthis host should get.\n\nThe entry itself is always the last resort, so an entry carrying variants\nstays a complete, installable entry and older LocalAI releases, which drop\nthis key, install it exactly as before.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/gallery.Variant"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"localai.LibrarySourcesResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"officialLibraries": {
|
||
"type": "boolean"
|
||
},
|
||
"sources": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/library.Info"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"localai.ModelResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"config": {},
|
||
"config_revision": {
|
||
"type": "string"
|
||
},
|
||
"details": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"error": {
|
||
"type": "string"
|
||
},
|
||
"filename": {
|
||
"type": "string"
|
||
},
|
||
"message": {
|
||
"type": "string"
|
||
},
|
||
"pending_cleanup": {
|
||
"type": "integer"
|
||
},
|
||
"success": {
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"localai.MotionSessionInfo": {
|
||
"type": "object",
|
||
"properties": {
|
||
"frames": {
|
||
"type": "integer"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"poses": {
|
||
"type": "integer"
|
||
},
|
||
"profile": {
|
||
"type": "string"
|
||
},
|
||
"time_origin": {
|
||
"type": "string"
|
||
},
|
||
"upload_accepted": {
|
||
"type": "integer"
|
||
},
|
||
"upload_dropped": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"localai.MotionSessionRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"profile": {
|
||
"type": "string"
|
||
},
|
||
"time_origin": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"localai.MotionTicketRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"origin": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"localai.TTSModelVoices": {
|
||
"type": "object",
|
||
"properties": {
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"voices": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/config.TTSVoice"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"localai.TTSVoicesResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"data": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/localai.TTSModelVoices"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"localai.UpdateMaxReplicasPerModelRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"value": {
|
||
"description": "Value is the new per-model replica cap on this node. Must be \u003e= 1.",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"localai.UpdateVRAMBudgetRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"value": {
|
||
"description": "Value is the VRAM cap (\"80%\" or \"12GB\"). Empty string clears the cap.",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"localai.VoiceProfileListResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"data": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/voiceprofile.Profile"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"middleware.TraceBucket": {
|
||
"type": "object",
|
||
"properties": {
|
||
"count": {
|
||
"type": "integer"
|
||
},
|
||
"errors": {
|
||
"type": "integer"
|
||
},
|
||
"start": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"middleware.TraceSummary": {
|
||
"type": "object",
|
||
"properties": {
|
||
"buckets": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/middleware.TraceBucket"
|
||
}
|
||
},
|
||
"errors": {
|
||
"type": "integer"
|
||
},
|
||
"p95_ms": {
|
||
"type": "integer"
|
||
},
|
||
"total": {
|
||
"type": "integer"
|
||
},
|
||
"window_hours": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"model.BackendLogLine": {
|
||
"type": "object",
|
||
"properties": {
|
||
"stream": {
|
||
"description": "\"stdout\" or \"stderr\"",
|
||
"type": "string"
|
||
},
|
||
"text": {
|
||
"type": "string"
|
||
},
|
||
"timestamp": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"modeladmin.VRAMRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"context_size": {
|
||
"type": "integer"
|
||
},
|
||
"gpu_layers": {
|
||
"type": "integer"
|
||
},
|
||
"kv_quant_bits": {
|
||
"type": "integer"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"modeladmin.VRAMResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"context_length": {
|
||
"type": "integer"
|
||
},
|
||
"context_note": {
|
||
"type": "string"
|
||
},
|
||
"model_max_context": {
|
||
"type": "integer"
|
||
},
|
||
"size_bytes": {
|
||
"type": "integer"
|
||
},
|
||
"size_display": {
|
||
"type": "string"
|
||
},
|
||
"vram_bytes": {
|
||
"type": "integer"
|
||
},
|
||
"vram_display": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"nodes.NodeModel": {
|
||
"type": "object",
|
||
"properties": {
|
||
"address": {
|
||
"description": "gRPC address for this replica's backend process",
|
||
"type": "string"
|
||
},
|
||
"backend_type": {
|
||
"description": "e.g. \"llama-cpp\"; used by reconciler to replicate loads",
|
||
"type": "string"
|
||
},
|
||
"cleanup_attempts": {
|
||
"type": "integer"
|
||
},
|
||
"cleanup_error": {
|
||
"type": "string"
|
||
},
|
||
"cleanup_next_retry_at": {
|
||
"type": "string"
|
||
},
|
||
"config_revision": {
|
||
"type": "string"
|
||
},
|
||
"created_at": {
|
||
"type": "string"
|
||
},
|
||
"effective_options_hash": {
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"in_flight": {
|
||
"description": "number of active requests on this replica",
|
||
"type": "integer"
|
||
},
|
||
"last_used": {
|
||
"type": "string"
|
||
},
|
||
"loading_by": {
|
||
"description": "frontend ID that triggered loading",
|
||
"type": "string"
|
||
},
|
||
"model_name": {
|
||
"type": "string"
|
||
},
|
||
"node_id": {
|
||
"type": "string"
|
||
},
|
||
"replica_index": {
|
||
"type": "integer"
|
||
},
|
||
"state": {
|
||
"description": "staging, loading, loaded, unloading, idle",
|
||
"type": "string"
|
||
},
|
||
"updated_at": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"proto.MemoryUsageData": {
|
||
"type": "object",
|
||
"properties": {
|
||
"breakdown": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "integer",
|
||
"format": "int64"
|
||
}
|
||
},
|
||
"total": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"proto.SpeakerEncoder": {
|
||
"type": "object",
|
||
"properties": {
|
||
"dimension": {
|
||
"type": "integer"
|
||
},
|
||
"family": {
|
||
"description": "embedding space of the encoder; empty when the backend cannot tell",
|
||
"type": "string"
|
||
},
|
||
"identity": {
|
||
"description": "sha256 of loaded GGUF bytes",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"proto.StatusResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"memory": {
|
||
"$ref": "#/definitions/proto.MemoryUsageData"
|
||
},
|
||
"speaker_encoder": {
|
||
"description": "trusted metadata from the loaded server encoder, never request data",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/proto.SpeakerEncoder"
|
||
}
|
||
]
|
||
},
|
||
"state": {
|
||
"$ref": "#/definitions/proto.StatusResponse_State"
|
||
}
|
||
}
|
||
},
|
||
"proto.StatusResponse_State": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"enum": [
|
||
0,
|
||
1,
|
||
2,
|
||
-1
|
||
],
|
||
"x-enum-varnames": [
|
||
"StatusResponse_UNINITIALIZED",
|
||
"StatusResponse_BUSY",
|
||
"StatusResponse_READY",
|
||
"StatusResponse_ERROR"
|
||
]
|
||
},
|
||
"proto.VADResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"segments": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/proto.VADSegment"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"proto.VADSegment": {
|
||
"type": "object",
|
||
"properties": {
|
||
"end": {
|
||
"type": "number"
|
||
},
|
||
"start": {
|
||
"type": "number"
|
||
}
|
||
}
|
||
},
|
||
"recovery.BackupInfo": {
|
||
"type": "object",
|
||
"properties": {
|
||
"addonId": {
|
||
"type": "string"
|
||
},
|
||
"created": {
|
||
"type": "string"
|
||
},
|
||
"digest": {
|
||
"type": "string"
|
||
},
|
||
"files": {
|
||
"type": "integer"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"mode": {
|
||
"description": "Mode and Version are the ownership mode and package version it holds.",
|
||
"type": "string"
|
||
},
|
||
"pinned": {
|
||
"description": "Pinned is set while the backup is the recovery copy of an upgrade.",
|
||
"type": "boolean"
|
||
},
|
||
"reason": {
|
||
"type": "string"
|
||
},
|
||
"size": {
|
||
"type": "integer"
|
||
},
|
||
"verification": {
|
||
"type": "string"
|
||
},
|
||
"verified": {
|
||
"type": "boolean"
|
||
},
|
||
"version": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"recovery.BackupReceipt": {
|
||
"type": "object",
|
||
"properties": {
|
||
"addonId": {
|
||
"type": "string"
|
||
},
|
||
"created": {
|
||
"type": "string"
|
||
},
|
||
"digest": {
|
||
"type": "string"
|
||
},
|
||
"files": {
|
||
"type": "integer"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"mode": {
|
||
"description": "Mode and Version are the ownership mode and package version it holds.",
|
||
"type": "string"
|
||
},
|
||
"pinned": {
|
||
"description": "Pinned is set while the backup is the recovery copy of an upgrade.",
|
||
"type": "boolean"
|
||
},
|
||
"reason": {
|
||
"type": "string"
|
||
},
|
||
"size": {
|
||
"type": "integer"
|
||
},
|
||
"verified": {
|
||
"type": "boolean"
|
||
},
|
||
"version": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"recovery.PurgeReceipt": {
|
||
"type": "object",
|
||
"properties": {
|
||
"addonId": {
|
||
"type": "string"
|
||
},
|
||
"at": {
|
||
"type": "string"
|
||
},
|
||
"resources": {
|
||
"type": "integer"
|
||
},
|
||
"scope": {
|
||
"$ref": "#/definitions/recovery.PurgeScope"
|
||
},
|
||
"warnings": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"recovery.PurgeScope": {
|
||
"type": "object",
|
||
"properties": {
|
||
"backups": {
|
||
"description": "Backups are the backups of the add-on.",
|
||
"type": "boolean"
|
||
},
|
||
"data": {
|
||
"description": "Data is the add-on's data directory and the owner's records of its\nresources, grants and conversation selections.",
|
||
"type": "boolean"
|
||
},
|
||
"recoveryCopies": {
|
||
"description": "RecoveryCopies are the data copies that restores and failed upgrades\nset aside.",
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"recovery.RestoreReceipt": {
|
||
"type": "object",
|
||
"properties": {
|
||
"actor": {
|
||
"type": "string"
|
||
},
|
||
"addonId": {
|
||
"type": "string"
|
||
},
|
||
"at": {
|
||
"type": "string"
|
||
},
|
||
"backupCreated": {
|
||
"type": "string"
|
||
},
|
||
"backupId": {
|
||
"type": "string"
|
||
},
|
||
"lostWrites": {
|
||
"description": "LostWrites counts the operations applied after the backup. Their\neffects are gone from the data.",
|
||
"type": "integer"
|
||
},
|
||
"policy": {
|
||
"$ref": "#/definitions/recovery.RestoreReport"
|
||
},
|
||
"previousCopy": {
|
||
"description": "PreviousCopy names the directory that holds the data that was replaced.\nIt stays until an administrator purges it.",
|
||
"type": "string"
|
||
},
|
||
"warnings": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"recovery.RestoreReport": {
|
||
"type": "object",
|
||
"properties": {
|
||
"grantsDropped": {
|
||
"type": "integer"
|
||
},
|
||
"grantsRestored": {
|
||
"type": "integer"
|
||
},
|
||
"historyTruncated": {
|
||
"description": "HistoryTruncated says the record of lowered access may have lost\nentries older than the backup, so no grant of the backup was restored.",
|
||
"type": "boolean"
|
||
},
|
||
"proposalsCancelled": {
|
||
"description": "ProposalsCancelled and ProposalsUnknown are the proposals of the add-on\nthat no longer can be confirmed, and the ones whose outcome is looked up\nby receipt and never applied again.",
|
||
"type": "integer"
|
||
},
|
||
"proposalsUnknown": {
|
||
"type": "integer"
|
||
},
|
||
"resourcesRestored": {
|
||
"type": "integer"
|
||
},
|
||
"resourcesSkipped": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"revoked": {
|
||
"description": "Revoked counts grants dropped or lowered because access was taken away\nafter the backup.",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"recovery.RetentionView": {
|
||
"type": "object",
|
||
"properties": {
|
||
"keep": {
|
||
"type": "integer"
|
||
},
|
||
"maxAgeSeconds": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"recovery.Status": {
|
||
"type": "object",
|
||
"properties": {
|
||
"addonId": {
|
||
"type": "string"
|
||
},
|
||
"backups": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/recovery.BackupInfo"
|
||
}
|
||
},
|
||
"lastRestore": {
|
||
"$ref": "#/definitions/recovery.RestoreReceipt"
|
||
},
|
||
"mode": {
|
||
"description": "Mode is the ownership mode of the owner: named-user or local-owner.",
|
||
"type": "string"
|
||
},
|
||
"operations": {
|
||
"description": "Operations lists the operation IDs whose result is recorded, so a\ncaller that lost an answer can see that its request ran.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"phase": {
|
||
"description": "Phase is the phase of an upgrade or restore in progress.",
|
||
"type": "string"
|
||
},
|
||
"previousCopies": {
|
||
"description": "PreviousCopies counts the data copies a restore set aside.",
|
||
"type": "integer"
|
||
},
|
||
"reason": {
|
||
"type": "string"
|
||
},
|
||
"recoveryBackup": {
|
||
"description": "RecoveryBackup names the copy to restore from.",
|
||
"type": "string"
|
||
},
|
||
"retention": {
|
||
"description": "Retention is the policy applied to the backups.",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/recovery.RetentionView"
|
||
}
|
||
]
|
||
},
|
||
"state": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.APIError": {
|
||
"type": "object",
|
||
"properties": {
|
||
"code": {},
|
||
"message": {
|
||
"type": "string"
|
||
},
|
||
"param": {
|
||
"type": "string"
|
||
},
|
||
"type": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.AnimationInput": {
|
||
"type": "object",
|
||
"properties": {
|
||
"data": {
|
||
"type": "string"
|
||
},
|
||
"type": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.AnthropicContentBlock": {
|
||
"type": "object",
|
||
"properties": {
|
||
"content": {},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"input": {
|
||
"type": "object",
|
||
"additionalProperties": {}
|
||
},
|
||
"is_error": {
|
||
"type": "boolean"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"signature": {
|
||
"type": "string"
|
||
},
|
||
"source": {
|
||
"$ref": "#/definitions/schema.AnthropicImageSource"
|
||
},
|
||
"text": {
|
||
"type": "string"
|
||
},
|
||
"thinking": {
|
||
"type": "string"
|
||
},
|
||
"tool_use_id": {
|
||
"type": "string"
|
||
},
|
||
"type": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.AnthropicImageSource": {
|
||
"type": "object",
|
||
"properties": {
|
||
"data": {
|
||
"type": "string"
|
||
},
|
||
"media_type": {
|
||
"type": "string"
|
||
},
|
||
"type": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.AnthropicMessage": {
|
||
"type": "object",
|
||
"properties": {
|
||
"content": {},
|
||
"role": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.AnthropicRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"max_tokens": {
|
||
"type": "integer"
|
||
},
|
||
"messages": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.AnthropicMessage"
|
||
}
|
||
},
|
||
"metadata": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"stop_sequences": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"stream": {
|
||
"type": "boolean"
|
||
},
|
||
"system": {
|
||
"type": "string"
|
||
},
|
||
"temperature": {
|
||
"type": "number"
|
||
},
|
||
"thinking": {
|
||
"description": "Thinking gates extended-thinking output. We only surface thinking\ncontent blocks when the client explicitly opts in, matching Anthropic's\nAPI where thinking is off unless requested.",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/schema.AnthropicThinkingParam"
|
||
}
|
||
]
|
||
},
|
||
"tool_choice": {},
|
||
"tools": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.AnthropicTool"
|
||
}
|
||
},
|
||
"top_k": {
|
||
"type": "integer"
|
||
},
|
||
"top_p": {
|
||
"type": "number"
|
||
}
|
||
}
|
||
},
|
||
"schema.AnthropicResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"content": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.AnthropicContentBlock"
|
||
}
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"role": {
|
||
"type": "string"
|
||
},
|
||
"stop_reason": {
|
||
"type": "string"
|
||
},
|
||
"stop_sequence": {
|
||
"type": "string"
|
||
},
|
||
"type": {
|
||
"type": "string"
|
||
},
|
||
"usage": {
|
||
"$ref": "#/definitions/schema.AnthropicUsage"
|
||
}
|
||
}
|
||
},
|
||
"schema.AnthropicThinkingParam": {
|
||
"type": "object",
|
||
"properties": {
|
||
"budget_tokens": {
|
||
"type": "integer"
|
||
},
|
||
"type": {
|
||
"description": "\"enabled\" | \"disabled\"",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.AnthropicTool": {
|
||
"type": "object",
|
||
"properties": {
|
||
"description": {
|
||
"type": "string"
|
||
},
|
||
"input_schema": {
|
||
"type": "object",
|
||
"additionalProperties": {}
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.AnthropicUsage": {
|
||
"type": "object",
|
||
"properties": {
|
||
"input_tokens": {
|
||
"type": "integer"
|
||
},
|
||
"output_tokens": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.BackendMonitorRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"model": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.BackendResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"status_url": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.Choice": {
|
||
"type": "object",
|
||
"properties": {
|
||
"delta": {
|
||
"$ref": "#/definitions/schema.Message"
|
||
},
|
||
"finish_reason": {
|
||
"type": "string"
|
||
},
|
||
"index": {
|
||
"type": "integer"
|
||
},
|
||
"logprobs": {
|
||
"$ref": "#/definitions/schema.Logprobs"
|
||
},
|
||
"message": {
|
||
"$ref": "#/definitions/schema.Message"
|
||
},
|
||
"text": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.CompressionMetadata": {
|
||
"type": "object",
|
||
"properties": {
|
||
"compressed_tokens": {
|
||
"type": "integer"
|
||
},
|
||
"compressor": {
|
||
"type": "string"
|
||
},
|
||
"dropped_turns": {
|
||
"type": "integer"
|
||
},
|
||
"original_tokens": {
|
||
"type": "integer"
|
||
},
|
||
"overflow_recoveries": {
|
||
"type": "integer"
|
||
},
|
||
"summary_tokens": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.ConvTokenUsage": {
|
||
"type": "object",
|
||
"properties": {
|
||
"completion": {
|
||
"type": "integer"
|
||
},
|
||
"prompt": {
|
||
"type": "integer"
|
||
},
|
||
"total": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.Conversation": {
|
||
"type": "object",
|
||
"properties": {
|
||
"addonToolIds": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"addonTools": {
|
||
"type": "boolean"
|
||
},
|
||
"clientMCPServers": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object"
|
||
}
|
||
},
|
||
"contextSize": {
|
||
"type": "integer"
|
||
},
|
||
"createdAt": {
|
||
"type": "integer"
|
||
},
|
||
"history": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object"
|
||
}
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"localaiAssistant": {
|
||
"description": "LocalAIAssistant wires the chat to the in-process admin MCP server\n(the LocalAI Assistant mode of the Chat page).",
|
||
"type": "boolean"
|
||
},
|
||
"mcpMode": {
|
||
"type": "boolean"
|
||
},
|
||
"mcpResources": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"mcpServers": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"metadata": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"reasoningEffort": {
|
||
"description": "ReasoningEffort is the chat's reasoning_effort choice ('' = model config,\n'none' also hides reasoning traces).",
|
||
"type": "string"
|
||
},
|
||
"systemPrompt": {
|
||
"type": "string"
|
||
},
|
||
"temperature": {
|
||
"type": "number"
|
||
},
|
||
"tokenUsage": {
|
||
"$ref": "#/definitions/schema.ConvTokenUsage"
|
||
},
|
||
"topK": {
|
||
"type": "number"
|
||
},
|
||
"topP": {
|
||
"type": "number"
|
||
},
|
||
"updatedAt": {
|
||
"type": "integer"
|
||
},
|
||
"version": {
|
||
"description": "Version is assigned by the server: 1 on the first save, +1 on every\nlater write including the delete. Clients use a non-zero version to\ntell a conversation the server has seen from a never-synced draft.\nIgnored on input.",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.ConversationBulkRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"conversations": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.Conversation"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.ConversationBulkResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"count": {
|
||
"type": "integer"
|
||
},
|
||
"skipped": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"status": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ConversationList": {
|
||
"type": "object",
|
||
"properties": {
|
||
"conversations": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.Conversation"
|
||
}
|
||
},
|
||
"deleted": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.ConversationTombstone"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.ConversationTombstone": {
|
||
"type": "object",
|
||
"properties": {
|
||
"deletedAt": {
|
||
"description": "Unix milliseconds",
|
||
"type": "integer"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"version": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.DecisionAnswer": {
|
||
"type": "object",
|
||
"properties": {
|
||
"choice": {
|
||
"description": "Choice preserves the selected string or boolean value. Swagger 2 uses a loose object placeholder for this union.",
|
||
"type": "object"
|
||
},
|
||
"confidence": {
|
||
"type": "number"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"probabilities": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.DecisionProbability"
|
||
}
|
||
},
|
||
"probability": {
|
||
"type": "number"
|
||
},
|
||
"score": {
|
||
"type": "number"
|
||
},
|
||
"type": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.DecisionChoice": {
|
||
"type": "object",
|
||
"properties": {
|
||
"description": {
|
||
"type": "string"
|
||
},
|
||
"value": {
|
||
"description": "Value is a string or boolean choice. Swagger 2 uses a loose object placeholder for this union.",
|
||
"type": "object"
|
||
}
|
||
}
|
||
},
|
||
"schema.DecisionLevel": {
|
||
"type": "object",
|
||
"properties": {
|
||
"description": {
|
||
"type": "string"
|
||
},
|
||
"label": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.DecisionProbability": {
|
||
"type": "object",
|
||
"properties": {
|
||
"label": {
|
||
"type": "string"
|
||
},
|
||
"probability": {
|
||
"type": "number"
|
||
},
|
||
"value": {
|
||
"description": "Value is a string or boolean for choices, or a zero-based integer for score levels. Swagger 2 uses a loose object placeholder for this union.",
|
||
"type": "object"
|
||
}
|
||
}
|
||
},
|
||
"schema.DecisionQuestion": {
|
||
"type": "object",
|
||
"properties": {
|
||
"choices": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.DecisionChoice"
|
||
}
|
||
},
|
||
"instructions": {
|
||
"type": "string"
|
||
},
|
||
"levels": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.DecisionLevel"
|
||
}
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"type": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.DecisionUsage": {
|
||
"type": "object",
|
||
"properties": {
|
||
"input_tokens": {
|
||
"type": "integer"
|
||
},
|
||
"input_tokens_details": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
"output_tokens": {
|
||
"type": "integer"
|
||
},
|
||
"output_tokens_details": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
"total_tokens": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.DecisionsRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"input": {
|
||
"description": "Input is a text string or an array of user messages. Swagger 2 uses a loose object placeholder for this union.",
|
||
"type": "object"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"questions": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.DecisionQuestion"
|
||
}
|
||
},
|
||
"safety_identifier": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.DecisionsResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"answers": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.DecisionAnswer"
|
||
}
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"usage": {
|
||
"$ref": "#/definitions/schema.DecisionUsage"
|
||
}
|
||
}
|
||
},
|
||
"schema.DepthRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"dst": {
|
||
"description": "optional output directory for exports (glb/colmap)",
|
||
"type": "string"
|
||
},
|
||
"exports": {
|
||
"description": "requested exports: \"glb\", \"colmap\"",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"image": {
|
||
"description": "URL or base64-encoded image to analyze",
|
||
"type": "string"
|
||
},
|
||
"include_confidence": {
|
||
"description": "return the per-pixel confidence map (DualDPT)",
|
||
"type": "boolean"
|
||
},
|
||
"include_depth": {
|
||
"description": "return the per-pixel depth map",
|
||
"type": "boolean"
|
||
},
|
||
"include_points": {
|
||
"description": "back-project to a 3D point cloud (DualDPT)",
|
||
"type": "boolean"
|
||
},
|
||
"include_pose": {
|
||
"description": "return camera extrinsics/intrinsics (DualDPT)",
|
||
"type": "boolean"
|
||
},
|
||
"include_sky": {
|
||
"description": "return the per-pixel sky map (mono models)",
|
||
"type": "boolean"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"points_conf_thresh": {
|
||
"description": "keep points with confidence \u003e= this threshold",
|
||
"type": "number"
|
||
}
|
||
}
|
||
},
|
||
"schema.DepthResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"confidence": {
|
||
"description": "width*height row-major confidence (DualDPT)",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "number"
|
||
}
|
||
},
|
||
"depth": {
|
||
"description": "width*height row-major metric depth",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "number"
|
||
}
|
||
},
|
||
"export_paths": {
|
||
"description": "paths written for the requested exports",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"extrinsics": {
|
||
"description": "12 floats, 3x4 row-major (world-to-camera)",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "number"
|
||
}
|
||
},
|
||
"height": {
|
||
"type": "integer"
|
||
},
|
||
"intrinsics": {
|
||
"description": "9 floats, 3x3 row-major",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "number"
|
||
}
|
||
},
|
||
"is_metric": {
|
||
"description": "depth is in metric units",
|
||
"type": "boolean"
|
||
},
|
||
"num_points": {
|
||
"description": "number of 3D points",
|
||
"type": "integer"
|
||
},
|
||
"point_colors": {
|
||
"description": "base64-encoded num_points*3 uint8 rgb",
|
||
"type": "string"
|
||
},
|
||
"points": {
|
||
"description": "num_points*3 xyz, world space",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "number"
|
||
}
|
||
},
|
||
"sky": {
|
||
"description": "width*height row-major sky map (mono)",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "number"
|
||
}
|
||
},
|
||
"width": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.Detection": {
|
||
"type": "object",
|
||
"properties": {
|
||
"class_name": {
|
||
"type": "string"
|
||
},
|
||
"confidence": {
|
||
"type": "number"
|
||
},
|
||
"height": {
|
||
"type": "number"
|
||
},
|
||
"mask": {
|
||
"description": "base64-encoded PNG segmentation mask",
|
||
"type": "string"
|
||
},
|
||
"width": {
|
||
"type": "number"
|
||
},
|
||
"x": {
|
||
"type": "number"
|
||
},
|
||
"y": {
|
||
"type": "number"
|
||
}
|
||
}
|
||
},
|
||
"schema.DetectionRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"boxes": {
|
||
"description": "Box coordinates as [x1,y1,x2,y2,...] quads",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "number"
|
||
}
|
||
},
|
||
"image": {
|
||
"description": "URL or base64-encoded image to analyze",
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"points": {
|
||
"description": "Point coordinates as [x,y,label,...] triples (label: 1=pos, 0=neg)",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "number"
|
||
}
|
||
},
|
||
"prompt": {
|
||
"description": "Text prompt (for SAM 3 PCS mode)",
|
||
"type": "string"
|
||
},
|
||
"threshold": {
|
||
"description": "Detection confidence threshold",
|
||
"type": "number"
|
||
}
|
||
}
|
||
},
|
||
"schema.DetectionResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"detections": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.Detection"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.DetokenizeRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"tokens": {
|
||
"description": "token IDs to convert back to text",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.DetokenizeResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"content": {
|
||
"description": "detokenized text",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.DiarizationResult": {
|
||
"type": "object",
|
||
"properties": {
|
||
"duration": {
|
||
"type": "number"
|
||
},
|
||
"language": {
|
||
"type": "string"
|
||
},
|
||
"num_speakers": {
|
||
"type": "integer"
|
||
},
|
||
"segments": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.DiarizationSegment"
|
||
}
|
||
},
|
||
"sounds": {
|
||
"description": "Sounds is present only when the request set include_sounds. An empty\nlist then means the model ran and heard no event; omitzero keeps a nil\nlist (not requested) out of the payload while an empty one stays.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.DiarizationSound"
|
||
}
|
||
},
|
||
"speaker_profiles": {
|
||
"$ref": "#/definitions/schema.SpeakerProfiles"
|
||
},
|
||
"speakers": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.DiarizationSpeaker"
|
||
}
|
||
},
|
||
"task": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.DiarizationSegment": {
|
||
"type": "object",
|
||
"properties": {
|
||
"end": {
|
||
"type": "number"
|
||
},
|
||
"id": {
|
||
"type": "integer"
|
||
},
|
||
"label": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"description": "Name is the registered speaker this segment was matched to, and NameScore\nthe cosine similarity of the match. Both are omitted when the backend did\nnot identify the speaker. Speaker stays the normalized SPEAKER_NN label.",
|
||
"type": "string"
|
||
},
|
||
"name_score": {
|
||
"type": "number"
|
||
},
|
||
"speaker": {
|
||
"type": "string"
|
||
},
|
||
"start": {
|
||
"type": "number"
|
||
},
|
||
"text": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.DiarizationSound": {
|
||
"type": "object",
|
||
"properties": {
|
||
"confidence": {
|
||
"type": "number"
|
||
},
|
||
"end": {
|
||
"type": "number"
|
||
},
|
||
"label": {
|
||
"type": "string"
|
||
},
|
||
"start": {
|
||
"type": "number"
|
||
}
|
||
}
|
||
},
|
||
"schema.DiarizationSpeaker": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"label": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"segment_count": {
|
||
"type": "integer"
|
||
},
|
||
"total_speech_duration": {
|
||
"type": "number"
|
||
}
|
||
}
|
||
},
|
||
"schema.ElevenLabsSoundGenerationRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"bpm": {
|
||
"type": "integer"
|
||
},
|
||
"caption": {
|
||
"type": "string"
|
||
},
|
||
"do_sample": {
|
||
"type": "boolean"
|
||
},
|
||
"duration_seconds": {
|
||
"type": "number"
|
||
},
|
||
"expansion_model": {
|
||
"type": "string"
|
||
},
|
||
"instrumental": {
|
||
"description": "Simple mode: use text as description; optional instrumental / vocal_language",
|
||
"type": "boolean"
|
||
},
|
||
"keyscale": {
|
||
"type": "string"
|
||
},
|
||
"language": {
|
||
"type": "string"
|
||
},
|
||
"lyrics": {
|
||
"type": "string"
|
||
},
|
||
"model_id": {
|
||
"type": "string"
|
||
},
|
||
"params": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"prompt_influence": {
|
||
"type": "number"
|
||
},
|
||
"text": {
|
||
"type": "string"
|
||
},
|
||
"think": {
|
||
"description": "Advanced mode",
|
||
"type": "boolean"
|
||
},
|
||
"timesignature": {
|
||
"type": "string"
|
||
},
|
||
"vocal_language": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ErrorResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"error": {
|
||
"$ref": "#/definitions/schema.APIError"
|
||
}
|
||
}
|
||
},
|
||
"schema.FaceAnalysis": {
|
||
"type": "object",
|
||
"properties": {
|
||
"age": {
|
||
"type": "number"
|
||
},
|
||
"antispoof_score": {
|
||
"type": "number"
|
||
},
|
||
"dominant_emotion": {
|
||
"type": "string"
|
||
},
|
||
"dominant_gender": {
|
||
"type": "string"
|
||
},
|
||
"dominant_race": {
|
||
"type": "string"
|
||
},
|
||
"emotion": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "number",
|
||
"format": "float32"
|
||
}
|
||
},
|
||
"face_confidence": {
|
||
"type": "number"
|
||
},
|
||
"gender": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "number",
|
||
"format": "float32"
|
||
}
|
||
},
|
||
"is_real": {
|
||
"description": "Liveness fields — see FaceVerifyResponse for why these are pointers.",
|
||
"type": "boolean"
|
||
},
|
||
"race": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "number",
|
||
"format": "float32"
|
||
}
|
||
},
|
||
"region": {
|
||
"$ref": "#/definitions/schema.FacialArea"
|
||
}
|
||
}
|
||
},
|
||
"schema.FaceAnalyzeRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"actions": {
|
||
"description": "subset of {\"age\",\"gender\",\"emotion\",\"race\"}",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"anti_spoofing": {
|
||
"type": "boolean"
|
||
},
|
||
"img": {
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.FaceAnalyzeResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"faces": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.FaceAnalysis"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.FaceEmbedRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"img": {
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.FaceEmbedResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"dim": {
|
||
"type": "integer"
|
||
},
|
||
"embedding": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "number"
|
||
}
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.FaceForgetRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"store": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.FaceIdentifyMatch": {
|
||
"type": "object",
|
||
"properties": {
|
||
"confidence": {
|
||
"type": "number"
|
||
},
|
||
"distance": {
|
||
"type": "number"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"labels": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"match": {
|
||
"description": "true when distance \u003c= threshold",
|
||
"type": "boolean"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.FaceIdentifyRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"img": {
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"store": {
|
||
"type": "string"
|
||
},
|
||
"threshold": {
|
||
"description": "optional cutoff on distance",
|
||
"type": "number"
|
||
},
|
||
"top_k": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.FaceIdentifyResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"matches": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.FaceIdentifyMatch"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.FaceRegisterRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"embedding": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "number"
|
||
}
|
||
},
|
||
"img": {
|
||
"type": "string"
|
||
},
|
||
"labels": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"registered_at": {
|
||
"description": "original enrollment time when replaying a saved embedding",
|
||
"type": "string"
|
||
},
|
||
"store": {
|
||
"description": "vector store model; empty = local-store default",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.FaceRegisterResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"registered_at": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.FaceVerifyRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"anti_spoofing": {
|
||
"type": "boolean"
|
||
},
|
||
"img1": {
|
||
"type": "string"
|
||
},
|
||
"img2": {
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"threshold": {
|
||
"type": "number"
|
||
}
|
||
}
|
||
},
|
||
"schema.FaceVerifyResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"confidence": {
|
||
"type": "number"
|
||
},
|
||
"distance": {
|
||
"type": "number"
|
||
},
|
||
"img1_antispoof_score": {
|
||
"type": "number"
|
||
},
|
||
"img1_area": {
|
||
"$ref": "#/definitions/schema.FacialArea"
|
||
},
|
||
"img1_is_real": {
|
||
"description": "Liveness fields are only populated when the request set\nanti_spoofing=true. Pointers keep them fully absent from the\nJSON response otherwise, so callers can tell \"not checked\"\napart from \"checked and fake\" (which would collapse to zero\nvalues with plain bool+omitempty).",
|
||
"type": "boolean"
|
||
},
|
||
"img2_antispoof_score": {
|
||
"type": "number"
|
||
},
|
||
"img2_area": {
|
||
"$ref": "#/definitions/schema.FacialArea"
|
||
},
|
||
"img2_is_real": {
|
||
"type": "boolean"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"processing_time_ms": {
|
||
"type": "number"
|
||
},
|
||
"threshold": {
|
||
"type": "number"
|
||
},
|
||
"verified": {
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"schema.FacialArea": {
|
||
"type": "object",
|
||
"properties": {
|
||
"h": {
|
||
"type": "number"
|
||
},
|
||
"w": {
|
||
"type": "number"
|
||
},
|
||
"x": {
|
||
"type": "number"
|
||
},
|
||
"y": {
|
||
"type": "number"
|
||
}
|
||
}
|
||
},
|
||
"schema.FunctionCall": {
|
||
"type": "object",
|
||
"properties": {
|
||
"arguments": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.GalleryResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"estimated_size_bytes": {
|
||
"type": "integer"
|
||
},
|
||
"estimated_size_display": {
|
||
"type": "string"
|
||
},
|
||
"estimated_vram_bytes": {
|
||
"type": "integer"
|
||
},
|
||
"estimated_vram_display": {
|
||
"type": "string"
|
||
},
|
||
"status": {
|
||
"type": "string"
|
||
},
|
||
"uuid": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.InputTokensDetails": {
|
||
"type": "object",
|
||
"properties": {
|
||
"image_tokens": {
|
||
"type": "integer"
|
||
},
|
||
"text_tokens": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.Item": {
|
||
"type": "object",
|
||
"properties": {
|
||
"b64_json": {
|
||
"type": "string"
|
||
},
|
||
"index": {
|
||
"type": "integer"
|
||
},
|
||
"object": {
|
||
"type": "string"
|
||
},
|
||
"url": {
|
||
"description": "Images",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.JINADocumentResult": {
|
||
"type": "object",
|
||
"properties": {
|
||
"document": {
|
||
"$ref": "#/definitions/schema.JINAText"
|
||
},
|
||
"index": {
|
||
"type": "integer"
|
||
},
|
||
"relevance_score": {
|
||
"type": "number"
|
||
}
|
||
}
|
||
},
|
||
"schema.JINARerankRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"backend": {
|
||
"type": "string"
|
||
},
|
||
"documents": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"query": {
|
||
"type": "string"
|
||
},
|
||
"top_n": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.JINARerankResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"results": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.JINADocumentResult"
|
||
}
|
||
},
|
||
"usage": {
|
||
"$ref": "#/definitions/schema.JINAUsageInfo"
|
||
}
|
||
}
|
||
},
|
||
"schema.JINAText": {
|
||
"type": "object",
|
||
"properties": {
|
||
"text": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.JINAUsageInfo": {
|
||
"type": "object",
|
||
"properties": {
|
||
"prompt_tokens": {
|
||
"type": "integer"
|
||
},
|
||
"total_tokens": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.Job": {
|
||
"type": "object",
|
||
"properties": {
|
||
"audios": {
|
||
"description": "List of audio URLs or base64 strings",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"completed_at": {
|
||
"type": "string"
|
||
},
|
||
"created_at": {
|
||
"type": "string"
|
||
},
|
||
"error": {
|
||
"description": "Error message if failed",
|
||
"type": "string"
|
||
},
|
||
"files": {
|
||
"description": "List of file URLs or base64 strings",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"id": {
|
||
"description": "UUID",
|
||
"type": "string"
|
||
},
|
||
"images": {
|
||
"description": "Multimedia content (for manual execution)\nCan contain URLs or base64-encoded data URIs",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"parameters": {
|
||
"description": "Template parameters",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"result": {
|
||
"description": "Agent response",
|
||
"type": "string"
|
||
},
|
||
"started_at": {
|
||
"type": "string"
|
||
},
|
||
"status": {
|
||
"description": "pending, running, completed, failed, cancelled",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/schema.JobStatus"
|
||
}
|
||
]
|
||
},
|
||
"task_id": {
|
||
"description": "Reference to Task",
|
||
"type": "string"
|
||
},
|
||
"traces": {
|
||
"description": "Execution traces (reasoning, tool calls, tool results)",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.JobTrace"
|
||
}
|
||
},
|
||
"triggered_by": {
|
||
"description": "\"manual\", \"cron\", \"api\"",
|
||
"type": "string"
|
||
},
|
||
"videos": {
|
||
"description": "List of video URLs or base64 strings",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"webhook_error": {
|
||
"description": "Error if webhook failed",
|
||
"type": "string"
|
||
},
|
||
"webhook_sent": {
|
||
"description": "Webhook delivery tracking",
|
||
"type": "boolean"
|
||
},
|
||
"webhook_sent_at": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.JobExecutionRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"audios": {
|
||
"description": "List of audio URLs or base64 strings",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"files": {
|
||
"description": "List of file URLs or base64 strings",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"images": {
|
||
"description": "Multimedia content (optional, for manual execution)\nCan contain URLs or base64-encoded data URIs",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"parameters": {
|
||
"description": "Optional, for templating",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"task_id": {
|
||
"description": "Required",
|
||
"type": "string"
|
||
},
|
||
"videos": {
|
||
"description": "List of video URLs or base64 strings",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.JobExecutionResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"job_id": {
|
||
"description": "unique job identifier",
|
||
"type": "string"
|
||
},
|
||
"status": {
|
||
"description": "initial status (pending)",
|
||
"type": "string"
|
||
},
|
||
"url": {
|
||
"description": "URL to poll for job status",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.JobStatus": {
|
||
"type": "string",
|
||
"enum": [
|
||
"pending",
|
||
"running",
|
||
"completed",
|
||
"failed",
|
||
"cancelled"
|
||
],
|
||
"x-enum-varnames": [
|
||
"JobStatusPending",
|
||
"JobStatusRunning",
|
||
"JobStatusCompleted",
|
||
"JobStatusFailed",
|
||
"JobStatusCancelled"
|
||
]
|
||
},
|
||
"schema.JobTrace": {
|
||
"type": "object",
|
||
"properties": {
|
||
"arguments": {
|
||
"description": "Tool arguments or result data",
|
||
"type": "object",
|
||
"additionalProperties": {}
|
||
},
|
||
"content": {
|
||
"description": "The actual trace content",
|
||
"type": "string"
|
||
},
|
||
"timestamp": {
|
||
"description": "When this trace occurred",
|
||
"type": "string"
|
||
},
|
||
"tool_name": {
|
||
"description": "Tool name (for tool_call/tool_result)",
|
||
"type": "string"
|
||
},
|
||
"type": {
|
||
"description": "\"reasoning\", \"tool_call\", \"tool_result\", \"status\"",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.KnownBackend": {
|
||
"type": "object",
|
||
"properties": {
|
||
"auto_detect": {
|
||
"type": "boolean"
|
||
},
|
||
"description": {
|
||
"type": "string"
|
||
},
|
||
"installed": {
|
||
"description": "Installed is true when the backend is currently present on disk — i.e. it\nappears in gallery.ListSystemBackends(systemState). Importer-registered or\ncurated pref-only backends default to false unless they also show up on\ndisk. The import form uses this to warn users that submitting an import\nmay trigger an automatic backend download.",
|
||
"type": "boolean"
|
||
},
|
||
"modality": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.LogprobContent": {
|
||
"type": "object",
|
||
"properties": {
|
||
"bytes": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
"id": {
|
||
"type": "integer"
|
||
},
|
||
"logprob": {
|
||
"type": "number"
|
||
},
|
||
"token": {
|
||
"type": "string"
|
||
},
|
||
"top_logprobs": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.LogprobContent"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.Logprobs": {
|
||
"type": "object",
|
||
"properties": {
|
||
"content": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.LogprobContent"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.LogprobsValue": {
|
||
"type": "object",
|
||
"properties": {
|
||
"enabled": {
|
||
"description": "true if logprobs should be returned",
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"schema.Message": {
|
||
"type": "object",
|
||
"properties": {
|
||
"content": {
|
||
"description": "The message content"
|
||
},
|
||
"function_call": {
|
||
"description": "A result of a function call"
|
||
},
|
||
"name": {
|
||
"description": "The message name (used for tools calls)",
|
||
"type": "string"
|
||
},
|
||
"reasoning": {
|
||
"description": "Reasoning content extracted from \u003cthinking\u003e...\u003c/thinking\u003e tags",
|
||
"type": "string"
|
||
},
|
||
"role": {
|
||
"description": "The message role",
|
||
"type": "string"
|
||
},
|
||
"tool_call_id": {
|
||
"type": "string"
|
||
},
|
||
"tool_calls": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.ToolCall"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.Model3DAnimationRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"inputs": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"$ref": "#/definitions/schema.AnimationInput"
|
||
}
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"params": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"response_format": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.Model3DRequest": {
|
||
"description": "3D asset generation request body. Generation is image-conditioned",
|
||
"type": "object",
|
||
"properties": {
|
||
"background": {
|
||
"description": "background handling: auto|keep|black|white",
|
||
"type": "string"
|
||
},
|
||
"cfg_scale": {
|
||
"description": "classifier-free guidance scale (backend default 7.5)",
|
||
"type": "number"
|
||
},
|
||
"image": {
|
||
"description": "conditioning image: URL, base64, or data URI (required)",
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"params": {
|
||
"description": "backend-specific generation parameters",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"quality": {
|
||
"description": "mesh pipeline: auto|coarse|512|1024",
|
||
"type": "string"
|
||
},
|
||
"response_format": {
|
||
"description": "output format (url or b64_json)",
|
||
"type": "string"
|
||
},
|
||
"seed": {
|
||
"description": "random seed; \u003c=0 picks a random seed",
|
||
"type": "integer"
|
||
},
|
||
"step": {
|
||
"description": "flow sampling steps (backend default 12)",
|
||
"type": "integer"
|
||
},
|
||
"texture_steps": {
|
||
"description": "texture flow sampling steps (backend default 12)",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.ModelCapabilities": {
|
||
"type": "object",
|
||
"properties": {
|
||
"capabilities": {
|
||
"description": "Capabilities are canonical usecase strings (e.g. chat, vision, transcript,\ntts, embeddings, image, video) plus the modifiers \"tools\" and \"thinking\".",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"context_size": {
|
||
"description": "ContextSize is the effective context window in tokens the backend will\nrun with: the configured context_size, or the default when unset. 0 means\nthe value is unknown (e.g. a loose file with no config). Clients can use\nthis to size their context budget for auto-compaction and pruning.",
|
||
"type": "integer"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"input_modalities": {
|
||
"description": "InputModalities is the subset of {text,image,audio,video} the model accepts.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"object": {
|
||
"type": "string"
|
||
},
|
||
"output_modalities": {
|
||
"description": "OutputModalities is the subset of {text,image,audio,video} the model produces.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"three_d_operations": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.ThreeDOperation"
|
||
}
|
||
},
|
||
"upscale_scale": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.ModelCapabilitiesResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"data": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.ModelCapabilities"
|
||
}
|
||
},
|
||
"object": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ModelLoadCancelRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"job_id": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ModelLoadCancelResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"current_job_id": {
|
||
"type": "string"
|
||
},
|
||
"job_id": {
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"retry_after": {
|
||
"type": "integer"
|
||
},
|
||
"state": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ModelLoadRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"model": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ModelLoadResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"loaded": {
|
||
"description": "Loaded lists the model names actually resident in memory after the call.\nFor a pipeline model these are its sub-models, not the pipeline name.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"message": {
|
||
"description": "Message is a short human-readable status (\"model loaded\", or an error).",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ModelLoadingStatus": {
|
||
"type": "object",
|
||
"properties": {
|
||
"bytes_sent": {
|
||
"type": "integer"
|
||
},
|
||
"cancel_requested": {
|
||
"description": "CancelRequested is true when an administrator cancelled the attempt.",
|
||
"type": "boolean"
|
||
},
|
||
"eta_seconds": {
|
||
"description": "ETASeconds is omitted rather than guessed until enough bytes have moved\nfor the observed rate to mean anything. A confidently wrong ETA on a\ntwenty-minute wait is worse than none.",
|
||
"type": "integer"
|
||
},
|
||
"file_index": {
|
||
"type": "integer"
|
||
},
|
||
"job_id": {
|
||
"description": "JobID names the load attempt. A cancel must quote it: it is the\nprecondition that keeps a cancel from hitting a replacement attempt.",
|
||
"type": "string"
|
||
},
|
||
"last_error": {
|
||
"description": "LastError is the cause of a failed attempt.",
|
||
"type": "string"
|
||
},
|
||
"lease_expires_in": {
|
||
"description": "LeaseExpiresIn is the seconds left on the owner's lease. It is negative\nwhen the lease already ran out, which means the owner is gone.",
|
||
"type": "integer"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"node": {
|
||
"type": "string"
|
||
},
|
||
"progress": {
|
||
"type": "number"
|
||
},
|
||
"retry_after": {
|
||
"description": "RetryAfter is the seconds until a new load may start, for a failed attempt.",
|
||
"type": "integer"
|
||
},
|
||
"state": {
|
||
"type": "string"
|
||
},
|
||
"stop_deadline": {
|
||
"type": "string"
|
||
},
|
||
"stopping": {
|
||
"description": "Stopping is true while the remote work of a failed attempt is not yet\nconfirmed ended. StopDeadline is when the model is released regardless.",
|
||
"type": "boolean"
|
||
},
|
||
"total_bytes": {
|
||
"type": "integer"
|
||
},
|
||
"total_files": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.ModelsDataResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"data": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.OpenAIModel"
|
||
}
|
||
},
|
||
"object": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ModerationRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"input": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ModerationResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"results": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.ModerationResult"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.ModerationResult": {
|
||
"type": "object",
|
||
"properties": {
|
||
"categories": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "boolean"
|
||
}
|
||
},
|
||
"category_applied_input_types": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"category_scores": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "number",
|
||
"format": "float64"
|
||
}
|
||
},
|
||
"flagged": {
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"schema.MultimediaSourceConfig": {
|
||
"type": "object",
|
||
"properties": {
|
||
"headers": {
|
||
"description": "Custom headers for HTTP request (e.g., Authorization)",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"type": {
|
||
"description": "\"image\", \"video\", \"audio\", \"file\"",
|
||
"type": "string"
|
||
},
|
||
"url": {
|
||
"description": "URL to fetch from",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.NodeData": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"lastSeen": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"serviceID": {
|
||
"type": "string"
|
||
},
|
||
"tunnelAddress": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ORAnnotation": {
|
||
"type": "object",
|
||
"properties": {
|
||
"end_index": {
|
||
"type": "integer"
|
||
},
|
||
"start_index": {
|
||
"type": "integer"
|
||
},
|
||
"title": {
|
||
"type": "string"
|
||
},
|
||
"type": {
|
||
"description": "url_citation",
|
||
"type": "string"
|
||
},
|
||
"url": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ORContentPart": {
|
||
"type": "object",
|
||
"properties": {
|
||
"annotations": {
|
||
"description": "REQUIRED for output_text - must always be present (use [])",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.ORAnnotation"
|
||
}
|
||
},
|
||
"detail": {
|
||
"description": "low|high|auto for images",
|
||
"type": "string"
|
||
},
|
||
"file_data": {
|
||
"type": "string"
|
||
},
|
||
"file_url": {
|
||
"type": "string"
|
||
},
|
||
"filename": {
|
||
"type": "string"
|
||
},
|
||
"image_url": {
|
||
"type": "string"
|
||
},
|
||
"logprobs": {
|
||
"description": "REQUIRED for output_text - must always be present (use [])",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.ORLogProb"
|
||
}
|
||
},
|
||
"refusal": {
|
||
"type": "string"
|
||
},
|
||
"text": {
|
||
"description": "REQUIRED for output_text - must always be present (even if empty)",
|
||
"type": "string"
|
||
},
|
||
"type": {
|
||
"description": "input_text|input_image|input_file|output_text|refusal",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ORError": {
|
||
"type": "object",
|
||
"properties": {
|
||
"code": {
|
||
"type": "string"
|
||
},
|
||
"message": {
|
||
"type": "string"
|
||
},
|
||
"param": {
|
||
"type": "string"
|
||
},
|
||
"type": {
|
||
"description": "invalid_request|not_found|server_error|model_error|too_many_requests",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ORFunctionTool": {
|
||
"type": "object",
|
||
"properties": {
|
||
"description": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"parameters": {
|
||
"type": "object",
|
||
"additionalProperties": {}
|
||
},
|
||
"strict": {
|
||
"description": "Always include in response",
|
||
"type": "boolean"
|
||
},
|
||
"type": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ORIncompleteDetails": {
|
||
"type": "object",
|
||
"properties": {
|
||
"reason": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ORInputTokensDetails": {
|
||
"type": "object",
|
||
"properties": {
|
||
"cached_tokens": {
|
||
"description": "Always include, even if 0",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.ORItemField": {
|
||
"type": "object",
|
||
"properties": {
|
||
"arguments": {
|
||
"type": "string"
|
||
},
|
||
"call_id": {
|
||
"description": "Function call fields",
|
||
"type": "string"
|
||
},
|
||
"content": {
|
||
"description": "string or []ORContentPart for messages"
|
||
},
|
||
"encrypted_content": {
|
||
"description": "Provider-specific encrypted content",
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"description": "Present for all output items",
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"output": {
|
||
"description": "Function call output fields"
|
||
},
|
||
"role": {
|
||
"description": "Message fields",
|
||
"type": "string"
|
||
},
|
||
"status": {
|
||
"description": "in_progress|completed|incomplete",
|
||
"type": "string"
|
||
},
|
||
"summary": {
|
||
"description": "Reasoning fields (for type == \"reasoning\")",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.ORContentPart"
|
||
}
|
||
},
|
||
"type": {
|
||
"description": "message|function_call|function_call_output|reasoning|item_reference",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ORLogProb": {
|
||
"type": "object",
|
||
"properties": {
|
||
"bytes": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
"logprob": {
|
||
"type": "number"
|
||
},
|
||
"token": {
|
||
"type": "string"
|
||
},
|
||
"top_logprobs": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.ORTopLogProb"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.OROutputTokensDetails": {
|
||
"type": "object",
|
||
"properties": {
|
||
"reasoning_tokens": {
|
||
"description": "Always include, even if 0",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.ORReasoning": {
|
||
"type": "object",
|
||
"properties": {
|
||
"effort": {
|
||
"type": "string"
|
||
},
|
||
"summary": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ORReasoningParam": {
|
||
"type": "object",
|
||
"properties": {
|
||
"effort": {
|
||
"description": "\"none\"|\"low\"|\"medium\"|\"high\"|\"xhigh\"",
|
||
"type": "string"
|
||
},
|
||
"summary": {
|
||
"description": "\"auto\"|\"concise\"|\"detailed\"",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ORResponseResource": {
|
||
"type": "object",
|
||
"properties": {
|
||
"background": {
|
||
"type": "boolean"
|
||
},
|
||
"completed_at": {
|
||
"description": "Required: present as number or null",
|
||
"type": "integer"
|
||
},
|
||
"created_at": {
|
||
"type": "integer"
|
||
},
|
||
"error": {
|
||
"description": "Always present, null if no error",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/schema.ORError"
|
||
}
|
||
]
|
||
},
|
||
"frequency_penalty": {
|
||
"type": "number"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"incomplete_details": {
|
||
"description": "Always present, null if complete",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/schema.ORIncompleteDetails"
|
||
}
|
||
]
|
||
},
|
||
"instructions": {
|
||
"type": "string"
|
||
},
|
||
"max_output_tokens": {
|
||
"type": "integer"
|
||
},
|
||
"max_tool_calls": {
|
||
"description": "nullable",
|
||
"type": "integer"
|
||
},
|
||
"metadata": {
|
||
"description": "Metadata and operational flags",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"object": {
|
||
"description": "always \"response\"",
|
||
"type": "string"
|
||
},
|
||
"output": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.ORItemField"
|
||
}
|
||
},
|
||
"parallel_tool_calls": {
|
||
"type": "boolean"
|
||
},
|
||
"presence_penalty": {
|
||
"type": "number"
|
||
},
|
||
"previous_response_id": {
|
||
"type": "string"
|
||
},
|
||
"prompt_cache_key": {
|
||
"description": "nullable",
|
||
"type": "string"
|
||
},
|
||
"reasoning": {
|
||
"description": "nullable",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/schema.ORReasoning"
|
||
}
|
||
]
|
||
},
|
||
"safety_identifier": {
|
||
"description": "Safety and caching",
|
||
"type": "string"
|
||
},
|
||
"service_tier": {
|
||
"type": "string"
|
||
},
|
||
"status": {
|
||
"description": "in_progress|completed|failed|incomplete",
|
||
"type": "string"
|
||
},
|
||
"store": {
|
||
"type": "boolean"
|
||
},
|
||
"temperature": {
|
||
"description": "Sampling parameters (always required)",
|
||
"type": "number"
|
||
},
|
||
"text": {
|
||
"description": "Text format configuration",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/schema.ORTextConfig"
|
||
}
|
||
]
|
||
},
|
||
"tool_choice": {},
|
||
"tools": {
|
||
"description": "Tool-related fields",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.ORFunctionTool"
|
||
}
|
||
},
|
||
"top_logprobs": {
|
||
"description": "Default to 0",
|
||
"type": "integer"
|
||
},
|
||
"top_p": {
|
||
"type": "number"
|
||
},
|
||
"truncation": {
|
||
"description": "Truncation and reasoning",
|
||
"type": "string"
|
||
},
|
||
"usage": {
|
||
"description": "Usage statistics",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/schema.ORUsage"
|
||
}
|
||
]
|
||
}
|
||
}
|
||
},
|
||
"schema.ORTextConfig": {
|
||
"type": "object",
|
||
"properties": {
|
||
"format": {
|
||
"$ref": "#/definitions/schema.ORTextFormat"
|
||
}
|
||
}
|
||
},
|
||
"schema.ORTextFormat": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"description": "\"text\" or \"json_schema\"",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ORTopLogProb": {
|
||
"type": "object",
|
||
"properties": {
|
||
"bytes": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
"logprob": {
|
||
"type": "number"
|
||
},
|
||
"token": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ORUsage": {
|
||
"type": "object",
|
||
"properties": {
|
||
"input_tokens": {
|
||
"type": "integer"
|
||
},
|
||
"input_tokens_details": {
|
||
"description": "Always present",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/schema.ORInputTokensDetails"
|
||
}
|
||
]
|
||
},
|
||
"output_tokens": {
|
||
"type": "integer"
|
||
},
|
||
"output_tokens_details": {
|
||
"description": "Always present",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/schema.OROutputTokensDetails"
|
||
}
|
||
]
|
||
},
|
||
"total_tokens": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.OpenAIModel": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"object": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.OpenAIRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"file"
|
||
],
|
||
"properties": {
|
||
"backend": {
|
||
"type": "string"
|
||
},
|
||
"batch": {
|
||
"description": "Custom parameters - not present in the OpenAI API",
|
||
"type": "integer"
|
||
},
|
||
"clip_skip": {
|
||
"description": "Diffusers",
|
||
"type": "integer"
|
||
},
|
||
"echo": {
|
||
"type": "boolean"
|
||
},
|
||
"encoding_format": {
|
||
"description": "Embedding encoding format: \"float\" (default) or \"base64\" (OpenAI Node.js SDK default)",
|
||
"type": "string"
|
||
},
|
||
"file": {
|
||
"description": "whisper",
|
||
"type": "string"
|
||
},
|
||
"files": {
|
||
"description": "Multiple input images for img2img or inpainting",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"frequency_penalty": {
|
||
"type": "number"
|
||
},
|
||
"function_call": {
|
||
"description": "might be a string or an object"
|
||
},
|
||
"functions": {
|
||
"description": "A list of available functions to call",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/functions.Function"
|
||
}
|
||
},
|
||
"grammar": {
|
||
"description": "A grammar to constrain the LLM output",
|
||
"type": "string"
|
||
},
|
||
"grammar_json_functions": {
|
||
"$ref": "#/definitions/functions.JSONFunctionStructure"
|
||
},
|
||
"ignore_eos": {
|
||
"type": "boolean"
|
||
},
|
||
"include_sounds": {
|
||
"type": "boolean"
|
||
},
|
||
"include_speaker_profiles": {
|
||
"type": "boolean"
|
||
},
|
||
"include_text": {
|
||
"type": "boolean"
|
||
},
|
||
"input": {},
|
||
"instruction": {
|
||
"description": "Edit endpoint",
|
||
"type": "string"
|
||
},
|
||
"language": {
|
||
"description": "Also part of the OpenAI official spec",
|
||
"type": "string"
|
||
},
|
||
"logit_bias": {
|
||
"description": "Map of token IDs to bias values (-100 to 100)",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "number",
|
||
"format": "float64"
|
||
}
|
||
},
|
||
"logprobs": {
|
||
"description": "OpenAI API logprobs parameters\nlogprobs: boolean - if true, returns log probabilities of each output token\ntop_logprobs: integer 0-20 - number of most likely tokens to return at each token position",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/schema.LogprobsValue"
|
||
}
|
||
]
|
||
},
|
||
"max_completion_tokens": {
|
||
"description": "MaxCompletionTokens is the modern alias for max_tokens\n(OpenAI deprecated max_tokens; gpt-5 / o-series reject it).\nAccepted on the wire so up-to-date clients can use the new\nname; the request middleware collapses it into Maxtokens so\ninternal code reads exactly one field.",
|
||
"type": "integer"
|
||
},
|
||
"max_tokens": {
|
||
"type": "integer"
|
||
},
|
||
"messages": {
|
||
"description": "Messages is read only by chat/completion API calls",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.Message"
|
||
}
|
||
},
|
||
"metadata": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"min_p": {
|
||
"type": "number"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"model_base_name": {
|
||
"type": "string"
|
||
},
|
||
"n": {
|
||
"description": "Also part of the OpenAI official spec. use it for returning multiple results",
|
||
"type": "integer"
|
||
},
|
||
"n_keep": {
|
||
"type": "integer"
|
||
},
|
||
"negative_prompt": {
|
||
"description": "NegativePrompt for image generation (matches Stable Diffusion WebUI /\nvLLM-Omni conventions). Combined, comma-separated, with any \"|\"-suffixed\nnegative tags in Prompt.",
|
||
"type": "string"
|
||
},
|
||
"negative_prompt_scale": {
|
||
"type": "number"
|
||
},
|
||
"pooling": {
|
||
"description": "Pooling is a LocalAI extension for /v1/embeddings: how the backend's\nper-token vectors are reduced to a single embedding. \"\" or \"backend\"\nleaves pooling to the inference backend (the pre-existing behavior);\n\"mean\", \"last\" and \"decayed_mean\" pool Go-side from raw per-token\nvectors (the backend must run with the \"pooling:none\" option, which\nmodel configs get automatically when this is set).",
|
||
"type": "string"
|
||
},
|
||
"pooling_half_life_tokens": {
|
||
"description": "PoolingHalfLifeTokens is a LocalAI extension for /v1/embeddings: the\nhalf-life (in tokens) of the \"decayed_mean\" pooling scheme — a token's\nweight halves every this-many positions counting back from the end of\nthe conversation. Defaults to 256 when unset.",
|
||
"type": "integer"
|
||
},
|
||
"presence_penalty": {
|
||
"type": "number"
|
||
},
|
||
"prompt": {
|
||
"description": "Prompt is read only by completion/image API calls"
|
||
},
|
||
"quality": {
|
||
"description": "Image (not supported by OpenAI)",
|
||
"type": "string"
|
||
},
|
||
"reasoning_effort": {
|
||
"type": "string"
|
||
},
|
||
"ref_images": {
|
||
"description": "Reference images for models that support them (e.g., Flux Kontext)",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"repeat_last_n": {
|
||
"type": "integer"
|
||
},
|
||
"repeat_penalty": {
|
||
"type": "number"
|
||
},
|
||
"response_format": {
|
||
"description": "whisper/image"
|
||
},
|
||
"rope_freq_base": {
|
||
"type": "number"
|
||
},
|
||
"rope_freq_scale": {
|
||
"type": "number"
|
||
},
|
||
"seed": {
|
||
"type": "integer"
|
||
},
|
||
"size": {
|
||
"description": "image",
|
||
"type": "string"
|
||
},
|
||
"step": {
|
||
"type": "integer"
|
||
},
|
||
"stop": {},
|
||
"stream": {
|
||
"type": "boolean"
|
||
},
|
||
"stream_options": {
|
||
"description": "StreamOptions opts into OpenAI streaming extensions, e.g. include_usage.",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/schema.StreamOptions"
|
||
}
|
||
]
|
||
},
|
||
"temperature": {
|
||
"type": "number"
|
||
},
|
||
"tfz": {
|
||
"type": "number"
|
||
},
|
||
"tokenizer": {
|
||
"description": "RWKV (?)",
|
||
"type": "string"
|
||
},
|
||
"tool_choice": {},
|
||
"tools": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/functions.Tool"
|
||
}
|
||
},
|
||
"top_k": {
|
||
"type": "integer"
|
||
},
|
||
"top_logprobs": {
|
||
"description": "Number of top logprobs per token (0-20)",
|
||
"type": "integer"
|
||
},
|
||
"top_p": {
|
||
"description": "Common options between all the API calls, part of the OpenAI spec",
|
||
"type": "number"
|
||
},
|
||
"translate": {
|
||
"description": "Only for audio transcription",
|
||
"type": "boolean"
|
||
},
|
||
"typical_p": {
|
||
"type": "number"
|
||
}
|
||
}
|
||
},
|
||
"schema.OpenAIResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"choices": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.Choice"
|
||
}
|
||
},
|
||
"created": {
|
||
"type": "integer"
|
||
},
|
||
"data": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.Item"
|
||
}
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"metadata": {
|
||
"type": "object"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"object": {
|
||
"type": "string"
|
||
},
|
||
"usage": {
|
||
"description": "Usage is intentionally a pointer with omitempty: per the OpenAI\nchat-completion streaming spec, intermediate chunks must not carry\na ` + "`" + `usage` + "`" + ` field. Marshalling a value-typed usage would emit\n` + "`" + `\"usage\":{\"prompt_tokens\":0,...}` + "`" + ` on every chunk and break\nOpenAI-SDK consumers that filter on a truthy ` + "`" + `result.usage` + "`" + `\n(continuedev/continue, Kilo Code, Roo Code, etc.).",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/schema.OpenAIUsage"
|
||
}
|
||
]
|
||
}
|
||
}
|
||
},
|
||
"schema.OpenAIUsage": {
|
||
"type": "object",
|
||
"properties": {
|
||
"completion_tokens": {
|
||
"type": "integer"
|
||
},
|
||
"compression_meta": {
|
||
"$ref": "#/definitions/schema.CompressionMetadata"
|
||
},
|
||
"input_tokens": {
|
||
"description": "Fields for image generation API compatibility",
|
||
"type": "integer"
|
||
},
|
||
"input_tokens_details": {
|
||
"$ref": "#/definitions/schema.InputTokensDetails"
|
||
},
|
||
"output_tokens": {
|
||
"type": "integer"
|
||
},
|
||
"prompt_tokens": {
|
||
"type": "integer"
|
||
},
|
||
"timing_prompt_processing": {
|
||
"description": "Extra timing data, disabled by default as is't not a part of OpenAI specification",
|
||
"type": "number"
|
||
},
|
||
"timing_token_generation": {
|
||
"type": "number"
|
||
},
|
||
"total_tokens": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.OpenResponsesRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"allowed_tools": {
|
||
"description": "Restrict which tools can be invoked",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"background": {
|
||
"description": "Run request in background",
|
||
"type": "boolean"
|
||
},
|
||
"frequency_penalty": {
|
||
"description": "Frequency penalty (-2.0 to 2.0)",
|
||
"type": "number"
|
||
},
|
||
"include": {
|
||
"description": "What to include in response",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"input": {
|
||
"description": "string or []ORItemParam"
|
||
},
|
||
"instructions": {
|
||
"type": "string"
|
||
},
|
||
"logit_bias": {
|
||
"description": "OpenAI-compatible extensions (not in Open Responses spec)",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "number",
|
||
"format": "float64"
|
||
}
|
||
},
|
||
"max_output_tokens": {
|
||
"type": "integer"
|
||
},
|
||
"max_tool_calls": {
|
||
"description": "Maximum number of tool calls",
|
||
"type": "integer"
|
||
},
|
||
"metadata": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"parallel_tool_calls": {
|
||
"description": "Allow parallel tool calls",
|
||
"type": "boolean"
|
||
},
|
||
"presence_penalty": {
|
||
"description": "Presence penalty (-2.0 to 2.0)",
|
||
"type": "number"
|
||
},
|
||
"previous_response_id": {
|
||
"type": "string"
|
||
},
|
||
"reasoning": {
|
||
"$ref": "#/definitions/schema.ORReasoningParam"
|
||
},
|
||
"service_tier": {
|
||
"description": "\"auto\"|\"default\"|priority hint",
|
||
"type": "string"
|
||
},
|
||
"store": {
|
||
"description": "Whether to store the response",
|
||
"type": "boolean"
|
||
},
|
||
"stream": {
|
||
"type": "boolean"
|
||
},
|
||
"temperature": {
|
||
"type": "number"
|
||
},
|
||
"text_format": {
|
||
"description": "Additional parameters from spec"
|
||
},
|
||
"tool_choice": {
|
||
"description": "\"auto\"|\"required\"|\"none\"|{type:\"function\",name:\"...\"}"
|
||
},
|
||
"tools": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.ORFunctionTool"
|
||
}
|
||
},
|
||
"top_logprobs": {
|
||
"description": "Number of top logprobs to return",
|
||
"type": "integer"
|
||
},
|
||
"top_p": {
|
||
"type": "number"
|
||
},
|
||
"truncation": {
|
||
"description": "\"auto\"|\"disabled\"",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.P2PNodesResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"federated_nodes": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.NodeData"
|
||
}
|
||
},
|
||
"llama_cpp_nodes": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.NodeData"
|
||
}
|
||
},
|
||
"mlx_nodes": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.NodeData"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.PIIAnalyzeRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"detectors": {
|
||
"description": "Detectors names the detector models to run (NER and/or pattern). Takes\nprecedence over Model.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"model": {
|
||
"description": "Model is a consuming model whose effective PII policy (own\npii.detectors, else the instance default detectors; PII must be\nenabled) is used when Detectors is empty.",
|
||
"type": "string"
|
||
},
|
||
"reveal": {
|
||
"description": "Reveal includes the per-entity hash_prefix in the response. Honoured\nonly for admin callers; ignored otherwise. The raw matched value is\nnever returned regardless.",
|
||
"type": "boolean"
|
||
},
|
||
"text": {
|
||
"description": "Text is the string to scan. Bounded only by the server's global HTTP\nbody limit.",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.PIIAnalyzeResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"blocked": {
|
||
"type": "boolean"
|
||
},
|
||
"correlation_id": {
|
||
"type": "string"
|
||
},
|
||
"entities": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.PIIEntity"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.PIIEntity": {
|
||
"type": "object",
|
||
"properties": {
|
||
"action": {
|
||
"type": "string"
|
||
},
|
||
"end": {
|
||
"type": "integer"
|
||
},
|
||
"entity_type": {
|
||
"type": "string"
|
||
},
|
||
"hash_prefix": {
|
||
"type": "string"
|
||
},
|
||
"score": {
|
||
"type": "number"
|
||
},
|
||
"source": {
|
||
"type": "string"
|
||
},
|
||
"start": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.PIIRedactResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"blocked": {
|
||
"type": "boolean"
|
||
},
|
||
"correlation_id": {
|
||
"type": "string"
|
||
},
|
||
"entities": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.PIIEntity"
|
||
}
|
||
},
|
||
"masked": {
|
||
"type": "boolean"
|
||
},
|
||
"redacted_text": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.RouterCorpusAddRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"entries": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.RouterCorpusEntry"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.RouterCorpusAddResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"added": {
|
||
"description": "Added is how many entries were embedded, persisted, and indexed.",
|
||
"type": "integer"
|
||
},
|
||
"label_counts": {
|
||
"description": "LabelCounts is the per-label exemplar count after the call.",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
"router": {
|
||
"type": "string"
|
||
},
|
||
"skipped": {
|
||
"description": "Skipped counts entries whose text was already in the corpus —\nduplicates are rejected rather than double-weighted.",
|
||
"type": "integer"
|
||
},
|
||
"total": {
|
||
"description": "Total is the corpus size after the call.",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.RouterCorpusClearResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"cleared": {
|
||
"type": "integer"
|
||
},
|
||
"router": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.RouterCorpusEntry": {
|
||
"type": "object",
|
||
"properties": {
|
||
"labels": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"text": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.RouterCorpusStatsResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"embedding_model": {
|
||
"type": "string"
|
||
},
|
||
"embedding_models": {
|
||
"description": "EmbeddingModels lists the embedder fingerprints present in the\npersisted corpus; more than one means part of the corpus is\npending re-embedding on the next load.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"label_counts": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "integer"
|
||
}
|
||
},
|
||
"router": {
|
||
"type": "string"
|
||
},
|
||
"store_name": {
|
||
"type": "string"
|
||
},
|
||
"total": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.RouterDecideNeighbor": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"labels": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"similarity": {
|
||
"type": "number"
|
||
}
|
||
}
|
||
},
|
||
"schema.RouterDecideRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"input": {
|
||
"description": "Input is the user-visible prompt text to classify. Required.\nSchema-shape extraction (chat-message concatenation, etc.) is\nthe caller's responsibility — matches the Probe contract used\nby the in-band middleware.",
|
||
"type": "string"
|
||
},
|
||
"router": {
|
||
"description": "Router is the name of the router model (a ModelConfig with a\n` + "`" + `router:` + "`" + ` block). Required.",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.RouterDecideResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"cache_similarity": {
|
||
"description": "CacheSimilarity carries the cosine similarity of the cache hit\n(0 when not cached).",
|
||
"type": "number"
|
||
},
|
||
"cached": {
|
||
"description": "Cached is true when the decision came from the L2 embedding\ncache rather than a fresh classifier run.",
|
||
"type": "boolean"
|
||
},
|
||
"candidate": {
|
||
"description": "Candidate is the model that would be routed to. Empty when no\ncandidate covers Labels AND no fallback is configured.",
|
||
"type": "string"
|
||
},
|
||
"classifier": {
|
||
"description": "Classifier is the classifier name that produced the decision\n(e.g. \"score\").",
|
||
"type": "string"
|
||
},
|
||
"fallback": {
|
||
"description": "Fallback is true when Candidate is the router's configured\nfallback because no candidate covered Labels. Lets callers\ndistinguish \"matched\" from \"fell back\" without comparing names.",
|
||
"type": "boolean"
|
||
},
|
||
"labels": {
|
||
"description": "Labels is the set of active policy labels.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"latency_ms": {
|
||
"description": "LatencyMs is the classifier's wall-clock cost.",
|
||
"type": "integer"
|
||
},
|
||
"nearest_similarity": {
|
||
"description": "NearestSimilarity is the cosine similarity of the closest KNN\ncorpus entry — populated by the knn classifier even when the\ndecision fell back because the probe was out of corpus range.\n0 for other classifiers.",
|
||
"type": "number"
|
||
},
|
||
"neighbors": {
|
||
"description": "Neighbors lists the corpus entries the knn classifier retrieved,\nby descending similarity, including ones below the similarity\ngate. Empty for other classifiers.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.RouterDecideNeighbor"
|
||
}
|
||
},
|
||
"router": {
|
||
"description": "Router echoes the requested router model.",
|
||
"type": "string"
|
||
},
|
||
"score": {
|
||
"description": "Score is the top label's softmax probability (the\nclassifier-side confidence signal).",
|
||
"type": "number"
|
||
}
|
||
}
|
||
},
|
||
"schema.SlotCacheRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"description": "restore only: an ID issued by a save for this model",
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"slot": {
|
||
"description": "slot id, 0 is the first slot",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.SlotCacheResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"action": {
|
||
"description": "\"save\" or \"restore\"",
|
||
"type": "string"
|
||
},
|
||
"duration_ms": {
|
||
"description": "time the backend spent",
|
||
"type": "number"
|
||
},
|
||
"id": {
|
||
"description": "issued by the save, sent back to restore",
|
||
"type": "string"
|
||
},
|
||
"message": {
|
||
"description": "for example the IDs a save pruned",
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"n_bytes": {
|
||
"description": "bytes written or read",
|
||
"type": "integer"
|
||
},
|
||
"n_tokens": {
|
||
"description": "tokens saved or restored",
|
||
"type": "integer"
|
||
},
|
||
"slot": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.SoundClassification": {
|
||
"type": "object",
|
||
"properties": {
|
||
"index": {
|
||
"type": "integer"
|
||
},
|
||
"label": {
|
||
"type": "string"
|
||
},
|
||
"score": {
|
||
"type": "number"
|
||
}
|
||
}
|
||
},
|
||
"schema.SoundClassificationResult": {
|
||
"type": "object",
|
||
"properties": {
|
||
"detections": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.SoundClassification"
|
||
}
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.SpeakerEncoder": {
|
||
"type": "object",
|
||
"properties": {
|
||
"dimension": {
|
||
"type": "integer"
|
||
},
|
||
"family": {
|
||
"description": "Family is the embedding space of the encoder. The server fills it from the\nloaded encoder; exported profiles do not carry it and it is not matched.",
|
||
"type": "string"
|
||
},
|
||
"identity": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.SpeakerProfile": {
|
||
"type": "object",
|
||
"properties": {
|
||
"clean_duration": {
|
||
"type": "number"
|
||
},
|
||
"embedding": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "number"
|
||
}
|
||
},
|
||
"intervals": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.SpeakerProfileInterval"
|
||
}
|
||
},
|
||
"speaker": {
|
||
"type": "integer"
|
||
},
|
||
"unavailable_reason": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.SpeakerProfileInterval": {
|
||
"type": "object",
|
||
"properties": {
|
||
"end": {
|
||
"type": "number"
|
||
},
|
||
"start": {
|
||
"type": "number"
|
||
}
|
||
}
|
||
},
|
||
"schema.SpeakerProfiles": {
|
||
"type": "object",
|
||
"properties": {
|
||
"encoder": {
|
||
"$ref": "#/definitions/schema.SpeakerEncoder"
|
||
},
|
||
"speakers": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.SpeakerProfile"
|
||
}
|
||
},
|
||
"version": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.StreamOptions": {
|
||
"type": "object",
|
||
"properties": {
|
||
"include_usage": {
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"schema.SysInfoModel": {
|
||
"type": "object",
|
||
"properties": {
|
||
"backend": {
|
||
"description": "Backend is the engine serving this model. The loader knows only the ID,\nso it is resolved from the model's config; empty when the model was\nloaded without one (a loose file, or a config since removed).",
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"process": {
|
||
"description": "Process is the backend process serving the model on this host. Absent\nwhen the model has no local process (a distributed worker holds it) or\nthe process could not be read.",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/schema.SysInfoProcess"
|
||
}
|
||
]
|
||
},
|
||
"size_vram": {
|
||
"description": "SizeVRAM is DRM-accounted resident device memory in bytes. Nil means\nthe backend process tree has no complete supported reading.",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.SysInfoProcess": {
|
||
"type": "object",
|
||
"properties": {
|
||
"cpu_percent": {
|
||
"description": "CPUPercent is the share of the whole host's CPU used since the previous\nreading, 0-100. Absent on the first reading of a process.",
|
||
"type": "number"
|
||
},
|
||
"memory_percent": {
|
||
"type": "number"
|
||
},
|
||
"pid": {
|
||
"type": "integer"
|
||
},
|
||
"rss_bytes": {
|
||
"description": "RSSBytes is resident host memory. Weights offloaded to a GPU are not\nin it.",
|
||
"type": "integer"
|
||
},
|
||
"started_at": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.SystemInformationResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"backends": {
|
||
"description": "available backend engines",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"loaded_models": {
|
||
"description": "currently loaded models",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.SysInfoModel"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.SystemOneAnswer": {
|
||
"type": "object",
|
||
"properties": {
|
||
"choice": {
|
||
"type": "string"
|
||
},
|
||
"confidence": {
|
||
"type": "number"
|
||
},
|
||
"entities": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.SystemOneEntity"
|
||
}
|
||
},
|
||
"legend": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"noul": {
|
||
"type": "number"
|
||
},
|
||
"probabilities": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "number",
|
||
"format": "float64"
|
||
}
|
||
},
|
||
"score": {
|
||
"type": "number"
|
||
},
|
||
"type": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.SystemOneEntity": {
|
||
"type": "object",
|
||
"properties": {
|
||
"confidence": {
|
||
"type": "number"
|
||
},
|
||
"end": {
|
||
"type": "integer"
|
||
},
|
||
"start": {
|
||
"type": "integer"
|
||
},
|
||
"text": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.SystemOnePermuteRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"n_perm": {
|
||
"type": "integer"
|
||
},
|
||
"question": {
|
||
"type": "string"
|
||
},
|
||
"request": {
|
||
"$ref": "#/definitions/schema.SystemOneRequest"
|
||
},
|
||
"seed": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.SystemOnePermuteResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"argmax_stable": {
|
||
"type": "boolean"
|
||
},
|
||
"runs": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.SystemOnePermuteRun"
|
||
}
|
||
},
|
||
"spread": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "number",
|
||
"format": "float64"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.SystemOnePermuteRun": {
|
||
"type": "object",
|
||
"properties": {
|
||
"choice": {
|
||
"type": "string"
|
||
},
|
||
"latency_ms": {
|
||
"type": "number"
|
||
},
|
||
"order": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"probabilities": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "number",
|
||
"format": "float64"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.SystemOneRequest": {
|
||
"type": "object"
|
||
},
|
||
"schema.SystemOneResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"answers": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"$ref": "#/definitions/schema.SystemOneAnswer"
|
||
}
|
||
},
|
||
"latency_ms": {
|
||
"type": "number"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"usage": {
|
||
"$ref": "#/definitions/schema.SystemOneUsage"
|
||
}
|
||
}
|
||
},
|
||
"schema.SystemOneUsage": {
|
||
"type": "object",
|
||
"properties": {
|
||
"input_tokens": {
|
||
"type": "integer"
|
||
},
|
||
"output_tokens": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.TTSRequest": {
|
||
"description": "TTS request body",
|
||
"type": "object",
|
||
"properties": {
|
||
"backend": {
|
||
"description": "backend engine override",
|
||
"type": "string"
|
||
},
|
||
"input": {
|
||
"description": "text input",
|
||
"type": "string"
|
||
},
|
||
"instructions": {
|
||
"description": "Instructions is a free-form, per-request style/voice description. It maps to\nthe OpenAI ` + "`" + `instructions` + "`" + ` field and is forwarded to the backend so expressive\nTTS models (e.g. Qwen3-TTS CustomVoice/VoiceDesign) can vary tone or designed\nvoice per request instead of only via the static YAML option.",
|
||
"type": "string"
|
||
},
|
||
"language": {
|
||
"description": "(optional) language to use with TTS model",
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"params": {
|
||
"description": "Params carries optional, backend-specific per-request generation parameters\n(LocalAI extension, e.g. Chatterbox exaggeration/cfg_weight/temperature).",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"response_format": {
|
||
"description": "(optional) output format",
|
||
"type": "string"
|
||
},
|
||
"sample_rate": {
|
||
"description": "(optional) desired output sample rate",
|
||
"type": "integer"
|
||
},
|
||
"speed": {
|
||
"description": "Speed is the OpenAI ` + "`" + `speed` + "`" + ` field (0.25-4.0). It is a pointer so an\nexplicit ` + "`" + `\"speed\": 0` + "`" + ` (invalid, rejected with 400) is distinguishable\nfrom an omitted field (left at the backend default). It is normalised\ninto Params[\"speed\"] so it reaches the backend over the same channel as\nthe other per-request generation parameters.",
|
||
"type": "number"
|
||
},
|
||
"stream": {
|
||
"description": "(optional) enable streaming TTS",
|
||
"type": "boolean"
|
||
},
|
||
"voice": {
|
||
"description": "voice audio file or speaker id",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.Task": {
|
||
"type": "object",
|
||
"properties": {
|
||
"created_at": {
|
||
"type": "string"
|
||
},
|
||
"cron": {
|
||
"description": "Optional cron expression",
|
||
"type": "string"
|
||
},
|
||
"cron_parameters": {
|
||
"description": "Parameters to use when executing cron jobs",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"description": {
|
||
"description": "Optional description",
|
||
"type": "string"
|
||
},
|
||
"enabled": {
|
||
"description": "Can be disabled without deletion",
|
||
"type": "boolean"
|
||
},
|
||
"id": {
|
||
"description": "UUID",
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"description": "Model name (must have MCP config)",
|
||
"type": "string"
|
||
},
|
||
"multimedia_sources": {
|
||
"description": "Multimedia sources (for cron jobs)\nURLs to fetch multimedia content from when cron job executes\nEach source can have custom headers for authentication/authorization",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.MultimediaSourceConfig"
|
||
}
|
||
},
|
||
"name": {
|
||
"description": "User-friendly name",
|
||
"type": "string"
|
||
},
|
||
"prompt": {
|
||
"description": "Template prompt (supports Go template .param syntax)",
|
||
"type": "string"
|
||
},
|
||
"updated_at": {
|
||
"type": "string"
|
||
},
|
||
"webhooks": {
|
||
"description": "Webhook configuration (for notifications).\nSupports multiple webhook endpoints.\nWebhooks can handle both success and failure cases using template variables:\n.Job (Job object), .Task (Task object), .Result (if successful),\n.Error (if failed), .Status (job status string).",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.WebhookConfig"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.ThreeDInput": {
|
||
"type": "object",
|
||
"properties": {
|
||
"label": {
|
||
"type": "string"
|
||
},
|
||
"max_bytes": {
|
||
"type": "integer"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"required": {
|
||
"type": "boolean"
|
||
},
|
||
"type": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.ThreeDOperation": {
|
||
"type": "object",
|
||
"properties": {
|
||
"endpoint": {
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"inputs": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.ThreeDInput"
|
||
}
|
||
},
|
||
"label": {
|
||
"type": "string"
|
||
},
|
||
"output": {
|
||
"type": "string"
|
||
},
|
||
"parameters": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.ThreeDParameter"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.ThreeDParameter": {
|
||
"type": "object",
|
||
"properties": {
|
||
"advanced": {
|
||
"type": "boolean"
|
||
},
|
||
"default": {
|
||
"type": "string"
|
||
},
|
||
"label": {
|
||
"type": "string"
|
||
},
|
||
"max": {
|
||
"type": "number"
|
||
},
|
||
"min": {
|
||
"type": "number"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"options": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"type": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.TokenizeRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"content": {
|
||
"description": "text to tokenize",
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.TokenizeResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"tokens": {
|
||
"description": "token IDs",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.ToolCall": {
|
||
"type": "object",
|
||
"properties": {
|
||
"function": {
|
||
"$ref": "#/definitions/schema.FunctionCall"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"index": {
|
||
"type": "integer"
|
||
},
|
||
"type": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.VADRequest": {
|
||
"description": "VAD request body",
|
||
"type": "object",
|
||
"properties": {
|
||
"audio": {
|
||
"description": "raw audio samples as float32 PCM",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "number"
|
||
}
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.VideoReference": {
|
||
"type": "object",
|
||
"properties": {
|
||
"audio": {
|
||
"description": "optional audio paired with this video",
|
||
"type": "string"
|
||
},
|
||
"fps": {
|
||
"description": "frame rate of the source frames; 0 means the backend default",
|
||
"type": "integer"
|
||
},
|
||
"frames": {
|
||
"description": "ordered frame images: URL, base64 or data URI",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.VideoRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"audio": {
|
||
"description": "URL or base64 audio for audio-conditioned generation",
|
||
"type": "string"
|
||
},
|
||
"cfg_scale": {
|
||
"description": "classifier-free guidance scale",
|
||
"type": "number"
|
||
},
|
||
"end_image": {
|
||
"description": "URL or base64 of the last frame",
|
||
"type": "string"
|
||
},
|
||
"fps": {
|
||
"description": "frames per second",
|
||
"type": "integer"
|
||
},
|
||
"height": {
|
||
"description": "output height in pixels",
|
||
"type": "integer"
|
||
},
|
||
"input_reference": {
|
||
"description": "reference image or video URL",
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"negative_prompt": {
|
||
"description": "things to avoid in the output",
|
||
"type": "string"
|
||
},
|
||
"num_frames": {
|
||
"description": "total number of frames to generate",
|
||
"type": "integer"
|
||
},
|
||
"params": {
|
||
"description": "backend-specific generation parameters",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"prompt": {
|
||
"description": "text description of the video to generate",
|
||
"type": "string"
|
||
},
|
||
"ref_audios": {
|
||
"description": "reference audio clips (WAV); exclusive with start_image/end_image",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"ref_images": {
|
||
"description": "reference images (URL, base64 or data URI); exclusive with start_image/end_image",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"ref_videos": {
|
||
"description": "reference videos as frame lists; exclusive with start_image/end_image",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.VideoReference"
|
||
}
|
||
},
|
||
"response_format": {
|
||
"description": "output format (url or b64_json)",
|
||
"type": "string"
|
||
},
|
||
"seconds": {
|
||
"description": "duration in seconds (alternative to num_frames)",
|
||
"type": "string"
|
||
},
|
||
"seed": {
|
||
"description": "random seed for reproducibility",
|
||
"type": "integer"
|
||
},
|
||
"size": {
|
||
"description": "WxH shorthand (e.g. \"512x512\")",
|
||
"type": "string"
|
||
},
|
||
"start_image": {
|
||
"description": "URL or base64 of the first frame",
|
||
"type": "string"
|
||
},
|
||
"step": {
|
||
"description": "number of diffusion steps",
|
||
"type": "integer"
|
||
},
|
||
"width": {
|
||
"description": "output width in pixels",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.VoiceAnalysis": {
|
||
"type": "object",
|
||
"properties": {
|
||
"age": {
|
||
"type": "number"
|
||
},
|
||
"dominant_emotion": {
|
||
"type": "string"
|
||
},
|
||
"dominant_gender": {
|
||
"type": "string"
|
||
},
|
||
"emotion": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "number",
|
||
"format": "float32"
|
||
}
|
||
},
|
||
"end": {
|
||
"type": "number"
|
||
},
|
||
"gender": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "number",
|
||
"format": "float32"
|
||
}
|
||
},
|
||
"start": {
|
||
"type": "number"
|
||
}
|
||
}
|
||
},
|
||
"schema.VoiceAnalyzeRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"actions": {
|
||
"description": "subset of {\"age\",\"gender\",\"emotion\"}",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"audio": {
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.VoiceAnalyzeResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"segments": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.VoiceAnalysis"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.VoiceEmbedRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"audio": {
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.VoiceEmbedResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"dim": {
|
||
"type": "integer"
|
||
},
|
||
"embedding": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "number"
|
||
}
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.VoiceForgetRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"store": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.VoiceIdentifyMatch": {
|
||
"type": "object",
|
||
"properties": {
|
||
"confidence": {
|
||
"type": "number"
|
||
},
|
||
"distance": {
|
||
"type": "number"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"labels": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"match": {
|
||
"type": "boolean"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.VoiceIdentifyRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"audio": {
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"store": {
|
||
"type": "string"
|
||
},
|
||
"threshold": {
|
||
"type": "number"
|
||
},
|
||
"top_k": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"schema.VoiceIdentifyResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"matches": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/schema.VoiceIdentifyMatch"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"schema.VoiceRegisterRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"audio": {
|
||
"type": "string"
|
||
},
|
||
"labels": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"speaker_profiles": {
|
||
"$ref": "#/definitions/schema.SpeakerProfiles"
|
||
},
|
||
"speaker_slot": {
|
||
"type": "integer"
|
||
},
|
||
"store": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.VoiceRegisterResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"registered_at": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"schema.VoiceVerifyRequest": {
|
||
"type": "object",
|
||
"properties": {
|
||
"anti_spoofing": {
|
||
"type": "boolean"
|
||
},
|
||
"audio1": {
|
||
"type": "string"
|
||
},
|
||
"audio2": {
|
||
"type": "string"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"threshold": {
|
||
"type": "number"
|
||
}
|
||
}
|
||
},
|
||
"schema.VoiceVerifyResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"confidence": {
|
||
"type": "number"
|
||
},
|
||
"distance": {
|
||
"type": "number"
|
||
},
|
||
"model": {
|
||
"type": "string"
|
||
},
|
||
"processing_time_ms": {
|
||
"type": "number"
|
||
},
|
||
"threshold": {
|
||
"type": "number"
|
||
},
|
||
"verified": {
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"schema.WebhookConfig": {
|
||
"type": "object",
|
||
"properties": {
|
||
"headers": {
|
||
"description": "Custom headers (e.g., Authorization)",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"method": {
|
||
"description": "HTTP method (POST, PUT, PATCH) - default: POST",
|
||
"type": "string"
|
||
},
|
||
"payload_template": {
|
||
"description": "Optional template for payload",
|
||
"type": "string"
|
||
},
|
||
"url": {
|
||
"description": "Webhook endpoint URL",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"updates.State": {
|
||
"type": "string",
|
||
"enum": [
|
||
"unknown",
|
||
"up-to-date",
|
||
"update-available",
|
||
"incompatible",
|
||
"check-failed",
|
||
"integrity-error"
|
||
],
|
||
"x-enum-varnames": [
|
||
"Unknown",
|
||
"UpToDate",
|
||
"UpdateAvailable",
|
||
"Incompatible",
|
||
"CheckFailed",
|
||
"IntegrityError"
|
||
]
|
||
},
|
||
"updates.Status": {
|
||
"type": "object",
|
||
"properties": {
|
||
"addonId": {
|
||
"type": "string",
|
||
"example": "notes"
|
||
},
|
||
"available": {
|
||
"description": "Available is true only for update-available.",
|
||
"type": "boolean"
|
||
},
|
||
"candidateDigest": {
|
||
"type": "string"
|
||
},
|
||
"candidateVersion": {
|
||
"type": "string",
|
||
"example": "1.1.0"
|
||
},
|
||
"channel": {
|
||
"type": "string",
|
||
"example": "development"
|
||
},
|
||
"checkedAt": {
|
||
"description": "CheckedAt is when the status was computed. LastSuccess is when the\nlibrary was last read successfully: a failed check keeps it, so the\npage can say how old the knowledge is.",
|
||
"type": "string"
|
||
},
|
||
"error": {
|
||
"description": "Error is the redacted class of a failed check.",
|
||
"type": "string",
|
||
"example": "refresh-failed"
|
||
},
|
||
"generation": {
|
||
"description": "Generation is the installed generation the status describes.",
|
||
"type": "integer",
|
||
"example": 1
|
||
},
|
||
"installedDigest": {
|
||
"type": "string"
|
||
},
|
||
"installedVersion": {
|
||
"type": "string",
|
||
"example": "1.0.0"
|
||
},
|
||
"lastSuccess": {
|
||
"type": "string"
|
||
},
|
||
"reasons": {
|
||
"description": "Reasons are the compatibility reasons of an incompatible or\nintegrity-error status.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"selection": {
|
||
"type": "string",
|
||
"example": "1.0.0"
|
||
},
|
||
"sourceId": {
|
||
"description": "SourceID, Channel and Selection are the library, channel and\nselection the add-on was installed from. They never change by themselves.",
|
||
"type": "string",
|
||
"example": "official"
|
||
},
|
||
"stale": {
|
||
"description": "Stale is true when the library data or the cached answer is older than\nthe time to live.",
|
||
"type": "boolean"
|
||
},
|
||
"state": {
|
||
"enum": [
|
||
"unknown",
|
||
"up-to-date",
|
||
"update-available",
|
||
"incompatible",
|
||
"check-failed",
|
||
"integrity-error"
|
||
],
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/updates.State"
|
||
}
|
||
],
|
||
"example": "update-available"
|
||
},
|
||
"throttled": {
|
||
"description": "Throttled is true when an explicit refresh was not performed because\none ran moments ago. The status is then the last one.",
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"voiceprofile.AudioMetadata": {
|
||
"type": "object",
|
||
"properties": {
|
||
"bit_depth": {
|
||
"type": "integer"
|
||
},
|
||
"channels": {
|
||
"type": "integer"
|
||
},
|
||
"duration_ms": {
|
||
"type": "integer"
|
||
},
|
||
"mime_type": {
|
||
"type": "string"
|
||
},
|
||
"sample_rate": {
|
||
"type": "integer"
|
||
},
|
||
"size_bytes": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"voiceprofile.Profile": {
|
||
"type": "object",
|
||
"properties": {
|
||
"audio": {
|
||
"$ref": "#/definitions/voiceprofile.AudioMetadata"
|
||
},
|
||
"consent_confirmed_at": {
|
||
"type": "string"
|
||
},
|
||
"created_at": {
|
||
"type": "string"
|
||
},
|
||
"description": {
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"language": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"references": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/voiceprofile.ReferenceMetadata"
|
||
}
|
||
},
|
||
"transcript": {
|
||
"type": "string"
|
||
},
|
||
"updated_at": {
|
||
"type": "string"
|
||
},
|
||
"voice": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"voiceprofile.ReferenceMetadata": {
|
||
"type": "object",
|
||
"properties": {
|
||
"audio": {
|
||
"$ref": "#/definitions/voiceprofile.AudioMetadata"
|
||
},
|
||
"transcript": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"securityDefinitions": {
|
||
"BearerAuth": {
|
||
"type": "apiKey",
|
||
"name": "Authorization",
|
||
"in": "header"
|
||
}
|
||
}
|
||
}`
|
||
|
||
// SwaggerInfo holds exported Swagger Info so clients can modify it
|
||
var SwaggerInfo = &swag.Spec{
|
||
Version: "2.0.0",
|
||
Host: "",
|
||
BasePath: "/",
|
||
Schemes: []string{"http", "https"},
|
||
Title: "LocalAI API",
|
||
Description: "The LocalAI Rest API.",
|
||
InfoInstanceName: "swagger",
|
||
SwaggerTemplate: docTemplate,
|
||
LeftDelim: "{{",
|
||
RightDelim: "}}",
|
||
}
|
||
|
||
func init() {
|
||
swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
|
||
}
|