Skip to main content
Returns a list of all models available in the Synthesize Bio API. Each model has a unique ID that can be used with predict_query() and get_example_query().

​
Usage

list_models(api_base_url = NULL, self_hosted = NULL)

​
Arguments

  • api_base_url: The base URL for the API server. When NULL (default), it is resolved from the SYNTHESIZE_API_BASE_URL environment variable, falling back to the production default (API_BASE_URL). Point this at a self-hosted model container to list its models.
  • self_hosted: Logical; when TRUE, the request targets a self-hosted container and does not require an API key (one is only sent if set). When NULL (default), it is resolved from the SYNTHESIZE_SELF_HOSTED environment variable (truthy for 1/true/yes/on), defaulting to FALSE.

​
Returns

A list or data frame containing available models with their IDs and metadata.

​
Examples

# Get all available models
models <- list_models()
print(models)

# List models from a self-hosted container (no API key required)
models <- list_models(
  api_base_url = "https://gem-1-bulk.internal.partner.example",
  self_hosted = TRUE
)

​
Source

Generated from R/call_model_api.R and the package help files in man/.