% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/list.R
\name{list_models}
\alias{list_models}
\title{List available models}
\usage{
list_models(
  loaded = FALSE,
  type = c("llm", "embedding"),
  detailed = FALSE,
  quiet = FALSE,
  host = "http://localhost:1234"
)
}
\arguments{
\item{loaded}{Logical. If \code{TRUE}, returns only currently loaded models.
Defaults to \code{FALSE}.}

\item{type}{Character vector. The types of models to include. Defaults to
\code{c("llm", "embedding")}.}

\item{detailed}{Logical. Show all information about each model. Defaults to
\code{FALSE}.}

\item{quiet}{Logical. If \code{TRUE}, suppresses informative console
messages. Defaults to \code{FALSE}.}

\item{host}{Character. The host address of the local server.}
}
\value{
A \code{data.frame} containing information about the available
models. By default, it includes columns for \code{state}, \code{type},
\code{display_name}, \code{key}, \code{architecture}, and \code{size_gb}.
If \code{detailed = TRUE}, it returns a comprehensive \code{data.frame}
including all raw metadata columns provided by the API. Returns an empty
\code{data.frame} if no models match the criteria.
}
\description{
Retrieves a list of models available on your system via the LM Studio REST
API.
}
\examples{
\dontrun{
lms_server_start()
lms_download("google/gemma-3-1b")
lms_load("google/gemma-3-1b")

# List all downloaded models
list_models()

# List only currently loaded models
list_models(loaded = TRUE)

# Get detailed information about loaded text models
list_models(loaded = TRUE, type = "llm", detailed = TRUE)
}
}
\seealso{
\href{https://lmstudio.ai/docs/developer/rest/list}{LM Studio List Models API}
}
