cortex.json

{
  "openapi": "3.0.0",
  "paths": {
    "/assistants": {
      "post": {
        "operationId": "AssistantsController_create",
        "summary": "Create assistant",
        "description": "Creates a new assistant with the specified configuration.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "model": {
                    "type": "string",
                    "description": "The model identifier to use for the assistant."
                  },
                  "name": {
                    "type": "string",
                    "description": "The name of the assistant."
                  },
                  "description": {
                    "type": "string",
                    "description": "The description of the assistant."
                  },
                  "instructions": {
                    "type": "string",
                    "description": "Instructions for the assistant's behavior."
                  },
                  "tools": {
                    "type": "array",
                    "description": "A list of tools enabled on the assistant. Maximum of 128 tools.",
                    "items": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string",
                          "enum": [
                            "code_interpreter",
                            "file_search",
                            "function"
                          ]
                        }
                      }
                    }
                  },
                  "tool_resources": {
                    "type": "object",
                    "description": "Resources used by the assistant's tools.",
                    "properties": {
                      "code_interpreter": {
                        "type": "object"
                      },
                      "file_search": {
                        "type": "object"
                      }
                    }
                  },
                  "metadata": {
                    "type": "object",
                    "description": "Set of key-value pairs for the assistant.",
                    "additionalProperties": true
                  },
                  "temperature": {
                    "type": "number",
                    "format": "float",
                    "description": "Temperature parameter for response generation."
                  },
                  "top_p": {
                    "type": "number",
                    "format": "float",
                    "description": "Top p parameter for response generation."
                  },
                  "response_format": {
                    "oneOf": [
                      {
                        "type": "string",
                        "enum": ["auto"]
                      },
                      {
                        "type": "object"
                      }
                    ]
                  }
                },
                "required": ["model"]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "The unique identifier of the assistant."
                    },
                    "object": {
                      "type": "string",
                      "enum": ["assistant"],
                      "description": "The object type, which is always 'assistant'."
                    },
                    "created_at": {
                      "type": "integer",
                      "description": "Unix timestamp (in seconds) of when the assistant was created."
                    },
                    "model": {
                      "type": "string",
                      "description": "The model identifier used by the assistant."
                    },
                    "name": {
                      "type": "string",
                      "description": "The name of the assistant."
                    },
                    "description": {
                      "type": "string",
                      "description": "The description of the assistant."
                    },
                    "instructions": {
                      "type": "string",
                      "description": "Instructions for the assistant's behavior."
                    },
                    "tools": {
                      "type": "array",
                      "description": "A list of tools enabled on the assistant.",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "enum": [
                              "code_interpreter",
                              "file_search",
                              "function"
                            ]
                          }
                        }
                      }
                    },
                    "tool_resources": {
                      "type": "object",
                      "description": "Resources used by the assistant's tools.",
                      "properties": {
                        "code_interpreter": {
                          "type": "object"
                        },
                        "file_search": {
                          "type": "object"
                        }
                      }
                    },
                    "metadata": {
                      "type": "object",
                      "description": "Set of key-value pairs that can be attached to the assistant.",
                      "additionalProperties": true
                    },
                    "temperature": {
                      "type": "number",
                      "format": "float",
                      "description": "Temperature parameter for response generation."
                    },
                    "top_p": {
                      "type": "number",
                      "format": "float",
                      "description": "Top p parameter for response generation."
                    },
                    "response_format": {
                      "oneOf": [
                        {
                          "type": "string",
                          "enum": ["auto"]
                        },
                        {
                          "type": "object"
                        }
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "object",
                    "created_at",
                    "model",
                    "metadata"
                  ]
                }
              }
            }
          }
        },
        "tags": ["Assistants"]
      },
      "patch": {
        "operationId": "AssistantsController_update",
        "summary": "Update assistant",
        "description": "Updates an assistant. Requires at least one modifiable field.",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "description": "The unique identifier of the assistant.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "OpenAI-Beta",
            "required": true,
            "in": "header",
            "description": "Beta feature header.",
            "schema": {
              "type": "string",
              "enum": ["assistants=v2"]
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "model": {
                    "type": "string",
                    "description": "The model identifier to use for the assistant."
                  },
                  "name": {
                    "type": "string",
                    "description": "The name of the assistant."
                  },
                  "description": {
                    "type": "string",
                    "description": "The description of the assistant."
                  },
                  "instructions": {
                    "type": "string",
                    "description": "Instructions for the assistant's behavior."
                  },
                  "tools": {
                    "type": "array",
                    "description": "A list of tools enabled on the assistant. Maximum of 128 tools.",
                    "items": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string",
                          "enum": [
                            "code_interpreter",
                            "file_search",
                            "function"
                          ]
                        }
                      }
                    }
                  },
                  "tool_resources": {
                    "type": "object",
                    "description": "Resources used by the assistant's tools.",
                    "properties": {
                      "code_interpreter": {
                        "type": "object"
                      },
                      "file_search": {
                        "type": "object"
                      }
                    }
                  },
                  "metadata": {
                    "type": "object",
                    "description": "Set of key-value pairs for the assistant.",
                    "additionalProperties": true
                  },
                  "temperature": {
                    "type": "number",
                    "format": "float",
                    "description": "Temperature parameter for response generation."
                  },
                  "top_p": {
                    "type": "number",
                    "format": "float",
                    "description": "Top p parameter for response generation."
                  },
                  "response_format": {
                    "oneOf": [
                      {
                        "type": "string",
                        "enum": ["auto"]
                      },
                      {
                        "type": "object"
                      }
                    ]
                  }
                },
                "minProperties": 1
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "The unique identifier of the assistant."
                    },
                    "object": {
                      "type": "string",
                      "enum": ["assistant"],
                      "description": "The object type, which is always 'assistant'."
                    },
                    "created_at": {
                      "type": "integer",
                      "description": "Unix timestamp (in seconds) of when the assistant was created."
                    },
                    "model": {
                      "type": "string",
                      "description": "The model identifier used by the assistant."
                    },
                    "name": {
                      "type": "string",
                      "description": "The name of the assistant."
                    },
                    "description": {
                      "type": "string",
                      "description": "The description of the assistant."
                    },
                    "instructions": {
                      "type": "string",
                      "description": "Instructions for the assistant's behavior."
                    },
                    "tools": {
                      "type": "array",
                      "description": "A list of tools enabled on the assistant.",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "enum": [
                              "code_interpreter",
                              "file_search",
                              "function"
                            ]
                          }
                        }
                      }
                    },
                    "tool_resources": {
                      "type": "object",
                      "description": "Resources used by the assistant's tools.",
                      "properties": {
                        "code_interpreter": {
                          "type": "object"
                        },
                        "file_search": {
                          "type": "object"
                        }
                      }
                    },
                    "metadata": {
                      "type": "object",
                      "description": "Set of key-value pairs that can be attached to the assistant.",
                      "additionalProperties": true
                    },
                    "temperature": {
                      "type": "number",
                      "format": "float",
                      "description": "Temperature parameter for response generation."
                    },
                    "top_p": {
                      "type": "number",
                      "format": "float",
                      "description": "Top p parameter for response generation."
                    },
                    "response_format": {
                      "oneOf": [
                        {
                          "type": "string",
                          "enum": ["auto"]
                        },
                        {
                          "type": "object"
                        }
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "object",
                    "created_at",
                    "model",
                    "metadata"
                  ]
                }
              }
            }
          }
        },
        "tags": ["Assistants"]
      },
      "get": {
        "operationId": "AssistantsController_list",
        "summary": "List assistants",
        "description": "Returns a list of assistants.",
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "enum": ["list"],
                      "description": "The object type, which is always 'list' for a list response."
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The unique identifier of the assistant."
                          },
                          "object": {
                            "type": "string",
                            "enum": ["assistant"],
                            "description": "The object type, which is always 'assistant'."
                          },
                          "created_at": {
                            "type": "integer",
                            "description": "Unix timestamp (in seconds) of when the assistant was created."
                          },
                          "model": {
                            "type": "string",
                            "description": "The model identifier used by the assistant."
                          },
                          "metadata": {
                            "type": "object",
                            "description": "Set of key-value pairs that can be attached to the assistant.",
                            "additionalProperties": true
                          }
                        },
                        "required": [
                          "id",
                          "object",
                          "created_at",
                          "model",
                          "metadata"
                        ]
                      }
                    }
                  },
                  "required": ["object", "data"]
                }
              }
            }
          }
        },
        "tags": ["Assistants"]
      }
    },
    "/assistants/{id}": {
      "get": {
        "operationId": "AssistantsController_findOne",
        "summary": "Get assistant",
        "description": "Retrieves a specific assistant by ID.",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "description": "The unique identifier of the assistant.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "OpenAI-Beta",
            "required": true,
            "in": "header",
            "description": "Beta feature header.",
            "schema": {
              "type": "string",
              "enum": ["assistants=v2"]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "The unique identifier of the assistant."
                    },
                    "object": {
                      "type": "string",
                      "enum": ["assistant"],
                      "description": "The object type, which is always 'assistant'."
                    },
                    "created_at": {
                      "type": "integer",
                      "description": "Unix timestamp (in seconds) of when the assistant was created."
                    },
                    "model": {
                      "type": "string",
                      "description": "The model identifier used by the assistant."
                    },
                    "metadata": {
                      "type": "object",
                      "description": "Set of key-value pairs attached to the assistant.",
                      "additionalProperties": true
                    }
                  },
                  "required": [
                    "id",
                    "object",
                    "created_at",
                    "model",
                    "metadata"
                  ]
                }
              }
            }
          }
        },
        "tags": ["Assistants"]
      },
      "delete": {
        "operationId": "AssistantsController_remove",
        "summary": "Delete assistant",
        "description": "Deletes a specific assistant by ID.",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "description": "The unique identifier of the assistant.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "The unique identifier of the deleted assistant."
                    },
                    "object": {
                      "type": "string",
                      "enum": ["assistant.deleted"],
                      "description": "The object type for a deleted assistant."
                    },
                    "deleted": {
                      "type": "boolean",
                      "enum": [true],
                      "description": "Indicates the assistant was successfully deleted."
                    }
                  },
                  "required": ["id", "object", "deleted"]
                }
              }
            }
          }
        },
        "tags": ["Assistants"]
      }
    },
    "/healthz": {
      "servers": [
        {
          "url": "/"
        }
      ],
      "get": {
        "operationId": "HealthController_check",
        "summary": "Check health",
        "description": "Performs a comprehensive check of the application's health status.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {}
            }
          }
        },
        "tags": ["Server"]
      }
    },
    "/processManager/destroy": {
      "servers": [
        {
          "url": "/"
        }
      ],
      "delete": {
        "operationId": "Terminate server process",
        "summary": "Terminate server",
        "description": "Initiates the shutdown process for the server, ensuring that all active connections are gracefully closed and any ongoing processes are properly terminated.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {}
            }
          }
        },
        "tags": ["Server"]
      }
    },
    "/embeddings": {
      "post": {
        "summary": "Create embeddings",
        "description": "Creates an embedding vector representing the input text.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "input": {
                    "oneOf": [
                      {
                        "type": "string",
                        "description": "The string that will be turned into an embedding."
                      },
                      {
                        "type": "array",
                        "description": "The array of strings that will be turned into an embedding.",
                        "items": {
                          "type": "string"
                        }
                      },
                      {
                        "type": "array",
                        "description": "The array of integers that will be turned into an embedding.",
                        "items": {
                          "type": "integer"
                        }
                      },
                      {
                        "type": "array",
                        "description": "The array of arrays containing integers that will be turned into an embedding.",
                        "items": {
                          "type": "array",
                          "items": {
                            "type": "integer"
                          }
                        }
                      }
                    ],
                    "description": "Input text to embed, encoded as a string or array of tokens. Cannot be empty."
                  },
                  "model": {
                    "type": "string",
                    "description": "ID of the model to use.",
                    "example": "text-embedding-ada-002"
                  },
                  "encoding_format": {
                    "type": "string",
                    "description": "The format to return the embeddings in.",
                    "enum": ["float", "base64"],
                    "default": "float"
                  }
                },
                "required": ["input", "model"]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A list of embedding vectors",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "index": {
                            "type": "integer",
                            "description": "The index of the embedding in the list of embeddings."
                          },
                          "embedding": {
                            "type": "array",
                            "items": {
                              "type": "number"
                            },
                            "description": "The embedding vector, which is a list of floats."
                          },
                          "object": {
                            "type": "string",
                            "description": "The object type, which is always 'embedding'.",
                            "example": "embedding"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "tags": ["Embeddings"]
      }
    },
    "/chat/completions": {
      "post": {
        "operationId": "ChatController_create",
        "summary": "Create chat completion",
        "description": "Creates a model response for the given conversation. The following parameters are not working for the `TensorRT-LLM` engine:\n- `frequency_penalty`\n- `presence_penalty`\n- `top_p`",
        "parameters": [],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateChatCompletionDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "title": "Chat Completion Response",
                      "$ref": "#/components/schemas/ChatCompletionResponseDto"
                    },
                    {
                      "title": "Chat Completion Chunk Response",
                      "$ref": "#/components/schemas/ChatCompletionChunkResponseDto"
                    }
                  ]
                }
              }
            }
          }
        },
        "tags": ["Chat"]
      }
    },
    "/models/pull": {
      "post": {
        "operationId": "ModelsController_pullModel",
        "summary": "Pull a model",
        "description": "Pull a model from a remote source.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PullModelRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string"
                    },
                    "task": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "items": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "bytes": {
                                "type": "integer"
                              },
                              "checksum": {
                                "type": "string"
                              },
                              "downloadUrl": {
                                "type": "string"
                              },
                              "downloadedBytes": {
                                "type": "integer"
                              },
                              "id": {
                                "type": "string"
                              },
                              "localPath": {
                                "type": "string"
                              }
                            }
                          }
                        },
                        "type": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "message": "Model start downloading!",
                  "task": {
                    "id": "TheBloke:Mistral-7B-Instruct-v0.1-GGUF:mistral-7b-instruct-v0.1.Q3_K_L.gguf",
                    "items": [
                      {
                        "bytes": 3822024352,
                        "checksum": "N/A",
                        "downloadUrl": "https://huggingface.co/TheBloke/Mistral-7B-Instruct-v0.1-GGUF/resolve/main/mistral-7b-instruct-v0.1.Q3_K_L.gguf",
                        "downloadedBytes": 0,
                        "id": "TheBloke:Mistral-7B-Instruct-v0.1-GGUF:mistral-7b-instruct-v0.1.Q3_K_L.gguf",
                        "localPath": "/Users/user_name/cortexcpp/models/huggingface.co/TheBloke/Mistral-7B-Instruct-v0.1-GGUF/mistral-7b-instruct-v0.1.Q3_K_L.gguf"
                      }
                    ],
                    "type": "Model"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SimpleErrorResponse"
                }
              }
            }
          }
        },
        "tags": ["Pulling Models"]
      },
      "delete": {
        "tags": ["Pulling Models"],
        "summary": "Stop model download",
        "description": "Stops the download of a model with the corresponding taskId provided in the request body",
        "operationId": "ModelsController_stopModelDownload",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "taskId": {
                    "type": "string",
                    "description": "The unique identifier of the download task to be stopped"
                  }
                },
                "required": ["taskId"]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Download stopped successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Download stopped successfully"
                    },
                    "taskId": {
                      "type": "string",
                      "example": "task-123456"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Invalid taskId"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Task not found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Download task not found"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "An unexpected error occurred"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/models/add": {
      "post": {
        "operationId": "ModelsController_addModel",
        "summary": "Add a remote model",
        "description": "Add a new remote model configuration to the system.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddModelRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string"
                    },
                    "model": {
                      "type": "object",
                      "properties": {
                        "model": {
                          "type": "string"
                        },
                        "engine": {
                          "type": "string"
                        },
                        "version": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "message": "Model added successfully!",
                  "model": {
                    "model": "claude-3-5-sonnet-20241022",
                    "engine": "anthropic",
                    "version": "2023-06-01"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SimpleErrorResponse"
                }
              }
            }
          }
        },
        "tags": ["Pulling Models"]
      }
    },
    "/models": {
      "get": {
        "operationId": "ModelsController_findAll",
        "summary": "List models",
        "description": "Lists the currently available models, and provides basic information about each one such as the owner and availability. [Equivalent to OpenAI's list model](https://platform.openai.com/docs/api-reference/models/list).",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListModelsResponseDto"
                }
              }
            }
          }
        },
        "tags": ["Running Models"]
      }
    },
    "/models/start": {
      "post": {
        "operationId": "ModelsController_startModel",
        "summary": "Start model",
        "description": "Load a model into memory. Note: Request body parameters will override those loaded from model.yml",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ModelStartDto"
              },
              "example": {
                "model": "llama3:8b-gguf-q6-k"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The model has been successfully started.",
            "content": {
              "application/json": {
                "example": {
                  "message": "Started successfully!"
                }
              }
            }
          }
        },
        "tags": ["Running Models"]
      }
    },
    "/models/stop": {
      "post": {
        "operationId": "ModelsController_stopModel",
        "summary": "Stop model",
        "description": "Unload model from memory",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ModelStopDto"
              },
              "example": {
                "model": "llama3:8b-gguf-q6-k"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The model has been successfully started.",
            "content": {
              "application/json": {
                "example": {
                  "message": "Stopped successfully!"
                }
              }
            }
          }
        },
        "tags": ["Running Models"]
      }
    },
    "/models/{id}": {
      "get": {
        "operationId": "ModelsController_findOne",
        "summary": "Get model",
        "description": "Retrieves a model instance, providing basic information about the model such as the owner and permissions. [Equivalent to OpenAI's list model](https://platform.openai.com/docs/api-reference/models/retrieve).",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "description": "The unique identifier of the model.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ModelDto"
                }
              }
            }
          }
        },
        "tags": ["Running Models"]
      },
      "delete": {
        "operationId": "ModelsController_remove",
        "summary": "Delete model",
        "description": "Deletes a model. [Equivalent to OpenAI's delete model](https://platform.openai.com/docs/api-reference/models/delete).",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "description": "The unique identifier of the model.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The model has been successfully deleted.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeleteModelResponseDto"
                }
              }
            }
          }
        },
        "tags": ["Running Models"]
      }
    },
    "/models/{model}": {
      "patch": {
        "operationId": "ModelsController_update",
        "summary": "Update model",
        "description": "Updates a model instance defined by a model's `id`.",
        "parameters": [
          {
            "name": "model",
            "required": true,
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateModelDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The model has been successfully updated.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateModelDto"
                }
              }
            }
          }
        },
        "tags": ["Running Models"]
      }
    },
    "/models/import": {
      "post": {
        "operationId": "ModelsController_importModel",
        "summary": "Import model",
        "description": "Imports a model from a specified path.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ImportModelRequest"
              },
              "example": {
                "model": "model-id",
                "modelPath": "/path/to/gguf",
                "name": "model display name",
                "option": "symlink"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Model is imported successfully!",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ImportModelResponse"
                },
                "example": {
                  "message": "Model is imported successfully!",
                  "modelHandle": "model-id",
                  "result": "OK"
                }
              }
            }
          }
        },
        "tags": ["Pulling Models"]
      }
    },
    "/models/sources": {
      "post": {
        "summary": "Add a model source",
        "description": "User can add a Huggingface Organization or Repository",
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "source": {
                    "type": "string",
                    "description": "The url of model source to add",
                    "example": "https://huggingface.co/cortexso/tinyllama"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful installation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Added model source"
                    }
                  }
                }
              }
            }
          }
        },
        "tags": ["Pulling Models"]
      },
      "delete": {
        "summary": "Remove a model source",
        "description": "User can remove a Huggingface Organization or Repository",
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "source": {
                    "type": "string",
                    "description": "The url of model source to remove",
                    "example": "https://huggingface.co/cortexso/tinyllama"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful uninstallation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Removed model source successfully!",
                      "example": "Removed model source successfully!"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Error message describing the issue with the request"
                    }
                  }
                }
              }
            }
          }
        },
        "tags": ["Pulling Models"]
      }
    },
    "/threads": {
      "post": {
        "summary": "Create Thread",
        "description": "Creates a new thread with optional metadata.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "metadata": {
                    "type": "object",
                    "properties": {
                      "title": {
                        "type": "string",
                        "description": "Title of the thread"
                      }
                    },
                    "description": "Optional metadata for the thread"
                  }
                }
              },
              "example": {
                "metadata": {
                  "title": "New Thread"
                }
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "description": "Thread created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "created_at": {
                      "type": "integer",
                      "description": "Unix timestamp of when the thread was created"
                    },
                    "id": {
                      "type": "string",
                      "description": "Unique identifier for the thread"
                    },
                    "metadata": {
                      "type": "object",
                      "properties": {
                        "title": {
                          "type": "string",
                          "description": "Title of the thread"
                        }
                      },
                      "description": "Metadata associated with the thread"
                    },
                    "object": {
                      "type": "string",
                      "description": "Type of object, always 'thread'"
                    }
                  },
                  "required": ["created_at", "id", "object"]
                },
                "example": {
                  "created_at": 1734020845,
                  "id": "0001KNP3QDX314435VAEGW1Z2X",
                  "metadata": {
                    "title": "New Thread"
                  },
                  "object": "thread"
                }
              }
            }
          }
        },
        "tags": ["Threads"]
      },
      "get": {
        "summary": "List Threads",
        "description": "Returns a list of threads with their metadata.",
        "responses": {
          "200": {
            "description": "List of threads retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "description": "Type of the list response, always 'list'"
                    },
                    "data": {
                      "type": "array",
                      "description": "Array of thread objects",
                      "items": {
                        "type": "object",
                        "properties": {
                          "created_at": {
                            "type": "integer",
                            "description": "Unix timestamp of when the thread was created"
                          },
                          "id": {
                            "type": "string",
                            "description": "Unique identifier for the thread"
                          },
                          "metadata": {
                            "type": "object",
                            "properties": {
                              "title": {
                                "type": "string",
                                "description": "Title of the thread"
                              },
                              "lastMessage": {
                                "type": "string",
                                "description": "Content of the last message in the thread"
                              }
                            },
                            "description": "Metadata associated with the thread"
                          },
                          "object": {
                            "type": "string",
                            "description": "Type of object, always 'thread'"
                          }
                        },
                        "required": ["created_at", "id", "object"]
                      }
                    }
                  },
                  "required": ["object", "data"]
                },
                "example": {
                  "data": [
                    {
                      "created_at": 1734020845,
                      "id": "0001KNP3QDX314435VAEGW1Z2X",
                      "metadata": {
                        "title": "New Thread"
                      },
                      "object": "thread"
                    },
                    {
                      "created_at": 1734020803,
                      "id": "0001KNP3P3DAQSDVEQGRBTCTNJ",
                      "metadata": {
                        "title": ""
                      },
                      "object": "thread"
                    }
                  ],
                  "object": "list"
                }
              }
            }
          }
        },
        "tags": ["Threads"]
      }
    },
    "/threads/{id}": {
      "get": {
        "summary": "Retrieve Thread",
        "description": "Retrieves a specific thread by its ID.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "The ID of the thread to retrieve",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Thread retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "created_at": {
                      "type": "integer",
                      "description": "Unix timestamp of when the thread was created"
                    },
                    "id": {
                      "type": "string",
                      "description": "Unique identifier for the thread"
                    },
                    "metadata": {
                      "type": "object",
                      "properties": {
                        "lastMessage": {
                          "type": "string",
                          "description": "Content of the last message in the thread"
                        },
                        "title": {
                          "type": "string",
                          "description": "Title of the thread"
                        }
                      },
                      "description": "Metadata associated with the thread"
                    },
                    "object": {
                      "type": "string",
                      "description": "Type of object, always 'thread'"
                    }
                  },
                  "required": ["created_at", "id", "object"]
                },
                "example": {
                  "created_at": 1732370026,
                  "id": "jan_1732370027",
                  "metadata": {
                    "lastMessage": "Based on the context, I'm not sure how to build a unique experience quickly and easily. The text mentions that there are some concerns about Android apps providing consistent experiences for different users, which makes me skeptical about building one.\n\nSpecifically, it says:\n\n* \"Might not pass CTS\" (Computer Science Technology standards)\n* \"Might not comply with CDD\" (Consumer Development Division standards)\n\nThis suggests that building a unique experience for all users could be challenging or impossible. Therefore, I don't know how to build a unique experience quickly and easily.\n\nWould you like me to try again?",
                    "title": "hello"
                  },
                  "object": "thread"
                }
              }
            }
          }
        },
        "tags": ["Threads"]
      },
      "patch": {
        "summary": "Modify Thread",
        "description": "Updates a specific thread's metadata.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "The ID of the thread to modify",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "metadata": {
                    "type": "object",
                    "properties": {
                      "title": {
                        "type": "string",
                        "description": "New title for the thread"
                      }
                    },
                    "description": "Metadata to update"
                  }
                }
              },
              "example": {
                "metadata": {
                  "title": "my title"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Thread modified successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "created_at": {
                      "type": "integer",
                      "description": "Unix timestamp of when the thread was created"
                    },
                    "id": {
                      "type": "string",
                      "description": "Unique identifier for the thread"
                    },
                    "metadata": {
                      "type": "object",
                      "properties": {
                        "title": {
                          "type": "string",
                          "description": "Updated title of the thread"
                        }
                      },
                      "description": "Updated metadata for the thread"
                    },
                    "object": {
                      "type": "string",
                      "description": "Type of object, always 'thread'"
                    }
                  },
                  "required": ["created_at", "id", "object"]
                },
                "example": {
                  "created_at": 1733301054,
                  "id": "0001KN04SY7D75K0MPTXMXCH39",
                  "metadata": {
                    "title": "my title"
                  },
                  "object": "thread"
                }
              }
            }
          }
        },
        "tags": ["Threads"]
      },
      "delete": {
        "summary": "Delete Thread",
        "description": "Deletes a specific thread by its ID.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "The ID of the thread to delete",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Thread deleted successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "deleted": {
                      "type": "boolean",
                      "description": "Indicates if the thread was successfully deleted"
                    },
                    "id": {
                      "type": "string",
                      "description": "ID of the deleted thread"
                    },
                    "object": {
                      "type": "string",
                      "description": "Type of object, always 'thread.deleted'"
                    }
                  },
                  "required": ["deleted", "id", "object"]
                },
                "example": {
                  "deleted": true,
                  "id": "jan_1732370027",
                  "object": "thread.deleted"
                }
              }
            }
          }
        },
        "tags": ["Threads"]
      }
    },
    "/threads/{thread_id}/messages": {
      "post": {
        "summary": "Create Message",
        "description": "Creates a new message in a thread.",
        "parameters": [
          {
            "name": "thread_id",
            "in": "path",
            "required": true,
            "description": "The ID of the thread to create the message in",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "role": {
                    "type": "string",
                    "description": "Role of the message sender",
                    "enum": ["user", "assistant"]
                  },
                  "content": {
                    "type": "string",
                    "description": "The content of the message"
                  }
                },
                "required": ["role", "content"]
              },
              "example": {
                "role": "user",
                "content": "Hello, world!"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Message created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Unique identifier for the message"
                    },
                    "object": {
                      "type": "string",
                      "description": "Type of object, always 'thread.message'"
                    },
                    "created_at": {
                      "type": "integer",
                      "description": "Unix timestamp of when the message was created"
                    },
                    "completed_at": {
                      "type": "integer",
                      "description": "Unix timestamp of when the message was completed"
                    },
                    "thread_id": {
                      "type": "string",
                      "description": "ID of the thread this message belongs to"
                    },
                    "role": {
                      "type": "string",
                      "description": "Role of the message sender",
                      "enum": ["user", "assistant"]
                    },
                    "status": {
                      "type": "string",
                      "description": "Status of the message",
                      "enum": ["completed"]
                    },
                    "content": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "description": "Type of content",
                            "enum": ["text"]
                          },
                          "text": {
                            "type": "object",
                            "properties": {
                              "value": {
                                "type": "string",
                                "description": "The message text"
                              },
                              "annotations": {
                                "type": "array",
                                "description": "Array of annotations for the text"
                              }
                            }
                          }
                        }
                      }
                    },
                    "metadata": {
                      "type": "object",
                      "description": "Additional metadata for the message"
                    }
                  },
                  "required": [
                    "id",
                    "object",
                    "created_at",
                    "completed_at",
                    "thread_id",
                    "role",
                    "status",
                    "content"
                  ]
                },
                "example": {
                  "completed_at": 1734023130,
                  "content": [
                    {
                      "text": {
                        "annotations": [],
                        "value": "Hello, world!"
                      },
                      "type": "text"
                    }
                  ],
                  "created_at": 1734023130,
                  "id": "0001KNP5YT00GW0X476W5TVBFE",
                  "metadata": {},
                  "object": "thread.message",
                  "role": "user",
                  "status": "completed",
                  "thread_id": "jan_1732370027"
                }
              }
            }
          }
        },
        "tags": ["Messages"]
      },
      "get": {
        "summary": "List Messages",
        "description": "Retrieves a list of messages in a thread with optional pagination and filtering.",
        "parameters": [
          {
            "name": "thread_id",
            "in": "path",
            "required": true,
            "description": "The ID of the thread to list messages from",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Maximum number of messages to return",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "order",
            "in": "query",
            "required": false,
            "description": "Sort order of messages",
            "schema": {
              "type": "string",
              "enum": ["asc", "desc"]
            }
          },
          {
            "name": "after",
            "in": "query",
            "required": false,
            "description": "Cursor for fetching messages after this message ID",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "before",
            "in": "query",
            "required": false,
            "description": "Cursor for fetching messages before this message ID",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "run_id",
            "in": "query",
            "required": false,
            "description": "Filter messages by run ID",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Messages retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "object": {
                      "type": "string",
                      "description": "Type of the list response, always 'list'"
                    },
                    "data": {
                      "type": "array",
                      "description": "Array of message objects",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Unique identifier for the message"
                          },
                          "object": {
                            "type": "string",
                            "description": "Type of object, always 'thread.message'"
                          },
                          "created_at": {
                            "type": "integer",
                            "description": "Unix timestamp of when the message was created"
                          },
                          "thread_id": {
                            "type": "string",
                            "description": "ID of the thread this message belongs to"
                          },
                          "role": {
                            "type": "string",
                            "description": "Role of the message sender",
                            "enum": ["assistant", "user"]
                          },
                          "status": {
                            "type": "string",
                            "description": "Status of the message",
                            "enum": ["completed"]
                          },
                          "content": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "type": {
                                  "type": "string",
                                  "description": "Type of content",
                                  "enum": ["text"]
                                },
                                "text": {
                                  "type": "object",
                                  "properties": {
                                    "value": {
                                      "type": "string",
                                      "description": "The message text"
                                    },
                                    "annotations": {
                                      "type": "array",
                                      "description": "Array of annotations for the text"
                                    }
                                  }
                                }
                              }
                            }
                          },
                          "metadata": {
                            "type": "object",
                            "description": "Additional metadata for the message"
                          },
                          "attachments": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "file_id": {
                                  "type": "string",
                                  "description": "ID of the attached file"
                                },
                                "tools": {
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "properties": {
                                      "type": {
                                        "type": "string",
                                        "description": "Type of tool used"
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        },
                        "required": [
                          "id",
                          "object",
                          "created_at",
                          "thread_id",
                          "role",
                          "content"
                        ]
                      }
                    }
                  },
                  "required": ["object", "data"]
                },
                "example": {
                  "data": [
                    {
                      "content": [
                        {
                          "text": {
                            "annotations": [],
                            "value": "Based on the context, I'm not sure how to build a unique experience quickly and easily..."
                          },
                          "type": "text"
                        }
                      ],
                      "created_at": 1732633637,
                      "id": "01JDMG6CG6DD4B3RQN82QD8Q7P",
                      "metadata": {},
                      "object": "thread.message",
                      "role": "assistant",
                      "status": "completed",
                      "thread_id": "jan_1732370027"
                    }
                  ],
                  "object": "list"
                }
              }
            }
          }
        },
        "tags": ["Messages"]
      }
    },
    "/threads/{thread_id}/messages/{message_id}": {
      "get": {
        "summary": "Retrieve Message",
        "description": "Retrieves a specific message from a thread by its ID.",
        "parameters": [
          {
            "name": "thread_id",
            "in": "path",
            "required": true,
            "description": "The ID of the thread containing the message",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "message_id",
            "in": "path",
            "required": true,
            "description": "The ID of the message to retrieve",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Message retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Unique identifier for the message"
                    },
                    "object": {
                      "type": "string",
                      "description": "Type of object, always 'thread.message'"
                    },
                    "created_at": {
                      "type": "integer",
                      "description": "Unix timestamp of when the message was created"
                    },
                    "thread_id": {
                      "type": "string",
                      "description": "ID of the thread this message belongs to"
                    },
                    "role": {
                      "type": "string",
                      "description": "Role of the message sender",
                      "enum": ["assistant", "user"]
                    },
                    "status": {
                      "type": "string",
                      "description": "Status of the message",
                      "enum": ["completed"]
                    },
                    "content": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "description": "Type of content",
                            "enum": ["text"]
                          },
                          "text": {
                            "type": "object",
                            "properties": {
                              "value": {
                                "type": "string",
                                "description": "The message text"
                              },
                              "annotations": {
                                "type": "array",
                                "description": "Array of annotations for the text"
                              }
                            }
                          }
                        }
                      }
                    },
                    "metadata": {
                      "type": "object",
                      "description": "Additional metadata for the message"
                    },
                    "attachments": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "file_id": {
                            "type": "string",
                            "description": "ID of the attached file"
                          },
                          "tools": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "type": {
                                  "type": "string",
                                  "description": "Type of tool used"
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  "required": [
                    "id",
                    "object",
                    "created_at",
                    "thread_id",
                    "role",
                    "content"
                  ]
                },
                "example": {
                  "attachments": [
                    {
                      "file_id": "01JDMG617BHMPW859VE18BPQ7Y",
                      "tools": [
                        {
                          "type": "file_search"
                        }
                      ]
                    }
                  ],
                  "content": [
                    {
                      "text": {
                        "annotations": [],
                        "value": "summary this"
                      },
                      "type": "text"
                    }
                  ],
                  "created_at": 1732633625,
                  "id": "01JDMG617BHMPW859VE18BPQ7Y",
                  "metadata": {},
                  "object": "thread.message",
                  "role": "user",
                  "status": "completed",
                  "thread_id": "jan_1732370027"
                }
              }
            }
          }
        },
        "tags": ["Messages"]
      },
      "patch": {
        "summary": "Modify Message",
        "description": "Modifies a specific message's content or metadata in a thread.",
        "parameters": [
          {
            "name": "thread_id",
            "in": "path",
            "required": true,
            "description": "The ID of the thread containing the message",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "message_id",
            "in": "path",
            "required": true,
            "description": "The ID of the message to modify",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "content": {
                    "type": "object",
                    "description": "New content for the message"
                  },
                  "metadata": {
                    "type": "object",
                    "description": "Updated metadata for the message",
                    "additionalProperties": true
                  }
                }
              },
              "example": {
                "content": {},
                "metadata": {
                  "test": 1
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Message modified successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Unique identifier for the message"
                    },
                    "object": {
                      "type": "string",
                      "description": "Type of object, always 'thread.message'"
                    },
                    "created_at": {
                      "type": "integer",
                      "description": "Unix timestamp of when the message was created"
                    },
                    "completed_at": {
                      "type": "integer",
                      "description": "Unix timestamp of when the message was completed"
                    },
                    "thread_id": {
                      "type": "string",
                      "description": "ID of the thread this message belongs to"
                    },
                    "role": {
                      "type": "string",
                      "description": "Role of the message sender",
                      "enum": ["user", "assistant"]
                    },
                    "status": {
                      "type": "string",
                      "description": "Status of the message",
                      "enum": ["completed"]
                    },
                    "content": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "description": "Type of content",
                            "enum": ["text"]
                          },
                          "text": {
                            "type": "object",
                            "properties": {
                              "value": {
                                "type": "string",
                                "description": "The message text"
                              },
                              "annotations": {
                                "type": "array",
                                "description": "Array of annotations for the text"
                              }
                            }
                          }
                        }
                      }
                    },
                    "metadata": {
                      "type": "object",
                      "description": "Additional metadata for the message",
                      "additionalProperties": true
                    }
                  },
                  "required": [
                    "id",
                    "object",
                    "created_at",
                    "completed_at",
                    "thread_id",
                    "role",
                    "status",
                    "content"
                  ]
                },
                "example": {
                  "completed_at": 1734023130,
                  "content": [
                    {
                      "text": {
                        "annotations": [],
                        "value": "Hello, world!"
                      },
                      "type": "text"
                    }
                  ],
                  "created_at": 1734023130,
                  "id": "0001KNP5YT00GW0X476W5TVBFE",
                  "metadata": {
                    "test": 1
                  },
                  "object": "thread.message",
                  "role": "user",
                  "status": "completed",
                  "thread_id": "jan_1732370027"
                }
              }
            }
          }
        },
        "tags": ["Messages"]
      },
      "delete": {
        "summary": "Delete Message",
        "description": "Deletes a specific message from a thread.",
        "parameters": [
          {
            "name": "thread_id",
            "in": "path",
            "required": true,
            "description": "The ID of the thread containing the message",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "message_id",
            "in": "path",
            "required": true,
            "description": "The ID of the message to delete",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Message deleted successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "deleted": {
                      "type": "boolean",
                      "description": "Indicates if the message was successfully deleted"
                    },
                    "id": {
                      "type": "string",
                      "description": "ID of the deleted message"
                    },
                    "object": {
                      "type": "string",
                      "description": "Type of object, always 'thread.message.deleted'"
                    }
                  },
                  "required": ["deleted", "id", "object"]
                },
                "example": {
                  "deleted": true,
                  "id": "01JDCMZPBGDP276D6Z2QN2MJMX",
                  "object": "thread.message.deleted"
                }
              }
            }
          }
        },
        "tags": ["Messages"]
      }
    },
    "/system": {
      "servers": [
        {
          "url": "/"
        }
      ],
      "delete": {
        "operationId": "SystemController_delete",
        "summary": "Stop api server",
        "description": "Stops the Cortex API endpoint server for the detached mode.",
        "parameters": [],
        "responses": {
          "200": {
            "description": ""
          }
        },
        "tags": ["System"]
      },
      "get": {
        "operationId": "SystemController_get",
        "summary": "Get health status",
        "description": "Retrieves the health status of your Cortex's system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Ok"
          }
        },
        "tags": ["System"]
      }
    },
    "/system/events/download": {
      "servers": [
        {
          "url": "/"
        }
      ],
      "get": {
        "operationId": "SystemController_downloadEvent",
        "summary": "Get download status",
        "description": "Retrieves the model's download status.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "tags": ["System"]
      }
    },
    "/system/events/model": {
      "servers": [
        {
          "url": "/"
        }
      ],
      "get": {
        "operationId": "SystemController_modelEvent",
        "summary": "Get model status",
        "description": "Retrieves all the available model statuses within Cortex.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "tags": ["System"]
      }
    },
    "/system/events/resources": {
      "servers": [
        {
          "url": "/"
        }
      ],
      "get": {
        "operationId": "SystemController_resourcesEvent",
        "summary": "Get resources status",
        "description": "Retrieves the resources status of the system.",
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "tags": ["System"]
      }
    },
    "/engines/{name}": {
      "get": {
        "operationId": "EnginesController_listInstalledEngines",
        "summary": "List installed engines",
        "description": "List installed engines for a particular engine type.",
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "enum": ["llama-cpp", "onnxruntime", "tensorrt-llm"],
              "default": "llama-cpp"
            },
            "description": "The type of engine"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "engine": {
                        "type": "string",
                        "example": "llama-cpp"
                      },
                      "name": {
                        "type": "string",
                        "example": "mac-arm64"
                      },
                      "version": {
                        "type": "string",
                        "example": "0.1.35-28.10.24"
                      }
                    }
                  }
                },
                "example": [
                  {
                    "engine": "llama-cpp",
                    "name": "mac-arm64",
                    "version": "0.1.35-28.10.24"
                  },
                  {
                    "engine": "llama-cpp",
                    "name": "linux-amd64-avx",
                    "version": "0.1.35-27.10.24"
                  }
                ]
              }
            }
          }
        },
        "tags": ["Engines"]
      }
    },
    "/engines/{name}/releases": {
      "get": {
        "summary": "List released engines",
        "description": "List released engines of a specific engine type.",
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "enum": ["llama-cpp", "onnxruntime", "tensorrt-llm"],
              "default": "llama-cpp"
            },
            "description": "The type of engine"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful installation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "draft": {
                        "type": "boolean",
                        "example": false
                      },
                      "name": {
                        "type": "string",
                        "example": "v0.1.39-20.11.24"
                      },
                      "prerelease": {
                        "type": "boolean",
                        "example": true
                      },
                      "published_at": {
                        "type": "string",
                        "format": "date-time",
                        "example": "2024-11-20T17:39:40Z"
                      },
                      "url": {
                        "type": "string",
                        "example": "https://api.github.com/repos/menloresearch/cortex.llamacpp/releases/186479804"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "tags": ["Engines"]
      }
    },
    "/engines/{name}/releases/{version}": {
      "get": {
        "summary": "List variants for a specific engine version",
        "description": "Lists all available variants (builds) for a specific version of an engine. Variants can include different CPU architectures (AVX, AVX2, AVX512), GPU support (CUDA, Vulkan), and operating systems (Windows, Linux, macOS).",
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "enum": ["llama-cpp", "onnxruntime", "tensorrt-llm"],
              "default": "llama-cpp"
            },
            "description": "The type of engine"
          },
          {
            "name": "version",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "The version of the engine"
          },
          {
            "name": "show",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": ["all", "compatible"],
              "default": "all"
            },
            "description": "Filter the variants list. Use 'compatible' to show only variants compatible with the current system, or 'all' to show all available variants."
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully retrieved variants list",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "The name of the variant, including OS, architecture, and capabilities",
                        "example": "linux-amd64-avx-cuda-11-7"
                      },
                      "created_at": {
                        "type": "string",
                        "format": "date-time",
                        "description": "Creation timestamp of the variant",
                        "example": "2024-11-13T04:51:16Z"
                      },
                      "size": {
                        "type": "integer",
                        "description": "Size of the variant in bytes",
                        "example": 151224604
                      },
                      "download_count": {
                        "type": "integer",
                        "description": "Number of times this variant has been downloaded",
                        "example": 0
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "tags": ["Engines"]
      }
    },
    "/engines/{name}/releases/latest": {
      "get": {
        "summary": "Get latest release",
        "description": "Return variants for the latest engine release of a specific engine type.",
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "enum": ["llama-cpp", "onnxruntime", "tensorrt-llm"],
              "default": "llama-cpp"
            },
            "description": "The type of engine"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful installation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "created_at": {
                        "type": "string",
                        "format": "date-time",
                        "example": "2024-11-15T10:39:39Z"
                      },
                      "download_count": {
                        "type": "integer",
                        "example": 76
                      },
                      "name": {
                        "type": "string",
                        "example": "0.1.39-linux-amd64-avx-cuda-11-7"
                      },
                      "size": {
                        "type": "integer",
                        "example": 151215080
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "tags": ["Engines"]
      }
    },
    "/engines/{name}/install": {
      "post": {
        "summary": "Install an engine",
        "description": "Install an engine of a specific type, with optional version and variant. If none are provided, the latest version and most suitable variant will be installed.",
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "llama-cpp",
                "onnxruntime",
                "tensorrt-llm",
                "openai",
                "anthropic"
              ],
              "default": "llama-cpp"
            },
            "description": "The type of engine"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "version": {
                    "type": "string",
                    "description": "The version of the engine to install (optional)",
                    "example": "v0.1.39"
                  },
                  "variant": {
                    "type": "string",
                    "description": "The variant of the engine to install (optional)",
                    "example": "mac-arm64"
                  },
                  "type": {
                    "type": "string",
                    "description": "The type of connection, remote or local",
                    "example": "remote"
                  },
                  "url": {
                    "type": "string",
                    "description": "The URL for the API endpoint for remote engine",
                    "example": "https://api.openai.com"
                  },
                  "api_key": {
                    "type": "string",
                    "description": "The API key for authentication for remote engine",
                    "example": ""
                  },
                  "metadata": {
                    "type": "object",
                    "properties": {
                      "get_models_url": {
                        "type": "string",
                        "description": "The URL to get models",
                        "example": "https://api.openai.com/models"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful installation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Engine starts installing!"
                    }
                  }
                }
              }
            }
          }
        },
        "tags": ["Engines"]
      },
      "delete": {
        "summary": "Uninstall an engine",
        "description": "Uninstall an engine based on engine, version, and variant. If version and variant are not provided, all versions and variants of the engine will be uninstalled.",
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "llama-cpp",
                "onnxruntime",
                "tensorrt-llm",
                "openai",
                "anthropic"
              ],
              "default": "llama-cpp"
            },
            "description": "The type of engine"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "version": {
                    "type": "string",
                    "description": "The version of the engine to uninstall (optional)",
                    "example": "v0.1.39"
                  },
                  "variant": {
                    "type": "string",
                    "description": "The variant of the engine to uninstall (optional)",
                    "example": "mac-arm64"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful uninstallation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Engine llama-cpp uninstalled successfully!",
                      "example": "Engine llama-cpp uninstalled successfully!"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Error message describing the issue with the request"
                    }
                  }
                }
              }
            }
          }
        },
        "tags": ["Engines"]
      }
    },
    "/engines/{name}/update": {
      "post": {
        "summary": "Update engine",
        "description": "Updates the specified engine type using the engine variant currently set as default.",
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "enum": ["llama-cpp", "onnxruntime", "tensorrt-llm"],
              "default": "llama-cpp"
            },
            "description": "The name of the engine to update"
          }
        ],
        "responses": {
          "200": {
            "description": "Engine updated successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Engine updated successfully"
                    }
                  }
                }
              }
            }
          }
        },
        "tags": ["Engines"]
      }
    },
    "/engines/{name}/default": {
      "get": {
        "summary": "Get default engine variant",
        "description": "Retrieves the default engine variant for the specified engine type.",
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "enum": ["llama-cpp", "onnxruntime", "tensorrt-llm"],
              "default": "llama-cpp"
            },
            "description": "The type of engine"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "engine": {
                      "type": "string",
                      "example": "llama-cpp"
                    },
                    "name": {
                      "type": "string",
                      "example": "mac-arm64"
                    },
                    "version": {
                      "type": "string",
                      "example": "0.1.35-28.10.24"
                    }
                  }
                }
              }
            }
          }
        },
        "tags": ["Engines"]
      },
      "post": {
        "summary": "Set default engine variant",
        "description": "Sets the default engine variant for the specified engine type.",
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "enum": ["llama-cpp", "onnxruntime", "tensorrt-llm"],
              "default": "llama-cpp"
            },
            "description": "The type of engine"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": ["version", "variant"],
                "properties": {
                  "version": {
                    "type": "string",
                    "description": "The version of the engine variant",
                    "example": "0.1.34"
                  },
                  "variant": {
                    "type": "string",
                    "description": "The variant of the engine",
                    "example": "mac-arm64"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Default engine variant set successfully"
                    }
                  }
                }
              }
            }
          }
        },
        "tags": ["Engines"]
      }
    },
    "/engines/{name}/load": {
      "post": {
        "summary": "Load engine",
        "description": "Loads the specified engine type.",
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "llama-cpp",
                "onnxruntime",
                "tensorrt-llm",
                "openai",
                "anthropic"
              ],
              "default": "llama-cpp"
            },
            "description": "The name of the engine to update"
          }
        ],
        "responses": {
          "200": {
            "description": "Engine loaded successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Engine loaded successfully"
                    }
                  }
                }
              }
            }
          }
        },
        "tags": ["Engines"]
      },
      "delete": {
        "summary": "Unload engine",
        "description": "Unloads the specified engine type.",
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "enum": ["llama-cpp", "onnxruntime", "tensorrt-llm"],
              "default": "llama-cpp"
            },
            "description": "The name of the engine to update"
          }
        ],
        "responses": {
          "200": {
            "description": "Engine unloaded successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Engine unloaded successfully"
                    }
                  }
                }
              }
            }
          }
        },
        "tags": ["Engines"]
      }
    },
    "/hardware": {
      "get": {
        "summary": "Get hardware information",
        "description": "Retrieves detailed information about the system's hardware configuration, including CPU, GPU(s), operating system, power status, RAM, and storage.",
        "responses": {
          "200": {
            "description": "Hardware information retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "cpu": {
                      "$ref": "#/components/schemas/CPUDto"
                    },
                    "gpus": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/GPUDto"
                      }
                    },
                    "os": {
                      "$ref": "#/components/schemas/OperatingSystemDto"
                    },
                    "power": {
                      "$ref": "#/components/schemas/PowerDto"
                    },
                    "ram": {
                      "$ref": "#/components/schemas/RAMDto"
                    },
                    "storage": {
                      "$ref": "#/components/schemas/StorageDto"
                    }
                  }
                }
              }
            }
          }
        },
        "tags": ["Hardware"]
      }
    },
    "/hardware/activate": {
      "post": {
        "summary": "Activate GPUs",
        "description": "Activates the specified GPUs based on their indices provided in the request body.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "gpus": {
                    "type": "array",
                    "items": {
                      "type": "integer"
                    },
                    "example": [0, 1, 2],
                    "description": "An array of GPU indices to activate."
                  }
                },
                "required": ["gpus"]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The hardware configuration has been activated.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "The hardware configuration has been activated.",
                      "description": "Confirmation message indicating successful activation."
                    },
                    "activated_gpus": {
                      "type": "array",
                      "items": {
                        "type": "integer"
                      },
                      "example": [0, 1, 2],
                      "description": "List of GPU indices that were activated."
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Invalid GPU index provided",
                      "description": "Error message indicating what went wrong."
                    }
                  }
                }
              }
            }
          }
        },
        "tags": ["Hardware"]
      }
    },
    "/files": {
      "post": {
        "summary": "Upload a File",
        "description": "Uploads a file to the Cortex server.",
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary"
                  },
                  "purpose": {
                    "type": "string",
                    "enum": ["assistants"],
                    "description": "The intended purpose of the uploaded file"
                  }
                },
                "required": ["file", "purpose"]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "bytes": {
                      "type": "integer",
                      "example": 3211109
                    },
                    "created_at": {
                      "type": "integer",
                      "example": 1733942093
                    },
                    "filename": {
                      "type": "string",
                      "example": "Enterprise_Application_Infrastructure_v2_20140903_toCTC_v1.0.pdf"
                    },
                    "id": {
                      "type": "string",
                      "example": "file-0001KNKPTDDAQSDVEQGRBTCTNJ"
                    },
                    "object": {
                      "type": "string",
                      "example": "file"
                    },
                    "purpose": {
                      "type": "string",
                      "example": "assistants"
                    }
                  }
                }
              }
            }
          }
        },
        "tags": ["Files"]
      },
      "get": {
        "summary": "List files",
        "description": "Lists all the files in the current directory.",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "bytes": {
                            "type": "integer",
                            "example": 3211109
                          },
                          "created_at": {
                            "type": "integer",
                            "example": 1733942093
                          },
                          "filename": {
                            "type": "string",
                            "example": "Enterprise_Application_Infrastructure_v2_20140903_toCTC_v1.0.pdf"
                          },
                          "id": {
                            "type": "string",
                            "example": "file-0001KNKPTDDAQSDVEQGRBTCTNJ"
                          },
                          "object": {
                            "type": "string",
                            "example": "file"
                          },
                          "purpose": {
                            "type": "string",
                            "example": "assistants"
                          }
                        }
                      }
                    },
                    "object": {
                      "type": "string",
                      "example": "list"
                    }
                  }
                }
              }
            }
          }
        },
        "tags": ["Files"]
      }
    },
    "/files/{id}": {
      "get": {
        "summary": "Retrieve File",
        "description": "Retrieves a file by its ID.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "The ID of the file to retrieve",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "thread",
            "in": "query",
            "required": false,
            "description": "Optional thread identifier",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully retrieved file",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "bytes": {
                      "type": "integer",
                      "example": 3211109
                    },
                    "created_at": {
                      "type": "integer",
                      "example": 1733942093
                    },
                    "filename": {
                      "type": "string",
                      "example": "Enterprise_Application_Infrastructure_v2_20140903_toCTC_v1.0.pdf"
                    },
                    "id": {
                      "type": "string",
                      "example": "file-0001KNKPTDDAQSDVEQGRBTCTNJ"
                    },
                    "object": {
                      "type": "string",
                      "example": "file"
                    },
                    "purpose": {
                      "type": "string",
                      "example": "assistants"
                    }
                  }
                }
              }
            }
          }
        },
        "tags": ["Files"]
      },
      "delete": {
        "summary": "Delete File",
        "description": "Deletes a file by its ID.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "The ID of the file to delete",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "File successfully deleted",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "deleted": {
                      "type": "boolean",
                      "description": "Indicates if the file was successfully deleted"
                    },
                    "id": {
                      "type": "string",
                      "description": "The ID of the deleted file"
                    },
                    "object": {
                      "type": "string",
                      "description": "Type of object, always 'file'"
                    }
                  },
                  "required": ["deleted", "id", "object"]
                },
                "example": {
                  "deleted": true,
                  "id": "file-0001KNP26FC62D620DGYNG2R8H",
                  "object": "file"
                }
              }
            }
          },
          "400": {
            "description": "File not found or invalid request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message describing the issue"
                    }
                  },
                  "required": ["message"]
                },
                "example": {
                  "message": "File not found: file-0001KNP26FC62D620DGYNG2R8H"
                }
              }
            }
          }
        },
        "tags": ["Files"]
      }
    },
    "/files/{id}/content": {
      "get": {
        "summary": "Get File Content",
        "description": "Retrieves the content of a file by its ID.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "The ID of the file to retrieve content from",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "thread",
            "in": "query",
            "required": false,
            "description": "Optional thread identifier",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "File content retrieved successfully",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string",
                  "format": "binary",
                  "description": "The raw content of the file"
                }
              }
            }
          },
          "400": {
            "description": "File not found or invalid request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message describing the issue"
                    }
                  },
                  "required": ["message"]
                }
              }
            }
          }
        },
        "tags": ["Files"]
      }
    }
  },
  "info": {
    "title": "Cortex API",
    "description": "Cortex API enables API commands for seamless interaction with LLMs.",
    "version": "1.0",
    "contact": {}
  },
  "tags": [
    {
      "name": "Chat",
      "description": "This endpoint initiates interaction with a Large Language Models (LLM)."
    },
    {
      "name": "Embeddings",
      "description": "This endpoint create embeddings for a given input text or tokens."
    },
    {
      "name": "Assistants",
      "description": "These endpoints manage the lifecycle of an Assistant within a conversation thread."
    },
    {
      "name": "Pulling Models",
      "description": "These endpoints handle downloading and importing models."
    },
    {
      "name": "Running Models",
      "description": "These endpoints support a range of operations that allow users to effectively control and interact with their models"
    },
    {
      "name": "Server",
      "description": "These endpoints manage the lifecycle of Server, including heath check and shutdown."
    },
    {
      "name": "Configurations",
      "description": "These endpoints manage the configuration of the Cortex server."
    },
    {
      "name": "Messages",
      "description": "These endpoints manage the retrieval and storage of conversation content, including responses from LLMs and other metadata related to chat interactions."
    },
    {
      "name": "Threads",
      "description": "These endpoints handle the creation, retrieval, updating, and deletion of conversation threads."
    },
    {
      "name": "Engines",
      "description": "Endpoints for managing the available engines within Cortex."
    },
    {
      "name": "Files",
      "description": "Endpoints for managing the files within Cortex."
    },
    {
      "name": "Hardware",
      "description": "Endpoints for managing the available hardware within Cortex."
    },
    {
      "name": "System",
      "description": "Endpoints for stopping the Cortex API server, checking its status, and fetching system events."
    }
  ],
  "x-tagGroups": [
    {
      "name": "CORTEX",
      "tags": [
        "Chat",
        "Embeddings",
        "Engines",
        "Files",
        "Hardware",
        "Events",
        "Assistants",
        "Threads",
        "Messages",
        "Pulling Models",
        "Running Models",
        "Processes",
        "Status",
        "Server",
        "Configurations"
      ]
    }
  ],
  "servers": [
    {
      "url": "/v1"
    }
  ],
  "components": {
    "schemas": {
      "CreateAssistantDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier of the assistant.",
            "example": "jan",
            "default": "jan"
          },
          "avatar": {
            "type": "string",
            "description": "The avatar of the assistant.",
            "example": "",
            "default": ""
          },
          "name": {
            "type": "string",
            "description": "The name of the assistant.",
            "example": "Jan",
            "default": "Jan"
          },
          "description": {
            "type": "string",
            "description": "The description of the assistant.",
            "example": "A default assistant that can use all downloaded models",
            "default": "A default assistant that can use all downloaded models"
          },
          "model": {
            "type": "string",
            "description": "The model of the assistant."
          },
          "instructions": {
            "type": "string",
            "description": "The instructions for the assistant.",
            "example": "",
            "default": ""
          },
          "tools": {
            "description": "The tools associated with the assistant.",
            "example": [],
            "default": [],
            "type": "array",
            "items": {
              "type": "array",
              "properties": {
                "type": {
                  "type": "string",
                  "enum": ["function"]
                },
                "function": {
                  "$ref": "#/components/schemas/Function"
                }
              },
              "required": ["type", "function"]
            }
          },
          "metadata": {
            "type": "object",
            "nullable": true,
            "description": "The metadata of the assistant."
          },
          "top_p": {
            "type": "number",
            "description": "Top p.",
            "example": "0.7",
            "default": "0.7"
          },
          "temperature": {
            "type": "number",
            "description": "Temperature.",
            "example": "0.7",
            "default": "0.7"
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "model",
          "instructions",
          "tools",
          "metadata"
        ]
      },
      "AssistantEntity": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "avatar": {
            "type": "string"
          },
          "object": {
            "type": "string"
          },
          "created_at": {
            "type": "number"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "model": {
            "type": "string"
          },
          "instructions": {
            "type": "string",
            "nullable": true
          },
          "tools": {
            "type": "array"
          },
          "metadata": {
            "type": "object",
            "nullable": true
          },
          "top_p": {
            "type": "number",
            "nullable": true
          },
          "temperature": {
            "type": "number",
            "nullable": true
          },
          "response_format": {
            "type": "object",
            "nullable": true
          },
          "tool_resources": {
            "type": "object",
            "nullable": true
          }
        },
        "required": [
          "id",
          "object",
          "created_at",
          "name",
          "description",
          "model",
          "instructions",
          "tools",
          "metadata",
          "top_p",
          "temperature",
          "response_format",
          "tool_resources"
        ]
      },
      "DeleteAssistantResponseDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "assistant_123",
            "description": "The identifier of the assistant that was deleted."
          },
          "object": {
            "type": "string",
            "example": "assistant",
            "description": "Type of the object, indicating it's a assistant.",
            "default": "assistant"
          },
          "deleted": {
            "type": "boolean",
            "example": true,
            "description": "Indicates whether the assistant was successfully deleted."
          }
        },
        "required": ["id", "object", "deleted"]
      },
      "Message": {
        "type": "object",
        "discriminator": {
          "propertyName": "role",
          "mapping": {
            "system": "SystemMessage",
            "user": "UserMessage",
            "assistant": "AssistantMessage",
            "tool": "ToolMessage",
            "function": "FunctionMessage"
          }
        },
        "properties": {
          "role": {
            "type": "string",
            "enum": ["system", "user", "assistant", "tool"]
          },
          "name": {
            "type": "string",
            "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
          }
        },
        "required": ["role"]
      },
      "SystemMessage": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "role": {
                "type": "string",
                "description": "The role of the messages author, in this case `system`."
              },
              "content": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/TextContentPart"
                    }
                  }
                ]
              },
              "name": {
                "type": "string",
                "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
              }
            },
            "required": ["content", "role"]
          }
        ]
      },
      "UserMessage": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "role": {
                "type": "string",
                "description": "The role of the messages author, in this case `user`."
              },
              "content": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "anyOf": [
                        {
                          "type": "object",
                          "title": "Text Content Part",
                          "description": "Text Content",
                          "$ref": "#/components/schemas/TextContentPart"
                        },
                        {
                          "type": "object",
                          "title": "Image Content Part",
                          "description": "Image Content",
                          "$ref": "#/components/schemas/ImageContentPart"
                        },
                        {
                          "type": "object",
                          "title": "Audio Content Part",
                          "description": "Audio Content",
                          "$ref": "#/components/schemas/AudioContentPart"
                        }
                      ]
                    }
                  }
                ]
              },
              "name": {
                "type": "string",
                "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
              }
            },
            "required": ["content", "role"]
          }
        ]
      },
      "AssistantMessage": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "role": {
                "type": "string",
                "description": "The role of the messages author, in this case `assistant`."
              },
              "content": {
                "description": "The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.",
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "anyOf": [
                        {
                          "$ref": "#/components/schemas/TextContentPart"
                        },
                        {
                          "$ref": "#/components/schemas/RefusalContentPart"
                        }
                      ]
                    }
                  }
                ]
              },
              "name": {
                "type": "string",
                "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
              },
              "refusal": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "audio": {
                "type": "object",
                "anyOf": [
                  {
                    "$ref": "#/components/schemas/Audio"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "tool_calls": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ToolCall"
                }
              },
              "function_call": {
                "deprecated": true,
                "anyOf": [
                  {
                    "$ref": "#/components/schemas/FunctionCall"
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            }
          }
        ]
      },
      "ToolMessage": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "role": {
                "type": "string",
                "description": "The role of the messages author, in this case `tool`."
              },
              "content": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "anyOf": [
                        {
                          "$ref": "#/components/schemas/TextContentPart"
                        }
                      ]
                    }
                  }
                ]
              },
              "tool_call_id": {
                "type": "string"
              }
            },
            "required": ["content", "tool_call_id"]
          }
        ]
      },
      "FunctionMessage": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Message"
          }
        ],
        "deprecated": true
      },
      "TextContentPart": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": ["text"]
          },
          "text": {
            "type": "string"
          }
        },
        "required": ["type", "text"]
      },
      "ImageContentPart": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": ["image_url"]
          },
          "image_url": {
            "$ref": "#/components/schemas/ImageUrl"
          }
        },
        "required": ["type", "image_url"]
      },
      "AudioContentPart": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of the content part. Always `input_audio`."
          },
          "input_audio": {
            "$ref": "#/components/schemas/InputAudio"
          }
        },
        "required": ["type", "input_audio"]
      },
      "RefusalContentPart": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "refusal": {
            "type": "string"
          }
        },
        "required": ["type", "refusal"]
      },
      "ImageUrl": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "description": "Either a URL of the image or the base64 encoded image data."
          },
          "detail": {
            "type": "string",
            "default": "auto",
            "description": "Specifies the detail level of the image. Defaults to `auto`."
          }
        },
        "required": ["url"]
      },
      "InputAudio": {
        "type": "object",
        "properties": {
          "data": {
            "type": "string",
            "description": "Base64 encoded audio data."
          },
          "format": {
            "type": "string",
            "enum": ["wav", "mp3"],
            "description": "The format of the encoded audio data. Currently supports `wav` and `mp3`."
          }
        },
        "required": ["data", "format"]
      },
      "Audio": {
        "type": "object",
        "description": "Data about a previous audio response from the model.",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for a previous audio response from the model."
          }
        },
        "required": ["id"]
      },
      "ToolCall": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "function": {
            "$ref": "#/components/schemas/FunctionCall"
          }
        },
        "required": ["id", "type", "function"]
      },
      "FunctionCall": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "arguments": {
            "type": "string"
          }
        },
        "required": ["name", "arguments"]
      },
      "CreateChatCompletionDto": {
        "type": "object",
        "properties": {
          "messages": {
            "description": "Array of chat messages to be used for generating the chat completion. Depending on the model you use, different message types (modalities) are supported, like text, images, and audio. Currently, cortex only support text modalities.",
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "title": "System Message",
                  "description": "System Message",
                  "$ref": "#/components/schemas/SystemMessage"
                },
                {
                  "title": "User Message",
                  "description": "User Message",
                  "$ref": "#/components/schemas/UserMessage"
                },
                {
                  "title": "Assistant Message",
                  "description": "Assistant Message",
                  "$ref": "#/components/schemas/AssistantMessage"
                },
                {
                  "title": "Tool Message",
                  "description": "Tool Message",
                  "$ref": "#/components/schemas/ToolMessage"
                }
              ]
            }
          },
          "model": {
            "type": "string",
            "description": "The unique identifier of the model.",
            "example": "mistral"
          },
          "stream": {
            "type": "boolean",
            "description": "Determines the format for output generation. If set to `true`, the output is generated continuously, allowing for real-time streaming of responses. If set to `false`, the output is delivered in a single JSON file.",
            "example": true
          },
          "max_tokens": {
            "type": "number",
            "description": "Sets the upper limit on the number of tokens the model can generate in a single output. This value is now deprecated in favor of `max_completion_tokens`.",
            "example": 4096
          },
          "max_completion_tokens": {
            "type": "number",
            "description": "Sets the upper limit on the number of tokens the model can generate in a single output."
          },
          "stop": {
            "description": "Defines specific tokens or phrases that signal the model to stop producing further output.",
            "example": ["End"],
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "frequency_penalty": {
            "type": "number",
            "description": "Modifies the likelihood of the model repeating the same words or phrases within a single output.",
            "example": 0.2
          },
          "presence_penalty": {
            "type": "number",
            "description": "Reduces the likelihood of repeating tokens, promoting novelty in the output.",
            "example": 0.6
          },
          "temperature": {
            "type": "number",
            "description": "Influences the randomness of the model's output.",
            "example": 0.8
          },
          "top_p": {
            "type": "number",
            "description": "Sets probability threshold for more relevant outputs.",
            "example": 0.95
          },
          "modalities": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": ["text", "audio"]
            },
            "description": "Specifies the modalities (types of input) supported by the model. Currently, cortex only support text modalities. We are actively working on this feature to bring cortex as fully OpenAI compatible platform. Planning and roadmap for this feature can be found [**here**](https://github.com/menloresearch/cortex.cpp/issues/1582).",
            "example": ["text"]
          },
          "audio": {
            "description": "Parameters for audio output. Required when audio output is requested with `modalities: ['audio']`. We are actively working on this feature to bring cortex as fully OpenAI compatible platform. Planning and roadmap for this feature can be found [**here**](https://github.com/menloresearch/cortex.cpp/issues/1582).",
            "type": "object",
            "properties": {
              "voice": {
                "type": "string",
                "description": "The voice of the generated audio."
              },
              "format": {
                "type": "string",
                "description": "Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`, `opus`, or `pcm16`.",
                "enum": ["mp3", "wav", "flac", "opus", "pcm16"]
              }
            },
            "required": ["voice", "format"]
          },
          "store": {
            "type": "boolean",
            "description": "Whether or not to store the output of this chat completion request for use in our model distillation or evals products. We are actively working on this feature to bring cortex as fully OpenAI compatible platform. Planning and roadmap for this feature can be found [**here**](https://github.com/menloresearch/cortex.cpp/issues/1582).",
            "default": false,
            "example": false
          },
          "metadata": {
            "type": "object",
            "description": "Developer-defined tags and values used for filtering completions in the dashboard. We are actively working on this feature to bring cortex as fully OpenAI compatible platform. Planning and roadmap for this feature can be found [**here**](https://github.com/menloresearch/cortex.cpp/issues/1582).",
            "example": {
              "type": "conversation"
            }
          },
          "logit_bias": {
            "type": "object",
            "description": "Modify the likelihood of specified tokens appearing in the completion. \n\nAccepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.",
            "example": {
              "15496": -100,
              "51561": -100
            },
            "default": null
          },
          "logprobs": {
            "type": "boolean",
            "description": "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.",
            "example": false,
            "default": false
          },
          "top_logprobs": {
            "type": "number",
            "description": "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used."
          },
          "n": {
            "type": "number",
            "description": "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs.",
            "example": 1,
            "default": 1
          },
          "response_format": {
            "type": "object",
            "description": "An object specifying the format that the model must output. Setting to { \"type\": \"json_object\" } enables JSON mode, which guarantees the message the model generates is valid JSON. We are actively working on this feature to bring cortex as fully OpenAI compatible platform. Planning and roadmap for this feature can be found [**here**](https://github.com/menloresearch/cortex.cpp/issues/1582).",
            "properties": {
              "type": {
                "type": "string",
                "description": "The format of the generated output. Must be one of `text`, `json_schema` or `json_object`.",
                "enum": ["text", "json_object", "json_schema"]
              }
            },
            "required": ["type"]
          },
          "seed": {
            "type": "number",
            "description": "This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend.",
            "example": 123,
            "default": null
          },
          "service_tier": {
            "type": "string",
            "description": "Specifies the latency tier to use for processing the request. This parameter is relevant for customers subscribed to the scale tier service:\n\n - If set to 'auto', and the Project is Scale tier enabled, the system will utilize scale tier credits until they are exhausted.\n- If set to 'auto', and the Project is not Scale tier enabled, the request will be processed using the default service tier with a lower uptime SLA and no latency guarentee.\n- If set to 'default', the request will be processed using the default service tier with a lower uptime SLA and no latency guarentee.\nWhen not set, the default behavior is 'auto'.\nWhen this parameter is set, the response body will include the service_tier utilized.\n\n We are actively working on this feature to bring cortex as fully OpenAI compatible platform. Planning and roadmap for this feature can be found [**here**](https://github.com/menloresearch/cortex.cpp/issues/1582)."
          },
          "stream_options": {
            "type": "object",
            "default": null,
            "description": "Options for streaming response. Only set this when you set `stream: true`.",
            "properties": {
              "include_usage": {
                "type": "boolean",
                "description": "If set, an additional chunk will be streamed before the data: `[DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array. All other chunks will also include a `usage` field, but with a null value.",
                "example": false,
                "default": false
              }
            }
          },
          "tools": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "enum": ["function"]
                },
                "function": {
                  "$ref": "#/components/schemas/Function"
                }
              },
              "required": ["type", "function"]
            }
          },
          "tool_choice": {
            "anyOf": [
              {
                "type": "string",
                "enum": ["none", "auto", "required"]
              },
              {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": ["function"]
                  },
                  "function": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string"
                      }
                    },
                    "required": ["name"]
                  }
                },
                "required": ["type", "function"]
              }
            ]
          },
          "parallel_tool_calls": {
            "type": "boolean",
            "description": "Whether to enable parallel function calling during tool use. Cortex support parallel tool calls by default",
            "example": true,
            "default": true
          },
          "user": {
            "type": "string",
            "description": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. We are actively working on this feature to bring cortex as fully OpenAI compatible platform. Planning and roadmap for this feature can be found [**here**](https://github.com/menloresearch/cortex.cpp/issues/1582)."
          },
          "dynatemp_range": {
            "type": "number",
            "description": "Dynamic temperature range. This parameter only supported by `llama-cpp` engine."
          },
          "dynatemp_exponent": {
            "type": "number",
            "description": "Dynamic temperature exponent. This parameter only supported by `llama-cpp` engine."
          },
          "top_k": {
            "type": "integer",
            "description": "The number of most likely tokens to consider at each step. This parameter only supported by `llama-cpp` engine."
          },
          "min_p": {
            "type": "number",
            "description": "Minimum probability threshold for token sampling. This parameter only supported by `llama-cpp` engine."
          },
          "tfs_z": {
            "type": "number",
            "description": "The z-score used for Typical token sampling. This parameter only supported by `llama-cpp` engine."
          },
          "typ_p": {
            "type": "number",
            "description": "The cumulative probability threshold used for Typical token sampling. This parameter only supported by `llama-cpp` engine."
          },
          "repeat_last_n": {
            "type": "integer",
            "description": "Number of previous tokens to penalize for repeating. This parameter only supported by `llama-cpp` engine."
          },
          "repeat_penalty": {
            "type": "number",
            "description": "Penalty for repeating tokens. This parameter only supported by `llama-cpp` engine."
          },
          "mirostat": {
            "type": "boolean",
            "description": "Enables or disables Mirostat sampling (true or false). This parameter only supported by `llama-cpp` engine."
          },
          "mirostat_tau": {
            "type": "number",
            "description": "Target entropy value for Mirostat sampling. This parameter only supported by `llama-cpp` engine."
          },
          "mirostat_eta": {
            "type": "number",
            "description": "Learning rate for Mirostat sampling. This parameter only supported by `llama-cpp` engine."
          },
          "penalize_nl": {
            "type": "boolean",
            "description": "Penalizes newline tokens (true or false). This parameter only supported by `llama-cpp` engine."
          },
          "ignore_eos": {
            "type": "boolean",
            "description": "Ignores the end-of-sequence token (true or false). This parameter only supported by `llama-cpp` engine."
          },
          "n_probs": {
            "type": "integer",
            "description": "Number of probabilities to return. This parameter only supported by `llama-cpp` engine."
          },
          "min_keep": {
            "type": "integer",
            "description": "Minimum number of tokens to keep. This parameter only supported by `llama-cpp` engine."
          }
        },
        "required": ["messages", "model"]
      },
      "Function": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string"
          },
          "name": {
            "type": "string",
            "pattern": "^[a-zA-Z0-9_-]{1,64}$"
          },
          "parameters": {
            "type": "object"
          },
          "strict": {
            "type": "boolean",
            "default": false
          }
        },
        "required": ["name"]
      },
      "MessageDto": {
        "type": "object",
        "properties": {
          "content": {
            "type": "string",
            "description": "The textual content of the chat message or completion generated by the model."
          },
          "role": {
            "type": "string",
            "description": "The role of the participant in the chat, such as 'user' or 'system', indicating who is the sender of the message."
          }
        },
        "required": ["content", "role"]
      },
      "ChoiceDto": {
        "type": "object",
        "properties": {
          "finish_reason": {
            "type": "string",
            "description": "The reason the chat completion ended, typically indicating whether the model completed the text naturally or was cut off."
          },
          "index": {
            "type": "number",
            "description": "The index of the completion relative to other generated completions, useful for identifying its order in a batch request."
          },
          "message": {
            "description": "An object representing the message details involved in the chat completion, encapsulated within a MessageDto.",
            "allOf": [
              {
                "$ref": "#/components/schemas/MessageDto"
              }
            ]
          }
        },
        "required": ["finish_reason", "index", "message"]
      },
      "UsageDto": {
        "type": "object",
        "properties": {
          "completion_tokens": {
            "type": "number",
            "description": "The number of tokens used in the completion part of the response generated by the model."
          },
          "prompt_tokens": {
            "type": "number",
            "description": "The number of tokens used in the prompt part of the chat input, which is provided to the model."
          },
          "total_tokens": {
            "type": "number",
            "description": "The total number of tokens used in both the prompt and the completion, summarizing the entire token count of the chat operation."
          }
        },
        "required": ["completion_tokens", "prompt_tokens", "total_tokens"]
      },
      "ChatCompletionResponseDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "A unique identifier for the chat completion."
          },
          "choices": {
            "type": "array",
            "description": "A list of chat completion choices. Can be more than one if n is greater than 1.",
            "items": {
              "type": "object",
              "properties": {
                "finish_reason": {
                  "type": "string",
                  "description": "The reason the model stopped generating tokens. This will be stop if the model hit a natural stop point or a provided stop sequence, length if the maximum number of tokens specified in the request was reached, content_filter if content was omitted due to a flag from our content filters, tool_calls if the model called a tool, or function_call (deprecated) if the model called a function."
                },
                "index": {
                  "type": "integer",
                  "description": "The index of the choice in the list of choices."
                },
                "message": {
                  "type": "object",
                  "properties": {
                    "content": {
                      "type": ["string", "null"],
                      "description": "The contents of the message."
                    },
                    "refusal": {
                      "type": ["string", "null"],
                      "description": "The refusal message generated by the model."
                    },
                    "tool_calls": {
                      "type": "array",
                      "description": "The tool calls generated by the model, such as function calls.",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "The ID of the tool call."
                          },
                          "type": {
                            "type": "string",
                            "description": "The type of the tool. Currently, only function is supported."
                          },
                          "function": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "string",
                                "description": "The name of the function to call."
                              },
                              "arguments": {
                                "type": "string",
                                "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."
                              }
                            },
                            "required": ["name", "arguments"]
                          }
                        },
                        "required": ["id", "type", "function"]
                      }
                    },
                    "role": {
                      "type": "string",
                      "description": "The role of the author of this message."
                    },
                    "function_call": {
                      "type": "object",
                      "deprecated": true,
                      "description": "Deprecated and replaced by tool_calls. The name and arguments of a function that should be called, as generated by the model.",
                      "properties": {
                        "arguments": {
                          "type": "string",
                          "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."
                        },
                        "name": {
                          "type": "string",
                          "description": "The name of the function to call."
                        }
                      },
                      "required": ["arguments", "name"]
                    },
                    "audio": {
                      "type": "object",
                      "description": "If the audio output modality is requested, this object contains data about the audio response from the model.",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Unique identifier for this audio response."
                        },
                        "expires_at": {
                          "type": "integer",
                          "description": "The Unix timestamp (in seconds) for when this audio response will no longer be accessible on the server for use in multi-turn conversations."
                        },
                        "data": {
                          "type": "string",
                          "description": "Base64 encoded audio bytes generated by the model, in the format specified in the request."
                        },
                        "transcript": {
                          "type": "string",
                          "description": "Transcript of the audio generated by the model."
                        }
                      },
                      "required": ["id", "expires_at", "data", "transcript"]
                    }
                  },
                  "required": ["role"]
                },
                "logprobs": {
                  "type": "object",
                  "description": "Log probability information for the choice.",
                  "properties": {
                    "content": {
                      "type": ["array", "null"],
                      "description": "A list of message content tokens with log probability information.",
                      "items": {
                        "type": "object",
                        "properties": {
                          "token": {
                            "type": "string",
                            "description": "The token."
                          },
                          "logprob": {
                            "type": "number",
                            "description": "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely."
                          },
                          "bytes": {
                            "type": ["array", "null"],
                            "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token."
                          }
                        },
                        "required": ["token", "logprob"]
                      }
                    },
                    "top_logprobs": {
                      "type": "array",
                      "description": "List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested top_logprobs returned.",
                      "items": {
                        "type": "object",
                        "properties": {
                          "token": {
                            "type": "string",
                            "description": "The token."
                          },
                          "logprob": {
                            "type": "number",
                            "description": "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely."
                          },
                          "bytes": {
                            "type": ["array", "null"],
                            "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token."
                          }
                        },
                        "required": ["token", "logprob"]
                      }
                    },
                    "refusal": {
                      "type": ["array", "null"],
                      "description": "A list of message refusal tokens with log probability information.",
                      "items": {
                        "type": "object",
                        "properties": {
                          "token": {
                            "type": "string",
                            "description": "The token."
                          },
                          "logprob": {
                            "type": "number",
                            "description": "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely."
                          },
                          "bytes": {
                            "type": ["array", "null"],
                            "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token."
                          }
                        },
                        "required": ["token", "logprob"]
                      }
                    }
                  }
                }
              },
              "required": ["finish_reason", "index", "message"]
            }
          },
          "created": {
            "type": "integer",
            "description": "The Unix timestamp (in seconds) of when the chat completion was created."
          },
          "model": {
            "type": "string",
            "description": "The model used for the chat completion."
          },
          "service_tier": {
            "type": ["string", "null"],
            "description": "The service tier used for processing the request. This field is only included if the service_tier parameter is specified in the request."
          },
          "system_fingerprint": {
            "type": "string",
            "description": "This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the seed request parameter to understand when backend changes have been made that might impact determinism."
          },
          "object": {
            "type": "string",
            "description": "The object type, which is always chat.completion."
          },
          "usage": {
            "type": "object",
            "description": "Usage statistics for the completion request.",
            "properties": {
              "completion_tokens": {
                "type": "integer",
                "description": "Number of tokens in the generated completion."
              },
              "prompt_tokens": {
                "type": "integer",
                "description": "Number of tokens in the prompt."
              },
              "total_tokens": {
                "type": "integer",
                "description": "Total number of tokens used in the request (prompt + completion)."
              },
              "completion_tokens_details": {
                "type": "object",
                "description": "Breakdown of tokens used in a completion.",
                "properties": {
                  "audio_tokens": {
                    "type": "integer",
                    "description": "Audio input tokens generated by the model."
                  },
                  "reasoning_tokens": {
                    "type": "integer",
                    "description": "Tokens generated by the model for reasoning."
                  }
                },
                "required": ["audio_tokens", "reasoning_tokens"]
              },
              "prompt_tokens_details": {
                "type": "object",
                "description": "Breakdown of tokens used in the prompt.",
                "properties": {
                  "audio_tokens": {
                    "type": "integer",
                    "description": "Audio input tokens present in the prompt."
                  },
                  "cached_tokens": {
                    "type": "integer",
                    "description": "Cached tokens present in the prompt."
                  }
                },
                "required": ["audio_tokens", "cached_tokens"]
              }
            },
            "required": [
              "completion_tokens",
              "prompt_tokens",
              "total_tokens",
              "completion_tokens_details",
              "prompt_tokens_details"
            ]
          }
        },
        "required": [
          "id",
          "choices",
          "created",
          "model",
          "system_fingerprint",
          "object",
          "usage"
        ]
      },
      "ChatCompletionChunkResponseDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "A unique identifier for the chat completion. Each chunk has the same ID."
          },
          "choices": {
            "type": "array",
            "description": "A list of chat completion choices. Can contain more than one element if n is greater than 1. Can also be empty for the last chunk if you set stream_options: {\"include_usage\": true}.",
            "items": {
              "type": "object",
              "properties": {
                "delta": {
                  "type": "object",
                  "description": "A chat completion delta generated by streamed model responses.",
                  "properties": {
                    "content": {
                      "type": ["string", "null"],
                      "description": "The contents of the chunk message."
                    },
                    "function_call": {
                      "type": "object",
                      "description": "Deprecated and replaced by tool_calls. The name and arguments of a function that should be called, as generated by the model.",
                      "deprecated": true
                    },
                    "tool_calls": {
                      "type": "array",
                      "description": "The tool calls generated by the model.",
                      "items": {
                        "type": "object",
                        "properties": {
                          "index": {
                            "type": "integer",
                            "description": "The index of the tool call in the list of tool calls."
                          },
                          "id": {
                            "type": "string",
                            "description": "The ID of the tool call."
                          },
                          "type": {
                            "type": "string",
                            "description": "The type of the tool. Currently, only function is supported."
                          },
                          "function": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "string",
                                "description": "The name of the function to call."
                              },
                              "arguments": {
                                "type": "string",
                                "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."
                              }
                            },
                            "required": ["name", "arguments"]
                          }
                        },
                        "required": ["index", "id", "type", "function"]
                      }
                    },
                    "role": {
                      "type": "string",
                      "description": "The role of the author of this message."
                    },
                    "refusal": {
                      "type": ["string", "null"],
                      "description": "The refusal message generated by the model."
                    }
                  }
                },
                "logprobs": {
                  "type": "object",
                  "description": "Log probability information for the choice.",
                  "properties": {
                    "content": {
                      "type": ["array", "null"],
                      "description": "A list of message content tokens with log probability information.",
                      "items": {
                        "type": "object",
                        "properties": {
                          "token": {
                            "type": "string",
                            "description": "The token."
                          },
                          "logprob": {
                            "type": "number",
                            "description": "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely."
                          },
                          "bytes": {
                            "type": ["array", "null"],
                            "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token."
                          }
                        },
                        "required": ["token", "logprob"]
                      }
                    },
                    "top_logprobs": {
                      "type": "array",
                      "description": "List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested top_logprobs returned.",
                      "items": {
                        "type": "object",
                        "properties": {
                          "token": {
                            "type": "string",
                            "description": "The token."
                          },
                          "logprob": {
                            "type": "number",
                            "description": "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely."
                          },
                          "bytes": {
                            "type": ["array", "null"],
                            "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token."
                          }
                        },
                        "required": ["token", "logprob"]
                      }
                    },
                    "refusal": {
                      "type": ["array", "null"],
                      "description": "A list of message refusal tokens with log probability information.",
                      "items": {
                        "type": "object",
                        "properties": {
                          "token": {
                            "type": "string",
                            "description": "The token."
                          },
                          "logprob": {
                            "type": "number",
                            "description": "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely."
                          },
                          "bytes": {
                            "type": ["array", "null"],
                            "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token."
                          }
                        },
                        "required": ["token", "logprob"]
                      }
                    }
                  }
                },
                "finish_reason": {
                  "type": ["string", "null"],
                  "description": "The reason the model stopped generating tokens. This will be stop if the model hit a natural stop point or a provided stop sequence, length if the maximum number of tokens specified in the request was reached, content_filter if content was omitted due to a flag from our content filters, tool_calls if the model called a tool, or function_call (deprecated) if the model called a function."
                },
                "index": {
                  "type": "integer",
                  "description": "The index of the choice in the list of choices."
                }
              },
              "required": ["delta", "index"]
            }
          },
          "created": {
            "type": "integer",
            "description": "The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp."
          },
          "model": {
            "type": "string",
            "description": "The model used to generate the completion."
          },
          "service_tier": {
            "type": ["string", "null"],
            "description": "The service tier used for processing the request. This field is only included if the service_tier parameter is specified in the request."
          },
          "system_fingerprint": {
            "type": "string",
            "description": "This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the seed request parameter to understand when backend changes have been made that might impact determinism."
          },
          "object": {
            "type": "string",
            "description": "The object type, which is always chat.completion.chunk."
          },
          "usage": {
            "type": "object",
            "description": "An optional field that will only be present when you set stream_options: {\"include_usage\": true} in your request. When present, it contains a null value except for the last chunk which contains the token usage statistics for the entire request.",
            "properties": {
              "completion_tokens": {
                "type": "integer",
                "description": "Number of tokens in the generated completion."
              },
              "prompt_tokens": {
                "type": "integer",
                "description": "Number of tokens in the prompt."
              },
              "total_tokens": {
                "type": "integer",
                "description": "Total number of tokens used in the request (prompt + completion)."
              }
            },
            "required": ["completion_tokens", "prompt_tokens", "total_tokens"]
          }
        },
        "required": [
          "id",
          "choices",
          "created",
          "model",
          "system_fingerprint",
          "object"
        ]
      },
      "CreateEmbeddingsDto": {
        "type": "object",
        "properties": {
          "model": {
            "type": "string",
            "example": "mistral",
            "description": "The name of the embedding model to be used."
          },
          "input": {
            "example": ["Hello World"],
            "description": "The text or token array(s) to be embedded. This can be a single string, an array of strings, or an array of token arrays to embed multiple inputs in one request.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "encoding_format": {
            "type": "string",
            "example": "float",
            "description": "Specifies the format for the embeddings. Supported formats include `float` and `int`. This field is optional."
          },
          "dimensions": {
            "type": "number",
            "example": 3,
            "description": "Defines the number of dimensions for the output embeddings. This feature is supported by certain models only. This field is optional."
          }
        },
        "required": ["model", "input"]
      },
      "EmbeddingsResponseDto": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "description": "Type of the result object."
          },
          "model": {
            "type": "string",
            "description": "Identifier of the model utilized for generating embeddings."
          },
          "embedding": {
            "description": "The embedding vector represented as an array of floating-point numbers. ",
            "type": "array",
            "items": {
              "type": "number"
            }
          },
          "usage": {
            "description": "Details of token usage, including prompt_tokens and total_tokens.",
            "allOf": [
              {
                "$ref": "#/components/schemas/UsageDto"
              }
            ]
          }
        },
        "required": ["object", "model", "embedding", "usage"]
      },
      "PullModelRequest": {
        "type": "object",
        "required": ["model"],
        "properties": {
          "model": {
            "type": "string",
            "description": "The identifier or URL of the model to use. It can be a model ID on Cortexso (https://huggingface.co/cortexso) or a HuggingFace URL pointing to the model file. For example: 'gpt2' or 'https://huggingface.co/TheBloke/Mistral-7B-Instruct-v0.1-GGUF/blob/main/mistral-7b-instruct-v0.1.Q2_K.gguf'",
            "examples": [
              "tinyllama:gguf",
              "https://huggingface.co/TheBloke/Mistral-7B-Instruct-v0.1-GGUF/blob/main/mistral-7b-instruct-v0.1.Q2_K.gguf"
            ]
          },
          "id": {
            "type": "string",
            "description": "The id which will be used to register the model.",
            "examples": "my-custom-model-id"
          },
          "name": {
            "type": "string",
            "description": "The name which will be used to overwrite the model name.",
            "examples": "my-custom-model-name"
          }
        }
      },
      "PullModelResponse": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "example": "Model start downloading!"
          }
        }
      },
      "AddModelRequest": {
        "type": "object",
        "required": [
          "model",
          "engine",
          "version",
          "inference_params",
          "transform_req",
          "transform_resp",
          "metadata"
        ],
        "properties": {
          "model": {
            "type": "string",
            "description": "The identifier of the model."
          },
          "header_template": {
            "type": "string",
            "description": "Template for the header."
          },
          "engine": {
            "type": "string",
            "description": "The engine used for the model."
          },
          "version": {
            "type": "string",
            "description": "The version of the model."
          },
          "inference_params": {
            "type": "object",
            "properties": {
              "temperature": {
                "type": "number"
              },
              "top_p": {
                "type": "number"
              },
              "frequency_penalty": {
                "type": "number"
              },
              "presence_penalty": {
                "type": "number"
              },
              "max_tokens": {
                "type": "integer"
              },
              "stream": {
                "type": "boolean"
              }
            }
          },
          "transform_req": {
            "type": "object",
            "properties": {
              "get_models": {
                "type": "object"
              },
              "chat_completions": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string"
                  },
                  "template": {
                    "type": "string"
                  }
                }
              },
              "embeddings": {
                "type": "object"
              }
            }
          },
          "transform_resp": {
            "type": "object",
            "properties": {
              "chat_completions": {
                "type": "object",
                "properties": {
                  "template": {
                    "type": "string"
                  }
                }
              },
              "embeddings": {
                "type": "object"
              }
            }
          },
          "metadata": {
            "type": "object",
            "properties": {
              "author": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "end_point": {
                "type": "string"
              },
              "logo": {
                "type": "string"
              },
              "api_key_url": {
                "type": "string"
              }
            }
          }
        }
      },
      "CreateModelDto": {
        "type": "object",
        "properties": {
          "model": {
            "type": "string",
            "description": "The unique identifier of the model.",
            "example": "mistral"
          },
          "name": {
            "type": "string",
            "description": "The name of the model.",
            "example": "mistral"
          },
          "files": {
            "description": "The URL sources from which the model downloaded or accessed.",
            "example": ["https://huggingface.co/cortexso/mistral/tree/gguf"],
            "oneOf": [
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              {
                "$ref": "#/components/schemas/ModelArtifactDto"
              }
            ]
          },
          "prompt_template": {
            "type": "string",
            "description": "A predefined text or framework that guides the AI model's response generation.",
            "example": "\n      You are an expert in {subject}. Provide a detailed and thorough explanation on the topic of {topic}."
          },
          "stop": {
            "description": "Defines specific tokens or phrases that signal the model to stop producing further output.",
            "example": ["End"],
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "max_tokens": {
            "type": "number",
            "description": "Sets the upper limit on the number of tokens the model can generate in a single output.",
            "example": 4096
          },
          "top_p": {
            "type": "number",
            "description": "Sets probability threshold for more relevant outputs.",
            "example": 0.9
          },
          "temperature": {
            "type": "number",
            "description": "Influences the randomness of the model's output.",
            "example": 0.7
          },
          "frequency_penalty": {
            "type": "number",
            "description": "Modifies the likelihood of the model repeating the same words or phrases within a single output.",
            "example": 0.5
          },
          "presence_penalty": {
            "type": "number",
            "description": "Reduces the likelihood of repeating tokens, promoting novelty in the output.",
            "example": 0.6
          },
          "stream": {
            "type": "boolean",
            "description": "Determines the format for output generation. If set to `true`, the output is generated continuously, allowing for real-time streaming of responses. If set to `false`, the output is delivered in a single JSON file.",
            "example": true
          },
          "ctx_len": {
            "type": "number",
            "description": "Sets the maximum input the model can use to generate a response, it varies with the model used.",
            "example": 4096
          },
          "ngl": {
            "type": "number",
            "description": "Determines GPU layer usage.",
            "example": 32
          },
          "n_parallel": {
            "type": "number",
            "minimum": 1,
            "description": "Number of parallel processing units to use.",
            "example": 1
          },
          "cpu_threads": {
            "type": "number",
            "minimum": 1,
            "description": "Determines CPU inference threads, limited by hardware and OS. ",
            "example": 10
          },
          "engine": {
            "type": "string",
            "description": "The engine used to run the model.",
            "example": "llamacpp"
          },
          "owned_by": {
            "type": "string",
            "description": "The owner of the model.",
            "example": "",
            "default": ""
          }
        },
        "required": ["model", "files"]
      },
      "StartModelSuccessDto": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "The success or error message displayed when a model is successfully loaded or fails to load."
          },
          "modelId": {
            "type": "string",
            "description": "The unique identifier of the model."
          }
        },
        "required": ["message", "modelId"]
      },
      "ModelStartDto": {
        "type": "object",
        "properties": {
          "model": {
            "type": "string",
            "example": "llama3:8b-gguf-q6-k",
            "description": "A downloaded model name."
          },
          "ctx_len": {
            "type": "number",
            "description": "The context length for model operations varies; the maximum depends on the specific model used.",
            "example": 4096
          },
          "ngl": {
            "type": "number",
            "description": "Determines GPU layer usage.",
            "example": 32
          },
          "n_parallel": {
            "type": "number",
            "minimum": 1,
            "description": "Number of parallel processing units to use.",
            "example": 1
          },
          "cache_type": {
            "type": "string",
            "description": "KV cache type: f16, q8_0, q4_0, default is f16",
            "example": "f16"
          },
          "caching_enabled": {
            "type": "boolean",
            "description": "To enable prompt caching or not",
            "example": true
          },
          "model_path": {
            "type": "string",
            "description": "Local path to LLM model file",
            "example": "/tmp/model.gguf"
          },
          "mmproj": {
            "type": "string",
            "description": "Local path to mmproj model file",
            "example": "/tmp/model.gguf"
          }
        },
        "required": ["model"]
      },
      "ModelStopDto": {
        "type": "object",
        "properties": {
          "model": {
            "type": "string",
            "example": "llama3:8b-gguf-q6-k",
            "description": "A downloaded model name."
          }
        },
        "required": ["model"]
      },
      "ImportModelRequest": {
        "type": "object",
        "properties": {
          "model": {
            "type": "string",
            "description": "The unique identifier of the model."
          },
          "modelPath": {
            "type": "string",
            "description": "The file path to the model."
          },
          "name": {
            "type": "string",
            "description": "The display name of the model."
          },
          "option": {
            "type": "string",
            "description": "Import options such as symlink or copy.",
            "enum": ["symlink", "copy"]
          }
        },
        "required": ["model", "modelPath"]
      },
      "ImportModelResponse": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "Success message."
          },
          "modelHandle": {
            "type": "string",
            "description": "The unique identifier of the imported model."
          },
          "result": {
            "type": "string",
            "description": "Result status.",
            "example": "OK"
          }
        },
        "required": ["message", "modelHandle", "result"]
      },
      "CommonResponseDto": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "The response success or error message."
          }
        },
        "required": ["message"]
      },
      "EngineUninstallationResponseDto": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "example": "Engine my_engine uninstalled successfully!",
            "enum": [
              "Engine onnxruntime uninstalled successfully!",
              "Engine llama-cpp uninstalled successfully!",
              "Engine tensorrt-llm uninstalled successfully!"
            ]
          }
        }
      },
      "SimpleErrorResponse": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          }
        }
      },
      "EngineInstallationResponseDto": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "example": "Engine my_engine installed successfully!",
            "enum": [
              "Engine onnxruntime installed successfully!",
              "Engine llama-cpp installed successfully!",
              "Engine tensorrt-llm installed successfully!"
            ]
          }
        }
      },
      "EngineList": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Engine"
            }
          },
          "object": {
            "type": "string",
            "example": "list"
          },
          "result": {
            "type": "string",
            "example": "OK"
          }
        },
        "required": ["data", "object", "result"]
      },
      "Engine": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "example": "This extension enables chat completion API calls using the Onnx engine"
          },
          "name": {
            "type": "string",
            "example": "onnxruntime"
          },
          "productName": {
            "type": "string",
            "example": "onnxruntime"
          },
          "status": {
            "type": "string",
            "example": "Incompatible"
          },
          "variant": {
            "type": "string",
            "example": "mac-arm64"
          },
          "version": {
            "type": "string",
            "example": "0.1.34"
          }
        },
        "required": ["description", "name", "productName", "status"]
      },
      "CpuModeDto": {
        "type": "object",
        "properties": {
          "ram": {
            "type": "number",
            "example": 1024
          }
        }
      },
      "GpuModeDto": {
        "type": "object",
        "properties": {
          "ram": {
            "type": "number",
            "example": 1024
          },
          "vram": {
            "type": "number",
            "example": 1024
          },
          "ngl": {
            "type": "number",
            "example": 30
          },
          "context_length": {
            "type": "number",
            "example": 4096
          },
          "recommend_ngl": {
            "type": "number",
            "example": 33
          }
        }
      },
      "RecommendDto": {
        "type": "object",
        "properties": {
          "cpu_mode": {
            "type": "object",
            "$ref": "#/components/schemas/CpuModeDto"
          },
          "gpu_mode": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GPUDto"
            }
          }
        }
      },
      "ModelDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "mistral",
            "description": "The model identifier, which can be referenced in the API endpoints."
          },
          "prompt_template": {
            "type": "string",
            "example": "You are an expert in {subject}. Provide a detailed and thorough explanation on the topic of {topic}.",
            "description": "A predefined text or framework that guides the AI model's response generation."
          },
          "stop": {
            "example": ["End"],
            "description": "Defines specific tokens or phrases that signal the model to stop producing further output.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "max_tokens": {
            "type": "number",
            "example": 4096,
            "description": "Sets the upper limit on the number of tokens the model can generate in a single output."
          },
          "temperature": {
            "type": "number",
            "example": 0.7,
            "description": "Influences the randomness of the model's output."
          },
          "top_p": {
            "type": "number",
            "example": 0.95,
            "description": "Sets probability threshold for more relevant outputs"
          },
          "stream": {
            "type": "boolean",
            "example": true,
            "description": "Determines the format for output generation. If set to `true`, the output is generated continuously, allowing for real-time streaming of responses. If set to `false`, the output is delivered in a single JSON file."
          },
          "frequency_penalty": {
            "type": "number",
            "example": 0,
            "description": "Modifies the likelihood of the model repeating the same words or phrases within a single output."
          },
          "presence_penalty": {
            "type": "number",
            "example": 0,
            "description": "Reduces the likelihood of repeating tokens, promoting novelty in the output."
          },
          "ngl": {
            "type": "number",
            "description": "Determines GPU layer usage.",
            "example": 32
          },
          "ctx_len": {
            "type": "number",
            "description": "The context length for model operations varies; the maximum depends on the specific model used.",
            "example": 4096
          },
          "cpu_threads": {
            "type": "number",
            "description": "Determines CPU inference threads, limited by hardware and OS.",
            "example": 10
          },
          "pre_prompt": {
            "type": "string",
            "description": "The prompt to use for internal configuration",
            "example": "You are an assistant with expert knowledge in {subject}. Please provide a detailed and accurate response to the following query: {query}. Ensure that your response is clear, concise, and informative."
          },
          "n_batch": {
            "type": "number",
            "description": "The batch size for prompt eval step",
            "example": 512
          },
          "caching_enabled": {
            "type": "boolean",
            "description": "To enable prompt caching or not",
            "example": true
          },
          "grp_attn_n": {
            "type": "number",
            "description": "Group attention factor in self-extend",
            "example": 1
          },
          "grp_attn_w": {
            "type": "number",
            "description": "Group attention width in self-extend",
            "example": 512
          },
          "mlock": {
            "type": "boolean",
            "description": "Prevent system swapping of the model to disk in macOS",
            "example": false
          },
          "grammar_file": {
            "type": "string",
            "description": "You can constrain the sampling using GBNF grammars by providing path to a grammar file"
          },
          "flash_attn": {
            "type": "boolean",
            "description": "To enable Flash Attention, default is true",
            "example": true
          },
          "cache_type": {
            "type": "string",
            "description": "KV cache type: f16, q8_0, q4_0, default is f16",
            "example": "f16"
          },
          "use_mmap": {
            "type": "boolean",
            "description": "To enable mmap, default is true",
            "example": true
          },
          "size": {
            "type": "number",
            "description": "The model file size in bytes",
            "example": 1073741824
          },
          "engine": {
            "type": "string",
            "description": "The engine to use.",
            "example": "llamacpp"
          },
          "recommendation": {
            "type": "object",
            "$ref": "#/components/schemas/RecommendDto"
          }
        },
        "required": ["id"]
      },
      "ListModelsResponseDto": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "example": "list",
            "enum": ["list"]
          },
          "data": {
            "description": "List of models",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ModelDto"
            }
          }
        },
        "required": ["object", "data"]
      },
      "UpdateModelDto": {
        "type": "object",
        "properties": {
          "files": {
            "type": "array",
            "description": "List of file paths associated with the model. Can be relative or absolute.",
            "items": {
              "type": "string",
              "example": "models\\cortex.so\\tinyllama\\1b-gguf\\model.gguf"
            }
          },
          "stop": {
            "type": "array",
            "description": "Tokens that signal the end of generation.",
            "items": {
              "type": "string"
            },
            "example": ["</s>"]
          },
          "stream": {
            "type": "boolean",
            "description": "Whether to stream the output as it is generated.",
            "example": true
          },
          "top_p": {
            "type": "number",
            "description": "Controls nucleus sampling; the model considers the results of the tokens with top_p probability mass.",
            "example": 0.95
          },
          "temperature": {
            "type": "number",
            "description": "Controls randomness in token selection; lower values make the output more deterministic.",
            "example": 0.7
          },
          "frequency_penalty": {
            "type": "number",
            "description": "Penalizes repeated tokens based on their frequency.",
            "example": 0
          },
          "presence_penalty": {
            "type": "number",
            "description": "Penalizes tokens that have already appeared in the output.",
            "example": 0
          },
          "max_tokens": {
            "type": "integer",
            "description": "Maximum number of tokens to generate.",
            "example": 4096
          },
          "seed": {
            "type": "integer",
            "description": "Seed for random number generation to ensure reproducibility; -1 for random seed.",
            "example": -1
          },
          "dynatemp_range": {
            "type": "number",
            "description": "Range for dynamic temperature adjustment.",
            "example": 0
          },
          "dynatemp_exponent": {
            "type": "number",
            "description": "Exponent for dynamic temperature adjustment.",
            "example": 1
          },
          "top_k": {
            "type": "integer",
            "description": "Limits the sampling pool to the top_k most probable tokens.",
            "example": 40
          },
          "min_p": {
            "type": "number",
            "description": "Minimum probability threshold for token selection.",
            "example": 0.05
          },
          "tfs_z": {
            "type": "number",
            "description": "Threshold for token frequency sampling.",
            "example": 1
          },
          "typ_p": {
            "type": "number",
            "description": "Controls typical sampling; similar to top_p but focuses on local token distribution.",
            "example": 1
          },
          "repeat_last_n": {
            "type": "integer",
            "description": "Number of recent tokens to consider for repetition penalty.",
            "example": 64
          },
          "repeat_penalty": {
            "type": "number",
            "description": "Penalty applied to repeated tokens.",
            "example": 1
          },
          "mirostat": {
            "type": "boolean",
            "description": "Enables or disables Mirostat sampling.",
            "example": false
          },
          "mirostat_tau": {
            "type": "number",
            "description": "Target entropy for Mirostat sampling.",
            "example": 5
          },
          "mirostat_eta": {
            "type": "number",
            "description": "Learning rate for Mirostat sampling.",
            "example": 0.1
          },
          "penalize_nl": {
            "type": "boolean",
            "description": "Whether to penalize newline tokens.",
            "example": false
          },
          "ignore_eos": {
            "type": "boolean",
            "description": "Whether to ignore end-of-sequence tokens during generation.",
            "example": false
          },
          "n_probs": {
            "type": "integer",
            "description": "Number of probabilities to consider for each token.",
            "example": 0
          },
          "min_keep": {
            "type": "integer",
            "description": "Minimum number of tokens to keep in the buffer.",
            "example": 0
          },
          "engine": {
            "type": "string",
            "description": "The engine used to run the model.",
            "example": "llama-cpp"
          },
          "prompt_template": {
            "type": "string",
            "description": "Template used for formatting prompts.",
            "example": "\n\n<|system|>\n{system_message}</s>\n\n\n\n\n<|user|>\n{prompt}</s>\n\n\n<|assistant|>\n\n"
          },
          "ctx_len": {
            "type": "integer",
            "description": "Context length for the model.",
            "example": 4096
          },
          "n_parallel": {
            "type": "integer",
            "description": "Number of parallel threads for execution.",
            "example": 1
          },
          "ngl": {
            "type": "integer",
            "description": "Number of GPU layers.",
            "example": 33
          },
          "header_template": {
            "type": "string",
            "description": "Template for the header."
          },
          "version": {
            "type": "string",
            "description": "The version of the model."
          },
          "inference_params": {
            "type": "object",
            "properties": {
              "temperature": {
                "type": "number"
              },
              "top_p": {
                "type": "number"
              },
              "frequency_penalty": {
                "type": "number"
              },
              "presence_penalty": {
                "type": "number"
              },
              "max_tokens": {
                "type": "integer"
              },
              "stream": {
                "type": "boolean"
              }
            }
          }
        }
      },
      "DeleteModelResponseDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "mistral-ins-7b-q4",
            "description": "The identifier of the model that was deleted."
          },
          "object": {
            "type": "string",
            "example": "model",
            "description": "Type of the object, indicating it's a model.",
            "default": "model"
          },
          "deleted": {
            "type": "boolean",
            "example": true,
            "description": "Indicates whether the model was successfully deleted."
          }
        },
        "required": ["id", "object", "deleted"]
      },
      "CreateThreadAssistantDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "thread_123",
            "description": "The unique identifier of the assistant."
          },
          "avatar": {
            "type": "string",
            "example": "https://example.com/avatar.png",
            "description": "URL of the assistant's avatar image."
          },
          "name": {
            "type": "string",
            "example": "Virtual Helper",
            "description": "The name of the assistant."
          },
          "model": {
            "type": "string",
            "example": "mistral",
            "description": "The model's unique identifier and settings."
          },
          "instructions": {
            "type": "string",
            "example": "Assist with customer queries and provide information based on the company database.",
            "description": "The assistant's specific instructions."
          },
          "tools": {
            "type": "array",
            "example": [
              {
                "name": "Knowledge Retrieval",
                "settings": {
                  "source": "internal",
                  "endpoint": "https://api.example.com/knowledge"
                }
              }
            ],
            "description": "The thread's tool(Knowledge Retrieval) configurations."
          },
          "description": {
            "type": "string",
            "nullable": true,
            "example": "This assistant helps with customer support by retrieving relevant information.",
            "description": "The description of the assistant."
          },
          "metadata": {
            "type": "object",
            "nullable": true,
            "example": {
              "department": "support",
              "version": "1.0"
            },
            "description": "Additional metadata for the assistant."
          },
          "object": {
            "type": "string",
            "example": "assistant",
            "description": "The object type, always \"assistant\"."
          },
          "temperature": {
            "type": "number",
            "nullable": true,
            "example": 0.7,
            "description": "Sampling temperature for the assistant."
          },
          "top_p": {
            "type": "number",
            "nullable": true,
            "example": 0.9,
            "description": "Top-p sampling value for the assistant."
          },
          "created_at": {
            "type": "number",
            "example": 1622470423,
            "description": "Timestamp of when the assistant was created."
          },
          "response_format": {
            "type": "object",
            "example": {
              "format": "json"
            },
            "description": "The response format option for the assistant."
          },
          "tool_resources": {
            "type": "object",
            "example": {
              "resources": ["database1", "database2"]
            },
            "description": "Tool resources for the assistant."
          }
        },
        "required": [
          "id",
          "name",
          "model",
          "instructions",
          "tools",
          "description",
          "metadata",
          "object",
          "created_at"
        ]
      },
      "CreateThreadDto": {
        "type": "object",
        "properties": {
          "assistants": {
            "description": "The details of the thread's settings.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreateThreadAssistantDto"
            }
          }
        },
        "required": ["assistants"]
      },
      "ContentDto": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "example": "text",
            "description": "Type of content, e.g., \"text\"."
          },
          "text": {
            "type": "object",
            "example": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            },
            "description": "Text content of the message along with any annotations."
          }
        },
        "required": ["type", "text"]
      },
      "GetMessageResponseDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "msg_abc123",
            "description": "The identifier of the message."
          },
          "object": {
            "type": "string",
            "example": "thread.message",
            "description": "Type of the object, indicating it's a thread message.",
            "default": "thread.message"
          },
          "created_at": {
            "type": "integer",
            "example": 1699017614,
            "description": "Unix timestamp representing the creation time of the message."
          },
          "thread_id": {
            "type": "string",
            "example": "thread_abc123",
            "description": "Identifier of the thread to which this message belongs."
          },
          "role": {
            "type": "string",
            "example": "user",
            "description": "Role of the sender, either 'user' or 'assistant'."
          },
          "content": {
            "description": "Array of content objects detailing the message content.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ContentDto"
            }
          },
          "file_ids": {
            "example": [],
            "description": "Array of file IDs associated with the message, if any.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "assistant_id": {
            "type": "string",
            "nullable": true,
            "example": null,
            "description": "Identifier of the assistant involved in the message, if applicable."
          },
          "run_id": {
            "type": "string",
            "nullable": true,
            "example": null,
            "description": "Run ID associated with the message, if applicable."
          },
          "metadata": {
            "type": "object",
            "example": {},
            "description": "Metadata associated with the message."
          }
        },
        "required": [
          "id",
          "object",
          "created_at",
          "thread_id",
          "role",
          "content",
          "file_ids",
          "assistant_id",
          "run_id",
          "metadata"
        ]
      },
      "ListMessageObjectDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "msg_abc123",
            "description": "The identifier of the message."
          },
          "object": {
            "type": "string",
            "example": "thread.message",
            "description": "Type of the object, indicating it's a thread message."
          },
          "created_at": {
            "type": "integer",
            "example": 1699017614,
            "description": "Unix timestamp representing the creation time of the message."
          },
          "thread_id": {
            "type": "string",
            "example": "thread_abc123",
            "description": "Identifier of the thread to which this message belongs."
          },
          "role": {
            "type": "string",
            "example": "user",
            "description": "Role of the sender, either 'user' or 'assistant'."
          },
          "file_ids": {
            "description": "Array of file IDs associated with the message, if any.",
            "example": [],
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "assistant_id": {
            "type": "string",
            "nullable": true,
            "description": "Identifier of the assistant involved in the message, if applicable.",
            "example": null
          },
          "run_id": {
            "type": "string",
            "nullable": true,
            "description": "Run ID associated with the message, if applicable.",
            "example": null
          },
          "metadata": {
            "type": "object",
            "example": {},
            "description": "Metadata associated with the message."
          }
        },
        "required": [
          "id",
          "object",
          "created_at",
          "thread_id",
          "role",
          "file_ids",
          "assistant_id",
          "run_id",
          "metadata"
        ]
      },
      "ListMessagesResponseDto": {
        "type": "object",
        "properties": {
          "object": {
            "type": "string",
            "example": "list",
            "description": "Type of the object, indicating it's a list."
          },
          "data": {
            "description": "Array of message objects.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ListMessageObjectDto"
            }
          },
          "first_id": {
            "type": "string",
            "example": "msg_abc123",
            "description": "Identifier of the first message in the list."
          },
          "last_id": {
            "type": "string",
            "example": "msg_abc456",
            "description": "Identifier of the last message in the list."
          },
          "has_more": {
            "type": "boolean",
            "example": false,
            "description": "Indicates whether there are more messages to retrieve."
          }
        },
        "required": ["object", "data", "first_id", "last_id", "has_more"]
      },
      "CreateMessageDto": {
        "type": "object",
        "properties": {
          "role": {
            "type": "object",
            "example": "user",
            "description": "The role of the entity that is creating the message. Allowed values include:\n      - user: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.\n      - assistant: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation."
          },
          "content": {
            "type": "string",
            "example": "Tell me a joke",
            "description": "The text contents of the message."
          }
        },
        "required": ["role", "content"]
      },
      "UpdateMessageDto": {
        "type": "object",
        "properties": {}
      },
      "DeleteMessageDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "message_123",
            "description": "The identifier of the message that was deleted."
          },
          "object": {
            "type": "string",
            "example": "message",
            "description": "Type of the object, indicating it's a message.",
            "default": "message"
          },
          "deleted": {
            "type": "boolean",
            "example": true,
            "description": "Indicates whether the message was successfully deleted."
          }
        },
        "required": ["id", "object", "deleted"]
      },
      "GetThreadResponseDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "thread_abc123",
            "description": "The identifier of the thread."
          },
          "object": {
            "type": "string",
            "example": "thread",
            "description": "Type of the object"
          },
          "created_at": {
            "type": "integer",
            "example": 1699014083,
            "description": "Unix timestamp representing the creation time of the thread."
          },
          "assistants": {
            "example": ["assistant-001"],
            "description": "List of assistants involved in the thread.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "metadata": {
            "type": "object",
            "example": {},
            "description": "Metadata associated with the thread."
          },
          "messages": {
            "example": [],
            "description": "List of messages within the thread.",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "id",
          "object",
          "created_at",
          "assistants",
          "metadata",
          "messages"
        ]
      },
      "UpdateThreadDto": {
        "type": "object",
        "properties": {}
      },
      "DeleteThreadResponseDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "thread_123",
            "description": "The identifier of the thread that was deleted."
          },
          "object": {
            "type": "string",
            "example": "thread",
            "description": "Type of the object, indicating it's a thread.",
            "default": "thread"
          },
          "deleted": {
            "type": "boolean",
            "example": true,
            "description": "Indicates whether the thread was successfully deleted."
          }
        },
        "required": ["id", "object", "deleted"]
      },
      "CPUDto": {
        "type": "object",
        "properties": {
          "arch": {
            "type": "string",
            "example": "amd64",
            "description": "The architecture of the CPU."
          },
          "cores": {
            "type": "integer",
            "example": 8,
            "description": "The number of CPU cores available."
          },
          "instructions": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "fpu",
              "mmx",
              "sse",
              "sse2",
              "sse3",
              "ssse3",
              "sse4_1",
              "sse4_2",
              "pclmulqdq",
              "avx",
              "avx2",
              "aes",
              "f16c"
            ],
            "description": "A list of supported CPU instruction sets."
          },
          "model": {
            "type": "string",
            "example": "AMD Ryzen Threadripper PRO 5955WX 16-Cores",
            "description": "The model name of the CPU."
          }
        },
        "required": ["arch", "cores", "instructions", "model"]
      },
      "GPUDto": {
        "type": "object",
        "properties": {
          "activated": {
            "type": "boolean",
            "example": true,
            "description": "Indicates if the GPU is currently activated."
          },
          "additional_information": {
            "type": "object",
            "properties": {
              "compute_cap": {
                "type": "string",
                "example": "8.6",
                "description": "The compute capability of the GPU."
              },
              "driver_version": {
                "type": "string",
                "example": "535.183",
                "description": "The version of the installed driver."
              }
            },
            "required": ["compute_cap", "driver_version"]
          },
          "free_vram": {
            "type": "integer",
            "example": 23983,
            "description": "The amount of free VRAM in MB."
          },
          "id": {
            "type": "string",
            "example": "0",
            "description": "Unique identifier for the GPU."
          },
          "name": {
            "type": "string",
            "example": "NVIDIA GeForce RTX 3090",
            "description": "The name of the GPU model."
          },
          "total_vram": {
            "type": "integer",
            "example": 24576,
            "description": "The total VRAM available in MB."
          },
          "uuid": {
            "type": "string",
            "example": "GPU-5206045b-2a1c-1e7d-6c60-d7c367d02376",
            "description": "The universally unique identifier for the GPU."
          },
          "version": {
            "type": "string",
            "example": "12.2",
            "description": "The version of the GPU."
          }
        },
        "required": [
          "activated",
          "additional_information",
          "free_vram",
          "id",
          "name",
          "total_vram",
          "uuid",
          "version"
        ]
      },
      "OperatingSystemDto": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Ubuntu 24.04.1 LTS",
            "description": "The name of the operating system."
          },
          "version": {
            "type": "string",
            "example": "24.04.1 LTS (Noble Numbat)",
            "description": "The version of the operating system."
          }
        },
        "required": ["name", "version"]
      },
      "PowerDto": {
        "type": "object",
        "properties": {
          "battery_life": {
            "type": "integer",
            "example": 0,
            "description": "The percentage of battery life remaining."
          },
          "charging_status": {
            "type": "string",
            "example": "",
            "description": "The charging status of the device."
          },
          "is_power_saving": {
            "type": "boolean",
            "example": false,
            "description": "Indicates if the power-saving mode is enabled."
          }
        },
        "required": ["battery_life", "charging_status", "is_power_saving"]
      },
      "RAMDto": {
        "type": "object",
        "properties": {
          "available": {
            "type": "integer",
            "example": 11100,
            "description": "The amount of available RAM in MB."
          },
          "total": {
            "type": "integer",
            "example": 15991,
            "description": "The total RAM in MB."
          },
          "type": {
            "type": "string",
            "example": "",
            "description": "The type of RAM."
          }
        },
        "required": ["available", "total", "type"]
      },
      "StorageDto": {
        "type": "object",
        "properties": {
          "available": {
            "type": "integer",
            "example": 0,
            "description": "The amount of available storage in MB."
          },
          "total": {
            "type": "integer",
            "example": 0,
            "description": "The total storage in MB."
          },
          "type": {
            "type": "string",
            "example": "",
            "description": "The type of storage."
          }
        },
        "required": ["available", "total", "type"]
      }
    }
  }
}