2025-02-11 21:54:40 +00:00
// Package swagger Code generated by swaggo/swag. DO NOT EDIT
2024-03-29 21:29:33 +00:00
package swagger
import "github.com/swaggo/swag"
const docTemplate = ` {
"schemes" : { { marshal . Schemes } } ,
"swagger" : "2.0" ,
"info" : {
"description" : "{{escape .Description}}" ,
"title" : "{{.Title}}" ,
"contact" : {
2024-03-29 21:48:58 +00:00
"name" : "LocalAI" ,
"url" : "https://localai.io"
2024-03-29 21:29:33 +00:00
} ,
"license" : {
"name" : "MIT" ,
2024-03-29 21:48:58 +00:00
"url" : "https://raw.githubusercontent.com/mudler/LocalAI/master/LICENSE"
2024-03-29 21:29:33 +00:00
} ,
"version" : "{{.Version}}"
} ,
"host" : "{{.Host}}" ,
"basePath" : "{{.BasePath}}" ,
"paths" : {
2026-04-04 13:14:35 +00:00
"/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/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 captured backend traces (LLM calls, embeddings, TTS, etc.) in reverse chronological order" ,
"produces" : [
"application/json"
] ,
"tags" : [
"monitoring"
] ,
"summary" : "List backend operation traces" ,
"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/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/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
}
}
}
}
} ,
2026-04-11 20:31:36 +00:00
"/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"
}
}
}
}
} ,
2026-04-04 13:14:35 +00:00
"/api/models/vram-estimate" : {
"post" : {
"description" : "Estimates VRAM based on model weight files, context size, and GPU layers" ,
"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/localai.vramEstimateRequest"
}
}
] ,
"responses" : {
"200" : {
"description" : "VRAM estimate" ,
"schema" : {
"$ref" : "#/definitions/localai.vramEstimateResponse"
}
}
}
}
} ,
2026-04-11 06:38:55 +00:00
"/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"
}
}
}
}
} ,
2024-07-15 23:39:48 +00:00
"/api/p2p" : {
"get" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"p2p"
] ,
2024-07-15 23:39:48 +00:00
"summary" : "Returns available P2P nodes" ,
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/schema.P2PNodesResponse"
}
}
}
}
}
} ,
"/api/p2p/token" : {
"get" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"p2p"
] ,
2024-07-15 23:39:48 +00:00
"summary" : "Show the P2P token" ,
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
"type" : "string"
}
}
}
}
} ,
2026-04-04 13:14:35 +00:00
"/api/traces" : {
"get" : {
"description" : "Returns captured API exchange traces (request/response pairs) in reverse chronological order" ,
"produces" : [
"application/json"
] ,
"tags" : [
"monitoring"
] ,
"summary" : "List API request/response traces" ,
"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"
}
}
}
} ,
2024-07-18 11:42:45 +00:00
"/backend/monitor" : {
"get" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"monitoring"
] ,
2024-07-18 11:42:45 +00:00
"summary" : "Backend monitor endpoint" ,
"parameters" : [
{
"description" : "Backend statistics request" ,
"name" : "request" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/schema.BackendMonitorRequest"
}
}
] ,
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
"$ref" : "#/definitions/proto.StatusResponse"
}
}
}
}
} ,
"/backend/shutdown" : {
"post" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"monitoring"
] ,
"summary" : "Backend shutdown endpoint" ,
2024-07-18 11:42:45 +00:00
"parameters" : [
{
"description" : "Backend statistics request" ,
"name" : "request" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/schema.BackendMonitorRequest"
}
}
] ,
"responses" : { }
}
} ,
2025-07-31 14:22:27 +00:00
"/backends" : {
2024-07-18 11:42:45 +00:00
"get" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"backends"
] ,
2025-07-31 14:22:27 +00:00
"summary" : "List all Backends" ,
"responses" : {
"200" : {
"description" : "Response" ,
2024-07-18 11:42:45 +00:00
"schema" : {
2025-07-31 14:22:27 +00:00
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/gallery.GalleryBackend"
}
2024-07-18 11:42:45 +00:00
}
}
2025-07-31 14:22:27 +00:00
}
2024-07-18 11:42:45 +00:00
}
} ,
2025-07-31 14:22:27 +00:00
"/backends/apply" : {
2024-07-14 21:44:18 +00:00
"post" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"backends"
] ,
2025-07-31 14:22:27 +00:00
"summary" : "Install backends to LocalAI." ,
2024-07-14 21:44:18 +00:00
"parameters" : [
{
"description" : "query params" ,
"name" : "request" ,
"in" : "body" ,
"required" : true ,
"schema" : {
2025-07-31 14:22:27 +00:00
"$ref" : "#/definitions/localai.GalleryBackend"
2024-07-14 21:44:18 +00:00
}
}
] ,
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
2025-07-31 14:22:27 +00:00
"$ref" : "#/definitions/schema.BackendResponse"
2024-07-14 21:44:18 +00:00
}
}
}
}
} ,
2025-07-31 14:22:27 +00:00
"/backends/available" : {
2024-07-14 21:44:18 +00:00
"get" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"backends"
] ,
2025-07-31 14:22:27 +00:00
"summary" : "List all available Backends" ,
2024-07-14 21:44:18 +00:00
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
"type" : "array" ,
"items" : {
2025-07-31 14:22:27 +00:00
"$ref" : "#/definitions/gallery.GalleryBackend"
2024-07-14 21:44:18 +00:00
}
}
}
}
}
} ,
2025-07-31 14:22:27 +00:00
"/backends/delete/{name}" : {
2024-07-14 21:44:18 +00:00
"post" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"backends"
] ,
2025-07-31 14:22:27 +00:00
"summary" : "delete backends from LocalAI." ,
2024-07-14 21:44:18 +00:00
"parameters" : [
{
"type" : "string" ,
2025-07-31 14:22:27 +00:00
"description" : "Backend name" ,
2024-07-14 21:44:18 +00:00
"name" : "name" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
2025-07-31 14:22:27 +00:00
"$ref" : "#/definitions/schema.BackendResponse"
2024-07-14 21:44:18 +00:00
}
}
}
}
} ,
2025-07-31 14:22:27 +00:00
"/backends/galleries" : {
2024-07-14 21:44:18 +00:00
"get" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"backends"
] ,
2024-07-14 21:44:18 +00:00
"summary" : "List all Galleries" ,
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/config.Gallery"
}
}
}
}
2025-07-31 14:22:27 +00:00
}
} ,
"/backends/jobs" : {
"get" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"backends"
] ,
2025-07-31 14:22:27 +00:00
"summary" : "Returns all the jobs status progress" ,
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
"type" : "object" ,
"additionalProperties" : {
2026-03-30 21:48:06 +00:00
"$ref" : "#/definitions/galleryop.OpStatus"
2025-07-31 14:22:27 +00:00
}
}
}
}
}
} ,
"/backends/jobs/{uuid}" : {
"get" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"backends"
] ,
2025-07-31 14:22:27 +00:00
"summary" : "Returns the job status" ,
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
2026-03-30 21:48:06 +00:00
"$ref" : "#/definitions/galleryop.OpStatus"
2025-07-31 14:22:27 +00:00
}
}
}
}
} ,
2026-04-13 07:42:36 +00:00
"/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"
}
}
}
}
} ,
"/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"
}
}
}
}
}
} ,
2025-07-31 14:22:27 +00:00
"/metrics" : {
"get" : {
2026-04-04 13:14:35 +00:00
"produces" : [
"text/plain"
] ,
"tags" : [
"monitoring"
] ,
2025-07-31 14:22:27 +00:00
"summary" : "Prometheus metrics endpoint" ,
2026-04-04 13:14:35 +00:00
"responses" : {
"200" : {
"description" : "Prometheus metrics" ,
2024-07-14 21:44:18 +00:00
"schema" : {
2026-04-04 13:14:35 +00:00
"type" : "string"
2024-07-14 21:44:18 +00:00
}
}
2026-04-04 13:14:35 +00:00
}
2025-07-31 14:22:27 +00:00
}
} ,
"/models/apply" : {
"post" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"models"
] ,
2025-07-31 14:22:27 +00:00
"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"
}
}
}
}
} ,
"/models/available" : {
"get" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"models"
] ,
2025-07-31 14:22:27 +00:00
"summary" : "List installable models." ,
2024-07-14 21:44:18 +00:00
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
"type" : "array" ,
"items" : {
2026-04-04 13:14:35 +00:00
"$ref" : "#/definitions/gallery.Metadata"
2024-07-14 21:44:18 +00:00
}
}
}
}
2025-07-31 14:22:27 +00:00
}
} ,
"/models/delete/{name}" : {
"post" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"models"
] ,
2025-07-31 14:22:27 +00:00
"summary" : "delete models to LocalAI." ,
2024-07-14 21:44:18 +00:00
"parameters" : [
{
2025-07-31 14:22:27 +00:00
"type" : "string" ,
"description" : "Model name" ,
"name" : "name" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "Response" ,
2024-07-14 21:44:18 +00:00
"schema" : {
2025-07-31 14:22:27 +00:00
"$ref" : "#/definitions/schema.GalleryResponse"
2024-07-14 21:44:18 +00:00
}
}
2025-07-31 14:22:27 +00:00
}
}
} ,
"/models/galleries" : {
"get" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"models"
] ,
2025-07-31 14:22:27 +00:00
"summary" : "List all Galleries" ,
2024-07-14 21:44:18 +00:00
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/config.Gallery"
}
}
}
}
}
} ,
2024-07-18 11:42:45 +00:00
"/models/jobs" : {
"get" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"models"
] ,
2024-07-18 11:42:45 +00:00
"summary" : "Returns all the jobs status progress" ,
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
"type" : "object" ,
"additionalProperties" : {
2026-03-30 21:48:06 +00:00
"$ref" : "#/definitions/galleryop.OpStatus"
2024-07-18 11:42:45 +00:00
}
}
}
}
}
} ,
"/models/jobs/{uuid}" : {
"get" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"models"
] ,
2024-07-18 11:42:45 +00:00
"summary" : "Returns the job status" ,
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
2026-03-30 21:48:06 +00:00
"$ref" : "#/definitions/galleryop.OpStatus"
2024-07-18 11:42:45 +00:00
}
}
}
}
} ,
2024-09-05 22:21:24 +00:00
"/system" : {
"get" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"monitoring"
] ,
2024-09-05 22:21:24 +00:00
"summary" : "Show the LocalAI instance information" ,
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
"$ref" : "#/definitions/schema.SystemInformationResponse"
}
}
}
}
} ,
2024-11-14 21:36:53 +00:00
"/tokenMetrics" : {
"get" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"audio/x-wav"
] ,
2026-04-04 13:14:35 +00:00
"tags" : [
"tokenize"
] ,
2024-11-14 21:36:53 +00:00
"summary" : "Get TokenMetrics for Active Slot." ,
"responses" : {
"200" : {
"description" : "generated audio/wav file" ,
"schema" : {
"type" : "string"
}
}
}
}
} ,
2024-06-01 22:04:01 +00:00
"/tts" : {
"post" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"audio/x-wav"
] ,
2026-04-04 13:14:35 +00:00
"tags" : [
"audio"
] ,
2024-06-01 22:04:01 +00:00
"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"
}
}
}
}
} ,
2024-03-29 21:29:33 +00:00
"/v1/audio/speech" : {
"post" : {
2024-06-01 22:04:01 +00:00
"consumes" : [
"application/json"
] ,
"produces" : [
"audio/x-wav"
] ,
2026-04-04 13:14:35 +00:00
"tags" : [
"audio"
] ,
2024-03-29 21:29:33 +00:00
"summary" : "Generates audio from the input text." ,
"parameters" : [
{
"description" : "query params" ,
"name" : "request" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/schema.TTSRequest"
}
}
] ,
"responses" : {
"200" : {
2024-06-01 22:04:01 +00:00
"description" : "generated audio/wav file" ,
2024-03-29 21:29:33 +00:00
"schema" : {
"type" : "string"
}
}
}
}
} ,
"/v1/audio/transcriptions" : {
"post" : {
"consumes" : [
"multipart/form-data"
] ,
2026-04-04 13:14:35 +00:00
"tags" : [
"audio"
] ,
2024-03-29 21:29:33 +00:00
"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
2026-04-14 23:25:24 +00:00
} ,
{
"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"
2024-03-29 21:29:33 +00:00
}
] ,
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
"type" : "object" ,
"additionalProperties" : {
"type" : "string"
}
}
}
}
}
} ,
"/v1/chat/completions" : {
"post" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"inference"
] ,
2024-03-29 21:29:33 +00:00
"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" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"inference"
] ,
2024-03-29 21:29:33 +00:00
"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"
}
}
}
}
} ,
2025-07-31 14:22:27 +00:00
"/v1/detection" : {
2024-07-18 11:42:45 +00:00
"post" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"detection"
] ,
2025-07-31 14:22:27 +00:00
"summary" : "Detects objects in the input image." ,
2024-07-18 11:42:45 +00:00
"parameters" : [
{
"description" : "query params" ,
"name" : "request" ,
"in" : "body" ,
"required" : true ,
"schema" : {
2025-07-31 14:22:27 +00:00
"$ref" : "#/definitions/schema.DetectionRequest"
2024-07-18 11:42:45 +00:00
}
}
] ,
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
2025-07-31 14:22:27 +00:00
"$ref" : "#/definitions/schema.DetectionResponse"
2024-07-18 11:42:45 +00:00
}
}
}
}
} ,
2025-07-31 14:22:27 +00:00
"/v1/edits" : {
2024-03-29 21:29:33 +00:00
"post" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"inference"
] ,
2025-07-31 14:22:27 +00:00
"summary" : "OpenAI edit endpoint" ,
2024-03-29 21:29:33 +00:00
"parameters" : [
{
"description" : "query params" ,
"name" : "request" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/schema.OpenAIRequest"
}
}
] ,
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
"$ref" : "#/definitions/schema.OpenAIResponse"
}
}
}
}
} ,
2025-07-31 14:22:27 +00:00
"/v1/embeddings" : {
"post" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"embeddings"
] ,
2025-07-31 14:22:27 +00:00
"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 ,
2024-07-11 08:56:55 +00:00
"schema" : {
2025-07-31 14:22:27 +00:00
"$ref" : "#/definitions/schema.OpenAIRequest"
2024-07-11 08:56:55 +00:00
}
}
2025-07-31 14:22:27 +00:00
] ,
2024-07-11 08:56:55 +00:00
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
2025-07-31 14:22:27 +00:00
"$ref" : "#/definitions/schema.OpenAIResponse"
2024-07-11 08:56:55 +00:00
}
}
}
}
} ,
2024-03-29 21:29:33 +00:00
"/v1/images/generations" : {
"post" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"images"
] ,
2024-03-29 21:29:33 +00:00
"summary" : "Creates an image given a prompt." ,
"parameters" : [
{
"description" : "query params" ,
"name" : "request" ,
"in" : "body" ,
"required" : true ,
2025-11-15 20:50:30 +00:00
"schema" : {
"$ref" : "#/definitions/schema.OpenAIRequest"
}
}
] ,
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
"$ref" : "#/definitions/schema.OpenAIResponse"
}
}
}
}
} ,
2025-11-25 21:19:53 +00:00
"/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"
}
}
}
}
}
} ,
2025-11-15 20:50:30 +00:00
"/v1/mcp/chat/completions" : {
"post" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"mcp"
] ,
2026-03-11 21:01:55 +00:00
"summary" : "MCP chat completions with automatic tool execution" ,
2025-11-15 20:50:30 +00:00
"parameters" : [
{
"description" : "query params" ,
"name" : "request" ,
"in" : "body" ,
"required" : true ,
2024-03-29 21:29:33 +00:00
"schema" : {
"$ref" : "#/definitions/schema.OpenAIRequest"
}
}
] ,
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
"$ref" : "#/definitions/schema.OpenAIResponse"
}
}
}
}
} ,
2026-01-10 20:46:23 +00:00
"/v1/messages" : {
"post" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"inference"
] ,
2026-01-10 20:46:23 +00:00
"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"
}
}
}
}
} ,
2024-07-11 08:56:55 +00:00
"/v1/models" : {
"get" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"models"
] ,
2024-07-11 08:56:55 +00:00
"summary" : "List and describe the various models available in the API." ,
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
"$ref" : "#/definitions/schema.ModelsDataResponse"
}
}
}
}
} ,
2024-07-14 21:44:18 +00:00
"/v1/rerank" : {
"post" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"rerank"
] ,
2024-07-14 21:44:18 +00:00
"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"
}
}
}
}
} ,
2026-01-18 21:10:06 +00:00
"/v1/responses" : {
"post" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"inference"
] ,
2026-01-18 21:10:06 +00:00
"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." ,
2026-04-04 13:14:35 +00:00
"tags" : [
"inference"
] ,
2026-01-18 21:10:06 +00:00
"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" ,
2026-04-04 13:14:35 +00:00
"tags" : [
"inference"
] ,
2026-01-18 21:10:06 +00:00
"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
}
}
}
}
} ,
2024-08-24 21:53:18 +00:00
"/v1/sound-generation" : {
"post" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"audio"
] ,
2024-08-24 21:53:18 +00:00
"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"
}
}
}
}
} ,
2024-03-29 21:29:33 +00:00
"/v1/text-to-speech/{voice-id}" : {
"post" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"audio"
] ,
2024-03-29 21:29:33 +00:00
"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"
}
}
}
}
2024-11-14 21:36:53 +00:00
} ,
"/v1/tokenMetrics" : {
"get" : {
"consumes" : [
"application/json"
] ,
"produces" : [
"audio/x-wav"
] ,
2026-04-04 13:14:35 +00:00
"tags" : [
"tokenize"
] ,
2024-11-14 21:36:53 +00:00
"summary" : "Get TokenMetrics for Active Slot." ,
"responses" : {
"200" : {
"description" : "generated audio/wav file" ,
"schema" : {
"type" : "string"
}
}
}
}
} ,
"/v1/tokenize" : {
"post" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"tokenize"
] ,
2024-11-14 21:36:53 +00:00
"summary" : "Tokenize the input." ,
2025-02-03 09:16:42 +00:00
"parameters" : [
{
"description" : "Request" ,
"name" : "request" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/schema.TokenizeRequest"
}
}
] ,
2024-11-14 21:36:53 +00:00
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
"$ref" : "#/definitions/schema.TokenizeResponse"
}
}
}
}
2024-11-20 22:10:51 +00:00
} ,
"/vad" : {
"post" : {
"consumes" : [
"application/json"
] ,
2026-04-04 13:14:35 +00:00
"tags" : [
"audio"
] ,
2024-11-20 22:10:51 +00:00
"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"
}
}
}
}
2025-04-26 22:40:35 +00:00
} ,
"/video" : {
"post" : {
2026-04-04 13:14:35 +00:00
"tags" : [
"video"
] ,
2025-04-26 22:40:35 +00:00
"summary" : "Creates a video given a prompt." ,
"parameters" : [
{
"description" : "query params" ,
"name" : "request" ,
"in" : "body" ,
"required" : true ,
"schema" : {
2025-08-29 06:11:34 +00:00
"$ref" : "#/definitions/schema.VideoRequest"
2025-04-26 22:40:35 +00:00
}
}
] ,
"responses" : {
"200" : {
"description" : "Response" ,
"schema" : {
"$ref" : "#/definitions/schema.OpenAIResponse"
}
}
}
}
2026-04-04 13:14:35 +00:00
} ,
"/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" : { }
}
2024-03-29 21:29:33 +00:00
}
} ,
"definitions" : {
2024-07-14 21:44:18 +00:00
"config.Gallery" : {
"type" : "object" ,
"properties" : {
"name" : {
"type" : "string"
} ,
"url" : {
"type" : "string"
}
}
} ,
2024-04-25 14:10:08 +00:00
"functions.Function" : {
2024-03-29 21:29:33 +00:00
"type" : "object" ,
"properties" : {
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"parameters" : {
"type" : "object" ,
2026-03-30 21:48:06 +00:00
"additionalProperties" : { }
2024-08-07 21:54:27 +00:00
} ,
"strict" : {
"type" : "boolean"
2024-03-29 21:29:33 +00:00
}
}
} ,
2024-07-18 21:20:52 +00:00
"functions.Item" : {
2024-03-29 21:29:33 +00:00
"type" : "object" ,
"properties" : {
"properties" : {
2024-05-12 21:00:18 +00:00
"type" : "object" ,
2026-03-30 21:48:06 +00:00
"additionalProperties" : { }
2024-05-12 21:00:18 +00:00
} ,
2024-07-18 21:20:52 +00:00
"type" : {
"type" : "string"
2024-05-12 21:00:18 +00:00
}
}
} ,
2024-07-18 21:20:52 +00:00
"functions.JSONFunctionStructure" : {
2024-03-29 21:29:33 +00:00
"type" : "object" ,
"properties" : {
"$defs" : {
"type" : "object" ,
2026-03-30 21:48:06 +00:00
"additionalProperties" : { }
2024-03-29 21:29:33 +00:00
} ,
"anyOf" : {
"type" : "array" ,
"items" : {
2024-07-18 21:20:52 +00:00
"$ref" : "#/definitions/functions.Item"
2024-03-29 21:29:33 +00:00
}
} ,
"oneOf" : {
"type" : "array" ,
"items" : {
2024-07-18 21:20:52 +00:00
"$ref" : "#/definitions/functions.Item"
2024-03-29 21:29:33 +00:00
}
}
}
} ,
2024-04-25 14:10:08 +00:00
"functions.Tool" : {
2024-03-29 21:29:33 +00:00
"type" : "object" ,
"properties" : {
"function" : {
2024-04-25 14:10:08 +00:00
"$ref" : "#/definitions/functions.Function"
2024-03-29 21:29:33 +00:00
} ,
"type" : {
"type" : "string"
}
}
} ,
2024-07-14 21:44:18 +00:00
"gallery.File" : {
"type" : "object" ,
"properties" : {
"filename" : {
"type" : "string"
} ,
"sha256" : {
"type" : "string"
} ,
"uri" : {
"type" : "string"
}
}
} ,
2025-07-31 14:22:27 +00:00
"gallery.GalleryBackend" : {
2024-07-14 21:44:18 +00:00
"type" : "object" ,
"properties" : {
2025-07-31 14:22:27 +00:00
"alias" : {
"type" : "string"
} ,
2026-03-19 20:49:40 +00:00
"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"
} ,
2025-07-31 14:22:27 +00:00
"capabilities" : {
2024-07-14 21:44:18 +00:00
"type" : "object" ,
2025-07-31 14:22:27 +00:00
"additionalProperties" : {
"type" : "string"
}
2024-07-14 21:44:18 +00:00
} ,
"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"
} ,
2025-07-31 14:22:27 +00:00
"mirrors" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
2024-07-14 21:44:18 +00:00
"name" : {
"type" : "string"
} ,
2026-03-09 21:14:17 +00:00
"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"
} ,
2024-07-14 21:44:18 +00:00
"tags" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
2025-07-31 14:22:27 +00:00
"uri" : {
"type" : "string"
} ,
2024-07-14 21:44:18 +00:00
"url" : {
"type" : "string"
} ,
"urls" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
2026-04-13 07:42:36 +00:00
} ,
"version" : {
"type" : "string"
2024-07-14 21:44:18 +00:00
}
}
} ,
2026-04-04 13:14:35 +00:00
"gallery.Metadata" : {
2024-07-14 21:44:18 +00:00
"type" : "object" ,
"properties" : {
2026-03-19 20:49:40 +00:00
"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"
} ,
2024-07-14 21:44:18 +00:00
"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"
} ,
2026-03-09 21:14:17 +00:00
"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"
} ,
2024-07-14 21:44:18 +00:00
"tags" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"url" : {
"type" : "string"
} ,
"urls" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
}
}
} ,
2026-04-19 21:39:50 +00:00
"gallery.NodeDriftInfo" : {
"type" : "object" ,
"properties" : {
"digest" : {
"type" : "string"
} ,
"node_id" : {
"type" : "string"
} ,
"node_name" : {
"type" : "string"
} ,
"version" : {
"type" : "string"
}
}
} ,
2026-04-13 07:42:36 +00:00
"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"
2026-04-19 21:39:50 +00:00
} ,
"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"
}
2026-04-13 07:42:36 +00:00
}
}
} ,
2026-03-30 21:48:06 +00:00
"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"
} ,
"deletion" : {
"description" : "Deletion is true if the operation is a deletion" ,
"type" : "boolean"
} ,
"downloaded_size" : {
"type" : "string"
} ,
"error" : { } ,
"file_name" : {
"type" : "string"
} ,
"file_size" : {
"type" : "string"
} ,
"gallery_element_name" : {
"type" : "string"
} ,
"message" : {
"type" : "string"
} ,
"processed" : {
"type" : "boolean"
} ,
2026-04-04 13:14:35 +00:00
"progress" : {
"type" : "number"
}
}
} ,
"localai.APIInstructionResponse" : {
"type" : "object" ,
"properties" : {
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"swagger_fragment" : {
"type" : "object" ,
"additionalProperties" : { }
} ,
"tags" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
2026-03-30 21:48:06 +00:00
}
}
} ,
2025-07-31 14:22:27 +00:00
"localai.GalleryBackend" : {
2024-03-29 21:29:33 +00:00
"type" : "object" ,
"properties" : {
2025-07-31 14:22:27 +00:00
"id" : {
"type" : "string"
}
}
} ,
"localai.GalleryModel" : {
"type" : "object" ,
"properties" : {
2026-03-19 20:49:40 +00:00
"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"
} ,
2025-07-31 14:22:27 +00:00
"config_file" : {
"description" : "config_file is read in the situation where URL is blank - and therefore this is a base config." ,
"type" : "object" ,
2026-03-30 21:48:06 +00:00
"additionalProperties" : { }
2024-03-29 21:29:33 +00:00
} ,
"description" : {
"type" : "string"
} ,
2025-07-31 14:22:27 +00:00
"files" : {
"description" : "AdditionalFiles are used to add additional files to the model" ,
2024-03-29 21:29:33 +00:00
"type" : "array" ,
"items" : {
2025-07-31 14:22:27 +00:00
"$ref" : "#/definitions/gallery.File"
2024-03-29 21:29:33 +00:00
}
} ,
2025-07-31 14:22:27 +00:00
"gallery" : {
"description" : "Gallery is a reference to the gallery which contains the model" ,
"allOf" : [
{
"$ref" : "#/definitions/config.Gallery"
}
]
} ,
"icon" : {
2024-03-29 21:29:33 +00:00
"type" : "string"
} ,
2025-07-31 14:22:27 +00:00
"id" : {
2024-03-29 21:29:33 +00:00
"type" : "string"
} ,
2025-07-31 14:22:27 +00:00
"installed" : {
"description" : "Installed is used to indicate if the model is installed or not" ,
"type" : "boolean"
2024-03-29 21:29:33 +00:00
} ,
2025-07-31 14:22:27 +00:00
"license" : {
2024-03-29 21:29:33 +00:00
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
2025-07-31 14:22:27 +00:00
"overrides" : {
"description" : "Overrides are used to override the configuration of the model located at URL" ,
"type" : "object" ,
2026-03-30 21:48:06 +00:00
"additionalProperties" : { }
2024-03-29 21:29:33 +00:00
} ,
2026-03-09 21:14:17 +00:00
"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"
} ,
2025-07-31 14:22:27 +00:00
"tags" : {
2024-03-29 21:29:33 +00:00
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
2025-07-31 14:22:27 +00:00
"url" : {
2024-03-29 21:29:33 +00:00
"type" : "string"
} ,
2025-07-31 14:22:27 +00:00
"urls" : {
2024-03-29 21:29:33 +00:00
"type" : "array" ,
"items" : {
2025-07-31 14:22:27 +00:00
"type" : "string"
2024-03-29 21:29:33 +00:00
}
}
2026-04-11 06:38:55 +00:00
}
} ,
"localai.ModelResponse" : {
"type" : "object" ,
"properties" : {
"config" : { } ,
"details" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"error" : {
"type" : "string"
} ,
"filename" : {
"type" : "string"
} ,
"message" : {
"type" : "string"
} ,
"success" : {
"type" : "boolean"
}
2024-03-29 21:29:33 +00:00
}
} ,
2026-04-04 13:14:35 +00:00
"localai.vramEstimateRequest" : {
"type" : "object" ,
"properties" : {
"context_size" : {
"description" : "context length to estimate for (default 8192)" ,
"type" : "integer"
} ,
"gpu_layers" : {
"description" : "number of layers to offload to GPU (0 = all)" ,
"type" : "integer"
} ,
"kv_quant_bits" : {
"description" : "KV cache quantization bits (0 = fp16)" ,
"type" : "integer"
} ,
"model" : {
"description" : "model name (must be installed)" ,
"type" : "string"
}
}
} ,
"localai.vramEstimateResponse" : {
"type" : "object" ,
"properties" : {
"context_note" : {
"description" : "note when context_size was defaulted" ,
"type" : "string"
} ,
"model_max_context" : {
"description" : "model's trained maximum context length" ,
"type" : "integer"
} ,
"sizeBytes" : {
"description" : "total model weight size in bytes" ,
"type" : "integer"
} ,
"sizeDisplay" : {
"description" : "human-readable size (e.g. \"4.2 GB\")" ,
"type" : "string"
} ,
"vramBytes" : {
"description" : "estimated VRAM usage in bytes" ,
"type" : "integer"
} ,
"vramDisplay" : {
"description" : "human-readable VRAM (e.g. \"6.1 GB\")" ,
"type" : "string"
}
}
} ,
"model.BackendLogLine" : {
"type" : "object" ,
"properties" : {
"stream" : {
"description" : "\"stdout\" or \"stderr\"" ,
"type" : "string"
} ,
"text" : {
"type" : "string"
} ,
"timestamp" : {
"type" : "string"
}
}
} ,
2024-07-18 11:42:45 +00:00
"proto.MemoryUsageData" : {
"type" : "object" ,
"properties" : {
"breakdown" : {
"type" : "object" ,
"additionalProperties" : {
2025-07-31 21:04:23 +00:00
"type" : "integer" ,
"format" : "int64"
2024-07-18 11:42:45 +00:00
}
} ,
"total" : {
"type" : "integer"
}
}
} ,
"proto.StatusResponse" : {
"type" : "object" ,
"properties" : {
"memory" : {
"$ref" : "#/definitions/proto.MemoryUsageData"
} ,
"state" : {
"$ref" : "#/definitions/proto.StatusResponse_State"
}
}
} ,
"proto.StatusResponse_State" : {
"type" : "integer" ,
2025-07-31 21:04:23 +00:00
"format" : "int32" ,
2024-07-18 11:42:45 +00:00
"enum" : [
0 ,
1 ,
2 ,
- 1
] ,
"x-enum-varnames" : [
"StatusResponse_UNINITIALIZED" ,
"StatusResponse_BUSY" ,
"StatusResponse_READY" ,
"StatusResponse_ERROR"
]
} ,
2024-11-20 22:10:51 +00:00
"proto.VADResponse" : {
"type" : "object" ,
"properties" : {
"segments" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/proto.VADSegment"
}
}
}
} ,
"proto.VADSegment" : {
"type" : "object" ,
"properties" : {
"end" : {
"type" : "number"
} ,
"start" : {
"type" : "number"
}
}
} ,
2026-01-10 20:46:23 +00:00
"schema.AnthropicContentBlock" : {
"type" : "object" ,
"properties" : {
"content" : { } ,
"id" : {
"type" : "string"
} ,
"input" : {
"type" : "object" ,
2026-03-30 21:48:06 +00:00
"additionalProperties" : { }
2026-01-10 20:46:23 +00:00
} ,
"is_error" : {
"type" : "boolean"
} ,
"name" : {
"type" : "string"
} ,
"source" : {
"$ref" : "#/definitions/schema.AnthropicImageSource"
} ,
"text" : {
"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"
} ,
"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.AnthropicTool" : {
"type" : "object" ,
"properties" : {
"description" : {
"type" : "string"
} ,
"input_schema" : {
"type" : "object" ,
2026-03-30 21:48:06 +00:00
"additionalProperties" : { }
2026-01-10 20:46:23 +00:00
} ,
"name" : {
"type" : "string"
}
}
} ,
"schema.AnthropicUsage" : {
"type" : "object" ,
"properties" : {
"input_tokens" : {
"type" : "integer"
} ,
"output_tokens" : {
"type" : "integer"
}
}
} ,
2024-07-18 11:42:45 +00:00
"schema.BackendMonitorRequest" : {
"type" : "object" ,
"properties" : {
"model" : {
"type" : "string"
}
}
} ,
2025-07-31 14:22:27 +00:00
"schema.BackendResponse" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"status_url" : {
"type" : "string"
}
}
} ,
2024-03-29 21:29:33 +00:00
"schema.Choice" : {
"type" : "object" ,
"properties" : {
"delta" : {
"$ref" : "#/definitions/schema.Message"
} ,
"finish_reason" : {
"type" : "string"
} ,
"index" : {
"type" : "integer"
} ,
2025-11-17 06:49:06 +00:00
"logprobs" : {
"$ref" : "#/definitions/schema.Logprobs"
} ,
2024-03-29 21:29:33 +00:00
"message" : {
"$ref" : "#/definitions/schema.Message"
} ,
"text" : {
"type" : "string"
}
}
} ,
2025-07-31 14:22:27 +00:00
"schema.Detection" : {
2024-07-18 11:42:45 +00:00
"type" : "object" ,
"properties" : {
2025-07-31 14:22:27 +00:00
"class_name" : {
"type" : "string"
2024-07-18 11:42:45 +00:00
} ,
2026-04-09 23:05:53 +00:00
"confidence" : {
"type" : "number"
} ,
2025-07-31 14:22:27 +00:00
"height" : {
"type" : "number"
} ,
2026-04-09 23:05:53 +00:00
"mask" : {
"description" : "base64-encoded PNG segmentation mask" ,
"type" : "string"
} ,
2025-07-31 14:22:27 +00:00
"width" : {
"type" : "number"
} ,
"x" : {
"type" : "number"
} ,
"y" : {
"type" : "number"
}
}
} ,
"schema.DetectionRequest" : {
"type" : "object" ,
"properties" : {
2026-04-09 23:05:53 +00:00
"boxes" : {
"description" : "Box coordinates as [x1,y1,x2,y2,...] quads" ,
"type" : "array" ,
"items" : {
"type" : "number"
}
} ,
2025-07-31 14:22:27 +00:00
"image" : {
2026-04-04 13:14:35 +00:00
"description" : "URL or base64-encoded image to analyze" ,
2024-07-18 11:42:45 +00:00
"type" : "string"
} ,
2025-07-31 14:22:27 +00:00
"model" : {
2024-07-18 11:42:45 +00:00
"type" : "string"
2026-04-09 23:05:53 +00:00
} ,
"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"
2024-07-18 11:42:45 +00:00
}
}
} ,
2025-07-31 14:22:27 +00:00
"schema.DetectionResponse" : {
"type" : "object" ,
"properties" : {
"detections" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/schema.Detection"
}
}
}
} ,
2024-08-24 21:53:18 +00:00
"schema.ElevenLabsSoundGenerationRequest" : {
"type" : "object" ,
"properties" : {
2026-02-05 11:04:53 +00:00
"bpm" : {
"type" : "integer"
} ,
"caption" : {
"type" : "string"
} ,
2024-08-24 21:53:18 +00:00
"do_sample" : {
"type" : "boolean"
} ,
"duration_seconds" : {
"type" : "number"
} ,
2026-02-05 11:04:53 +00:00
"instrumental" : {
2026-02-05 20:33:44 +00:00
"description" : "Simple mode: use text as description; optional instrumental / vocal_language" ,
2026-02-05 11:04:53 +00:00
"type" : "boolean"
} ,
"keyscale" : {
"type" : "string"
} ,
"language" : {
"type" : "string"
} ,
"lyrics" : {
"type" : "string"
} ,
2024-08-24 21:53:18 +00:00
"model_id" : {
"type" : "string"
} ,
"prompt_influence" : {
"type" : "number"
} ,
"text" : {
"type" : "string"
2026-02-05 11:04:53 +00:00
} ,
"think" : {
2026-02-05 20:33:44 +00:00
"description" : "Advanced mode" ,
2026-02-05 11:04:53 +00:00
"type" : "boolean"
} ,
"timesignature" : {
"type" : "string"
} ,
"vocal_language" : {
"type" : "string"
2024-08-24 21:53:18 +00:00
}
}
} ,
2024-03-29 21:29:33 +00:00
"schema.FunctionCall" : {
"type" : "object" ,
"properties" : {
"arguments" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
}
}
} ,
2024-07-14 21:44:18 +00:00
"schema.GalleryResponse" : {
"type" : "object" ,
"properties" : {
2026-03-01 20:33:19 +00:00
"estimated_size_bytes" : {
"type" : "integer"
} ,
"estimated_size_display" : {
"type" : "string"
} ,
"estimated_vram_bytes" : {
"type" : "integer"
} ,
"estimated_vram_display" : {
"type" : "string"
} ,
2024-07-14 21:44:18 +00:00
"status" : {
"type" : "string"
} ,
"uuid" : {
"type" : "string"
}
}
} ,
2025-12-30 21:05:01 +00:00
"schema.InputTokensDetails" : {
"type" : "object" ,
"properties" : {
"image_tokens" : {
"type" : "integer"
} ,
"text_tokens" : {
"type" : "integer"
}
}
} ,
2024-03-29 21:29:33 +00:00
"schema.Item" : {
"type" : "object" ,
"properties" : {
"b64_json" : {
"type" : "string"
} ,
"index" : {
"type" : "integer"
} ,
"object" : {
"type" : "string"
} ,
"url" : {
"description" : "Images" ,
"type" : "string"
}
}
} ,
2024-07-14 21:44:18 +00:00
"schema.JINADocumentResult" : {
"type" : "object" ,
"properties" : {
"document" : {
"$ref" : "#/definitions/schema.JINAText"
} ,
"index" : {
"type" : "integer"
} ,
"relevance_score" : {
"type" : "number"
}
}
} ,
"schema.JINARerankRequest" : {
"type" : "object" ,
"properties" : {
2025-02-11 08:51:01 +00:00
"backend" : {
"type" : "string"
} ,
2024-07-14 21:44:18 +00:00
"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"
}
}
} ,
2026-04-04 13:14:35 +00:00
"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"
}
}
} ,
2025-11-17 06:49:06 +00:00
"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"
}
}
} ,
2024-03-29 21:29:33 +00:00
"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"
} ,
2026-01-10 20:46:23 +00:00
"reasoning" : {
"description" : "Reasoning content extracted from \u003cthinking\u003e...\u003c/thinking\u003e tags" ,
"type" : "string"
} ,
2024-03-29 21:29:33 +00:00
"role" : {
"description" : "The message role" ,
"type" : "string"
} ,
2024-09-20 08:49:32 +00:00
"string_audios" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
2024-03-29 21:29:33 +00:00
"string_content" : {
"type" : "string"
} ,
"string_images" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
2024-09-20 08:49:32 +00:00
"string_videos" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
2026-03-11 21:01:55 +00:00
"tool_call_id" : {
"type" : "string"
} ,
2024-03-29 21:29:33 +00:00
"tool_calls" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/schema.ToolCall"
}
}
}
} ,
2024-07-11 08:56:55 +00:00
"schema.ModelsDataResponse" : {
"type" : "object" ,
"properties" : {
"data" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/schema.OpenAIModel"
}
} ,
"object" : {
"type" : "string"
}
}
} ,
2026-04-04 13:14:35 +00:00
"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"
}
}
} ,
2025-08-19 20:56:00 +00:00
"schema.NodeData" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"lastSeen" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"serviceID" : {
"type" : "string"
} ,
"tunnelAddress" : {
"type" : "string"
}
}
} ,
2026-01-21 20:44:44 +00:00
"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"
}
}
} ,
2026-01-18 21:10:06 +00:00
"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" ,
2026-03-30 21:48:06 +00:00
"additionalProperties" : { }
2026-01-18 21:10:06 +00:00
} ,
"strict" : {
"description" : "Always include in response" ,
"type" : "boolean"
} ,
"type" : {
"description" : "always \"function\"" ,
"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"
} ,
2026-01-21 20:44:44 +00:00
"encrypted_content" : {
"description" : "Provider-specific encrypted content" ,
"type" : "string"
} ,
2026-01-18 21:10:06 +00:00
"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"
} ,
2026-01-21 20:44:44 +00:00
"summary" : {
"description" : "Reasoning fields (for type == \"reasoning\")" ,
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/schema.ORContentPart"
}
} ,
2026-01-18 21:10:06 +00:00
"type" : {
"description" : "message|function_call|function_call_output|reasoning|item_reference" ,
"type" : "string"
}
}
} ,
2026-01-21 20:44:44 +00:00
"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"
}
}
}
} ,
2026-01-18 21:10:06 +00:00
"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"
}
}
} ,
2026-01-21 20:44:44 +00:00
"schema.ORTopLogProb" : {
"type" : "object" ,
"properties" : {
"bytes" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
} ,
"logprob" : {
"type" : "number"
} ,
"token" : {
"type" : "string"
}
}
} ,
2026-01-18 21:10:06 +00:00
"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"
}
}
} ,
2024-07-11 08:56:55 +00:00
"schema.OpenAIModel" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"object" : {
"type" : "string"
}
}
} ,
2024-03-29 21:29:33 +00:00
"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"
} ,
2026-03-26 06:58:11 +00:00
"encoding_format" : {
"description" : "Embedding encoding format: \"float\" (default) or \"base64\" (OpenAI Node.js SDK default)" ,
"type" : "string"
} ,
2024-03-29 21:29:33 +00:00
"file" : {
"description" : "whisper" ,
"type" : "string"
} ,
2025-07-31 14:22:27 +00:00
"files" : {
"description" : "Multiple input images for img2img or inpainting" ,
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
2024-03-29 21:29:33 +00:00
"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" : {
2024-04-25 14:10:08 +00:00
"$ref" : "#/definitions/functions.Function"
2024-03-29 21:29:33 +00:00
}
} ,
"grammar" : {
"description" : "A grammar to constrain the LLM output" ,
"type" : "string"
} ,
"grammar_json_functions" : {
2024-07-18 21:20:52 +00:00
"$ref" : "#/definitions/functions.JSONFunctionStructure"
2024-03-29 21:29:33 +00:00
} ,
"ignore_eos" : {
"type" : "boolean"
} ,
"input" : { } ,
"instruction" : {
"description" : "Edit endpoint" ,
"type" : "string"
} ,
"language" : {
"description" : "Also part of the OpenAI official spec" ,
"type" : "string"
} ,
2025-11-17 06:49:06 +00:00
"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"
}
]
} ,
2024-03-29 21:29:33 +00:00
"max_tokens" : {
"type" : "integer"
} ,
"messages" : {
"description" : "Messages is read only by chat/completion API calls" ,
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/schema.Message"
}
} ,
2025-08-06 22:32:11 +00:00
"metadata" : {
"type" : "object" ,
"additionalProperties" : {
"type" : "string"
}
} ,
2026-03-22 20:28:20 +00:00
"min_p" : {
"type" : "number"
} ,
2024-03-29 21:29:33 +00:00
"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" : {
"type" : "string"
} ,
"negative_prompt_scale" : {
"type" : "number"
} ,
"presence_penalty" : {
"type" : "number"
} ,
"prompt" : {
"description" : "Prompt is read only by completion/image API calls"
} ,
2025-01-22 20:51:38 +00:00
"quality" : {
2026-01-01 20:16:38 +00:00
"description" : "Image (not supported by OpenAI)" ,
2025-01-22 20:51:38 +00:00
"type" : "string"
} ,
2025-08-06 22:32:11 +00:00
"reasoning_effort" : {
"type" : "string"
} ,
2025-07-31 14:22:27 +00:00
"ref_images" : {
"description" : "Reference images for models that support them (e.g., Flux Kontext)" ,
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
2024-06-26 23:12:53 +00:00
"repeat_last_n" : {
"type" : "integer"
} ,
2024-03-29 21:29:33 +00:00
"repeat_penalty" : {
"type" : "number"
} ,
"response_format" : {
2024-05-30 08:11:05 +00:00
"description" : "whisper/image"
2024-03-29 21:29:33 +00:00
} ,
"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"
} ,
"temperature" : {
"type" : "number"
} ,
"tfz" : {
"type" : "number"
} ,
"tokenizer" : {
"description" : "RWKV (?)" ,
"type" : "string"
} ,
"tool_choice" : { } ,
"tools" : {
"type" : "array" ,
"items" : {
2024-04-25 14:10:08 +00:00
"$ref" : "#/definitions/functions.Tool"
2024-03-29 21:29:33 +00:00
}
} ,
"top_k" : {
"type" : "integer"
} ,
2025-11-17 06:49:06 +00:00
"top_logprobs" : {
"description" : "Number of top logprobs per token (0-20)" ,
"type" : "integer"
} ,
2024-03-29 21:29:33 +00:00
"top_p" : {
"description" : "Common options between all the API calls, part of the OpenAI spec" ,
"type" : "number"
} ,
2024-06-25 08:50:52 +00:00
"translate" : {
"description" : "Only for audio transcription" ,
"type" : "boolean"
} ,
2024-03-29 21:29:33 +00:00
"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"
} ,
"model" : {
"type" : "string"
} ,
"object" : {
"type" : "string"
} ,
"usage" : {
"$ref" : "#/definitions/schema.OpenAIUsage"
}
}
} ,
"schema.OpenAIUsage" : {
"type" : "object" ,
"properties" : {
"completion_tokens" : {
2025-12-30 21:05:01 +00:00
"type" : "integer"
} ,
"input_tokens" : {
"description" : "Fields for image generation API compatibility" ,
"type" : "integer"
} ,
"input_tokens_details" : {
"$ref" : "#/definitions/schema.InputTokensDetails"
} ,
"output_tokens" : {
2024-03-29 21:29:33 +00:00
"type" : "integer"
} ,
"prompt_tokens" : {
"type" : "integer"
} ,
2025-01-18 07:57:49 +00:00
"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"
} ,
2024-03-29 21:29:33 +00:00
"total_tokens" : {
"type" : "integer"
}
}
} ,
2026-01-18 21:10:06 +00:00
"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"
}
}
} ,
2024-07-15 23:39:48 +00:00
"schema.P2PNodesResponse" : {
"type" : "object" ,
"properties" : {
"federated_nodes" : {
"type" : "array" ,
"items" : {
2025-08-19 20:56:00 +00:00
"$ref" : "#/definitions/schema.NodeData"
2024-07-15 23:39:48 +00:00
}
} ,
2026-03-09 21:14:17 +00:00
"llama_cpp_nodes" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/schema.NodeData"
}
} ,
"mlx_nodes" : {
2024-07-15 23:39:48 +00:00
"type" : "array" ,
"items" : {
2025-08-19 20:56:00 +00:00
"$ref" : "#/definitions/schema.NodeData"
2024-07-15 23:39:48 +00:00
}
}
}
} ,
2024-11-14 21:36:53 +00:00
"schema.SysInfoModel" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
}
}
} ,
2024-09-05 22:21:24 +00:00
"schema.SystemInformationResponse" : {
"type" : "object" ,
"properties" : {
"backends" : {
2026-04-04 13:14:35 +00:00
"description" : "available backend engines" ,
2024-09-05 22:21:24 +00:00
"type" : "array" ,
"items" : {
"type" : "string"
}
2024-09-26 08:57:40 +00:00
} ,
"loaded_models" : {
2026-04-04 13:14:35 +00:00
"description" : "currently loaded models" ,
2024-09-26 08:57:40 +00:00
"type" : "array" ,
"items" : {
2024-11-14 21:36:53 +00:00
"$ref" : "#/definitions/schema.SysInfoModel"
2024-09-26 08:57:40 +00:00
}
2024-09-05 22:21:24 +00:00
}
}
} ,
2024-03-29 21:29:33 +00:00
"schema.TTSRequest" : {
2024-06-01 22:04:01 +00:00
"description" : "TTS request body" ,
2024-03-29 21:29:33 +00:00
"type" : "object" ,
"properties" : {
"backend" : {
2026-04-04 13:14:35 +00:00
"description" : "backend engine override" ,
2024-03-29 21:29:33 +00:00
"type" : "string"
} ,
"input" : {
2024-06-01 22:04:01 +00:00
"description" : "text input" ,
"type" : "string"
} ,
"language" : {
"description" : "(optional) language to use with TTS model" ,
2024-03-29 21:29:33 +00:00
"type" : "string"
} ,
"model" : {
"type" : "string"
} ,
2024-11-14 21:36:53 +00:00
"response_format" : {
"description" : "(optional) output format" ,
2024-03-29 21:29:33 +00:00
"type" : "string"
2024-11-02 19:13:35 +00:00
} ,
2026-02-25 20:52:35 +00:00
"sample_rate" : {
"description" : "(optional) desired output sample rate" ,
"type" : "integer"
} ,
2026-01-30 20:27:10 +00:00
"stream" : {
"description" : "(optional) enable streaming TTS" ,
"type" : "boolean"
} ,
2024-11-14 21:36:53 +00:00
"voice" : {
"description" : "voice audio file or speaker id" ,
2024-11-02 19:13:35 +00:00
"type" : "string"
2024-11-14 21:36:53 +00:00
}
}
} ,
2026-04-04 13:14:35 +00:00
"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"
}
}
}
} ,
2025-02-03 09:16:42 +00:00
"schema.TokenizeRequest" : {
"type" : "object" ,
"properties" : {
"content" : {
2026-04-04 13:14:35 +00:00
"description" : "text to tokenize" ,
2025-02-03 09:16:42 +00:00
"type" : "string"
} ,
"model" : {
"type" : "string"
}
}
} ,
2024-11-14 21:36:53 +00:00
"schema.TokenizeResponse" : {
"type" : "object" ,
"properties" : {
"tokens" : {
2026-04-04 13:14:35 +00:00
"description" : "token IDs" ,
2024-11-14 21:36:53 +00:00
"type" : "array" ,
"items" : {
"type" : "integer"
}
}
2024-03-29 21:29:33 +00:00
}
} ,
"schema.ToolCall" : {
"type" : "object" ,
"properties" : {
"function" : {
"$ref" : "#/definitions/schema.FunctionCall"
} ,
"id" : {
"type" : "string"
} ,
"index" : {
"type" : "integer"
} ,
"type" : {
"type" : "string"
}
}
2024-11-20 22:10:51 +00:00
} ,
"schema.VADRequest" : {
"description" : "VAD request body" ,
"type" : "object" ,
"properties" : {
"audio" : {
2026-04-04 13:14:35 +00:00
"description" : "raw audio samples as float32 PCM" ,
2024-11-20 22:10:51 +00:00
"type" : "array" ,
"items" : {
"type" : "number"
}
} ,
"model" : {
"type" : "string"
}
}
2025-07-31 14:22:27 +00:00
} ,
2025-08-29 06:11:34 +00:00
"schema.VideoRequest" : {
"type" : "object" ,
"properties" : {
"cfg_scale" : {
2026-04-04 13:14:35 +00:00
"description" : "classifier-free guidance scale" ,
2025-08-29 06:11:34 +00:00
"type" : "number"
} ,
"end_image" : {
2026-04-04 13:14:35 +00:00
"description" : "URL or base64 of the last frame" ,
2025-08-29 06:11:34 +00:00
"type" : "string"
} ,
"fps" : {
2026-04-04 13:14:35 +00:00
"description" : "frames per second" ,
2025-08-29 06:11:34 +00:00
"type" : "integer"
} ,
"height" : {
2026-04-04 13:14:35 +00:00
"description" : "output height in pixels" ,
2025-08-29 06:11:34 +00:00
"type" : "integer"
} ,
2025-10-27 20:24:28 +00:00
"input_reference" : {
2026-04-04 13:14:35 +00:00
"description" : "reference image or video URL" ,
2025-10-27 20:24:28 +00:00
"type" : "string"
} ,
2025-08-29 06:11:34 +00:00
"model" : {
"type" : "string"
} ,
"negative_prompt" : {
2026-04-04 13:14:35 +00:00
"description" : "things to avoid in the output" ,
2025-08-29 06:11:34 +00:00
"type" : "string"
} ,
"num_frames" : {
2026-04-04 13:14:35 +00:00
"description" : "total number of frames to generate" ,
2025-08-29 06:11:34 +00:00
"type" : "integer"
} ,
"prompt" : {
2026-04-04 13:14:35 +00:00
"description" : "text description of the video to generate" ,
2025-08-29 06:11:34 +00:00
"type" : "string"
} ,
"response_format" : {
2026-04-04 13:14:35 +00:00
"description" : "output format (url or b64_json)" ,
2025-08-29 06:11:34 +00:00
"type" : "string"
} ,
2025-10-27 20:24:28 +00:00
"seconds" : {
2026-04-04 13:14:35 +00:00
"description" : "duration in seconds (alternative to num_frames)" ,
2025-10-27 20:24:28 +00:00
"type" : "string"
} ,
2025-08-29 06:11:34 +00:00
"seed" : {
2026-04-04 13:14:35 +00:00
"description" : "random seed for reproducibility" ,
2025-08-29 06:11:34 +00:00
"type" : "integer"
} ,
2025-10-27 20:24:28 +00:00
"size" : {
2026-04-04 13:14:35 +00:00
"description" : "WxH shorthand (e.g. \"512x512\")" ,
2025-10-27 20:24:28 +00:00
"type" : "string"
} ,
2025-08-29 06:11:34 +00:00
"start_image" : {
2026-04-04 13:14:35 +00:00
"description" : "URL or base64 of the first frame" ,
2025-08-29 06:11:34 +00:00
"type" : "string"
} ,
"step" : {
2026-04-04 13:14:35 +00:00
"description" : "number of diffusion steps" ,
2025-08-29 06:11:34 +00:00
"type" : "integer"
} ,
"width" : {
2026-04-04 13:14:35 +00:00
"description" : "output width in pixels" ,
2025-08-29 06:11:34 +00:00
"type" : "integer"
}
}
2026-04-04 13:14:35 +00:00
} ,
"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"
}
}
2024-03-29 21:29:33 +00:00
}
} ,
"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" ,
2024-03-30 11:04:41 +00:00
Host : "" ,
2024-03-29 21:29:33 +00:00
BasePath : "/" ,
2026-04-04 13:14:35 +00:00
Schemes : [ ] string { "http" , "https" } ,
2024-03-29 21:29:33 +00:00
Title : "LocalAI API" ,
2024-03-29 21:48:58 +00:00
Description : "The LocalAI Rest API." ,
2024-03-29 21:29:33 +00:00
InfoInstanceName : "swagger" ,
SwaggerTemplate : docTemplate ,
LeftDelim : "{{" ,
RightDelim : "}}" ,
}
func init ( ) {
swag . Register ( SwaggerInfo . InstanceName ( ) , SwaggerInfo )
}
