Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.synthesize.bio/llms.txt

Use this file to discover all available pages before exploring further.

Retrieves an example query structure for a specific model. This provides a template that can be modified for your specific needs.

​
Usage

get_example_query(model_id, api_base_url = API_BASE_URL)

​
Arguments

  • model_id: Character string specifying the model ID (e.g., “gem-1-bulk”, “gem-1-sc”).
  • api_base_url: The base URL for the API server. Default is API_BASE_URL.

​
Returns

A list representing a valid query structure for the specified model.

​
Examples

# Get example query for bulk RNA-seq model
query <- get_example_query(model_id = "gem-1-bulk")$example_query

# Get example query for single-cell model
query_sc <- get_example_query(model_id = "gem-1-sc")$example_query

# Modify the query structure
query$inputs[[1]]$num_samples <- 10

​
Source

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