generated: '2026-08-27' method: derived source: openapi/localai-api-openapi.yml note: 'Derived from the $ref graph of the published Swagger 2.0 document: 166 definitions, 94 of them reachable from a path operation, and 89 typed reference edges between them. Entity names carry their Go package prefix (schema., gallery., config., proto., functions., localai., p2p., services.) because the contract is generated from source annotations rather than authored — which is itself a finding: the wire model exposes internal package structure, and there is no id-prefix scheme, no resource-URI convention, and no components.schemas reuse across the OpenAI-, Anthropic- and Open-Responses-shaped families, which each carry their own parallel request/response/message types.' entity_count: 166 entities_referenced_from_paths: 94 relationship_count: 89 packages: - prefix: schema entities: 130 - prefix: localai entities: 9 - prefix: gallery entities: 6 - prefix: proto entities: 5 - prefix: functions entities: 4 - prefix: config entities: 2 - prefix: galleryop entities: 2 - prefix: middleware entities: 2 - prefix: modeladmin entities: 2 - prefix: voiceprofile entities: 2 - prefix: model entities: 1 - prefix: nodes entities: 1 hub_entities: - name: schema.ORResponseResource outbound_refs: 7 description: null - name: schema.OpenAIRequest outbound_refs: 6 description: null - name: localai.GalleryModel outbound_refs: 3 description: null - name: schema.AnthropicRequest outbound_refs: 3 description: null - name: schema.Choice outbound_refs: 3 description: null - name: schema.OpenAIResponse outbound_refs: 3 description: null - name: schema.P2PNodesResponse outbound_refs: 3 description: null - name: functions.JSONFunctionStructure outbound_refs: 2 description: null - name: gallery.GalleryBackend outbound_refs: 2 description: null - name: gallery.Metadata outbound_refs: 2 description: null - name: proto.StatusResponse outbound_refs: 2 description: null - name: schema.AnthropicResponse outbound_refs: 2 description: null most_referenced: - name: config.Gallery inbound_refs: 3 - name: gallery.File inbound_refs: 3 - name: schema.Message inbound_refs: 3 - name: schema.FacialArea inbound_refs: 3 - name: schema.NodeData inbound_refs: 3 - name: functions.Item inbound_refs: 2 - name: functions.Function inbound_refs: 2 - name: schema.LogprobContent inbound_refs: 2 - name: schema.ORFunctionTool inbound_refs: 2 - name: schema.PIIEntity inbound_refs: 2 - name: config.GalleryVerification inbound_refs: 1 - name: gallery.NodeDriftInfo inbound_refs: 1 most_used_in_operations: - name: schema.OpenAIResponse operation_references: 10 - name: schema.ErrorResponse operation_references: 8 - name: localai.ModelResponse operation_references: 8 - name: schema.OpenAIRequest operation_references: 6 - name: schema.Task operation_references: 4 - name: galleryop.OpStatus operation_references: 4 - name: localai.BrandingResponse operation_references: 3 - name: schema.ModelLoadResponse operation_references: 3 - name: schema.BackendResponse operation_references: 3 - name: schema.TTSRequest operation_references: 3 - name: schema.ORResponseResource operation_references: 3 - name: schema.Job operation_references: 2 - name: schema.JobExecutionResponse operation_references: 2 - name: schema.PIIAnalyzeRequest operation_references: 2 - name: gallery.GalleryBackend operation_references: 2 - name: config.Gallery operation_references: 2 - name: gallery.UpgradeInfo operation_references: 2 - name: schema.GalleryResponse operation_references: 2 - name: schema.Model3DRequest operation_references: 1 - name: schema.JobExecutionRequest operation_references: 1 - name: localai.AliasInfo operation_references: 1 - name: model.BackendLogLine operation_references: 1 - name: localai.APIInstructionResponse operation_references: 1 - name: modeladmin.VRAMRequest operation_references: 1 - name: modeladmin.VRAMResponse operation_references: 1 relationships: - from: config.Gallery to: config.GalleryVerification via: verification kind: has_one - from: functions.JSONFunctionStructure to: functions.Item via: anyOf kind: has_many - from: functions.JSONFunctionStructure to: functions.Item via: oneOf kind: has_many - from: functions.Tool to: functions.Function via: function kind: has_one - from: gallery.GalleryBackend to: config.Gallery via: gallery kind: has_one - from: gallery.GalleryBackend to: gallery.File via: files kind: has_many - from: gallery.Metadata to: config.Gallery via: gallery kind: has_one - from: gallery.Metadata to: gallery.File via: files kind: has_many - from: gallery.UpgradeInfo to: gallery.NodeDriftInfo via: node_drift kind: has_many - from: galleryop.OpStatus to: galleryop.NodeProgress via: nodes kind: has_many - from: localai.GalleryModel to: config.Gallery via: gallery kind: has_one - from: localai.GalleryModel to: gallery.File via: files kind: has_many - from: localai.GalleryModel to: gallery.Variant via: variants kind: has_many - from: localai.VoiceProfileListResponse to: voiceprofile.Profile via: data kind: has_many - from: middleware.TraceSummary to: middleware.TraceBucket via: buckets kind: has_many - from: proto.StatusResponse to: proto.MemoryUsageData via: memory kind: has_one - from: proto.StatusResponse to: proto.StatusResponse_State via: state kind: has_one - from: proto.VADResponse to: proto.VADSegment via: segments kind: has_many - from: schema.AnthropicContentBlock to: schema.AnthropicImageSource via: source kind: has_one - from: schema.AnthropicRequest to: schema.AnthropicMessage via: messages kind: has_many - from: schema.AnthropicRequest to: schema.AnthropicThinkingParam via: thinking kind: has_one - from: schema.AnthropicRequest to: schema.AnthropicTool via: tools kind: has_many - from: schema.AnthropicResponse to: schema.AnthropicContentBlock via: content kind: has_many - from: schema.AnthropicResponse to: schema.AnthropicUsage via: usage kind: has_one - from: schema.Choice to: schema.Logprobs via: logprobs kind: has_one - from: schema.Choice to: schema.Message via: delta kind: has_one - from: schema.Choice to: schema.Message via: message kind: has_one - from: schema.DetectionResponse to: schema.Detection via: detections kind: has_many - from: schema.DiarizationResult to: schema.DiarizationSegment via: segments kind: has_many - from: schema.DiarizationResult to: schema.DiarizationSpeaker via: speakers kind: has_many - from: schema.ErrorResponse to: schema.APIError via: error kind: has_one - from: schema.FaceAnalysis to: schema.FacialArea via: region kind: has_one - from: schema.FaceAnalyzeResponse to: schema.FaceAnalysis via: faces kind: has_many - from: schema.FaceIdentifyResponse to: schema.FaceIdentifyMatch via: matches kind: has_many - from: schema.FaceVerifyResponse to: schema.FacialArea via: img1_area kind: has_one - from: schema.FaceVerifyResponse to: schema.FacialArea via: img2_area kind: has_one - from: schema.JINADocumentResult to: schema.JINAText via: document kind: has_one - from: schema.JINARerankResponse to: schema.JINADocumentResult via: results kind: has_many - from: schema.JINARerankResponse to: schema.JINAUsageInfo via: usage kind: has_one - from: schema.Job to: schema.JobStatus via: status kind: has_one - from: schema.Job to: schema.JobTrace via: traces kind: has_many - from: schema.LogprobContent to: schema.LogprobContent via: top_logprobs kind: has_many - from: schema.Logprobs to: schema.LogprobContent via: content kind: has_many - from: schema.Message to: schema.ToolCall via: tool_calls kind: has_many - from: schema.ModelCapabilitiesResponse to: schema.ModelCapabilities via: data kind: has_many - from: schema.ModelsDataResponse to: schema.OpenAIModel via: data kind: has_many - from: schema.ModerationResponse to: schema.ModerationResult via: results kind: has_many - from: schema.ORContentPart to: schema.ORAnnotation via: annotations kind: has_many - from: schema.ORContentPart to: schema.ORLogProb via: logprobs kind: has_many - from: schema.ORItemField to: schema.ORContentPart via: summary kind: has_many - from: schema.ORLogProb to: schema.ORTopLogProb via: top_logprobs kind: has_many - from: schema.ORResponseResource to: schema.ORError via: error kind: has_one - from: schema.ORResponseResource to: schema.ORFunctionTool via: tools kind: has_many - from: schema.ORResponseResource to: schema.ORIncompleteDetails via: incomplete_details kind: has_one - from: schema.ORResponseResource to: schema.ORItemField via: output kind: has_many - from: schema.ORResponseResource to: schema.ORReasoning via: reasoning kind: has_one - from: schema.ORResponseResource to: schema.ORTextConfig via: text kind: has_one - from: schema.ORResponseResource to: schema.ORUsage via: usage kind: has_one - from: schema.ORTextConfig to: schema.ORTextFormat via: format kind: has_one - from: schema.ORUsage to: schema.ORInputTokensDetails via: input_tokens_details kind: has_one - from: schema.ORUsage to: schema.OROutputTokensDetails via: output_tokens_details kind: has_one - from: schema.OpenAIRequest to: functions.Function via: functions kind: has_many - from: schema.OpenAIRequest to: functions.JSONFunctionStructure via: grammar_json_functions kind: has_one - from: schema.OpenAIRequest to: functions.Tool via: tools kind: has_many - from: schema.OpenAIRequest to: schema.LogprobsValue via: logprobs kind: has_one - from: schema.OpenAIRequest to: schema.Message via: messages kind: has_many - from: schema.OpenAIRequest to: schema.StreamOptions via: stream_options kind: has_one - from: schema.OpenAIResponse to: schema.Choice via: choices kind: has_many - from: schema.OpenAIResponse to: schema.Item via: data kind: has_many - from: schema.OpenAIResponse to: schema.OpenAIUsage via: usage kind: has_one - from: schema.OpenAIUsage to: schema.CompressionMetadata via: compression_meta kind: has_one - from: schema.OpenAIUsage to: schema.InputTokensDetails via: input_tokens_details kind: has_one - from: schema.OpenResponsesRequest to: schema.ORFunctionTool via: tools kind: has_many - from: schema.OpenResponsesRequest to: schema.ORReasoningParam via: reasoning kind: has_one - from: schema.P2PNodesResponse to: schema.NodeData via: federated_nodes kind: has_many - from: schema.P2PNodesResponse to: schema.NodeData via: llama_cpp_nodes kind: has_many - from: schema.P2PNodesResponse to: schema.NodeData via: mlx_nodes kind: has_many - from: schema.PIIAnalyzeResponse to: schema.PIIEntity via: entities kind: has_many - from: schema.PIIRedactResponse to: schema.PIIEntity via: entities kind: has_many - from: schema.RouterCorpusAddRequest to: schema.RouterCorpusEntry via: entries kind: has_many - from: schema.RouterDecideResponse to: schema.RouterDecideNeighbor via: neighbors kind: has_many - from: schema.SoundClassificationResult to: schema.SoundClassification via: detections kind: has_many - from: schema.SystemInformationResponse to: schema.SysInfoModel via: loaded_models kind: has_many - from: schema.Task to: schema.MultimediaSourceConfig via: multimedia_sources kind: has_many - from: schema.Task to: schema.WebhookConfig via: webhooks kind: has_many - from: schema.ToolCall to: schema.FunctionCall via: function kind: has_one - from: schema.VoiceAnalyzeResponse to: schema.VoiceAnalysis via: segments kind: has_many - from: schema.VoiceIdentifyResponse to: schema.VoiceIdentifyMatch via: matches kind: has_many - from: voiceprofile.Profile to: voiceprofile.AudioMetadata via: audio kind: has_one identifiers: scheme: none note: No id-prefix or typed-identifier scheme exists. Resources are addressed by human-chosen names in the path ({name} for models and backends, {modelId} for logs) or by opaque UUIDs for jobs ({uuid}) and traces/agent jobs ({id}). Nothing in a returned payload tells an agent which entity type an identifier belongs to. render: null