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.
rsynthbio ships its function-level docs with the package itself. The pages below are generated from the package help files in man/ so the shared docs site can mirror the current exported reference.
In R
CRAN reference manual (PDF)
The full reference for the latest CRAN release, in one file.
Predictions
predict_query— Predict Gene Expression. Sends a query to the Synthesize Bio API for predictionget_example_query— Get Example Query for Model. Retrieves an example query structure for a specific model.list_models— List Available Models. Returns a list of all models available in the Synthesize Bio API.
Authentication
set_synthesize_token— Set Synthesize Bio API Token. Securely prompts for and stores the Synthesize Bio API token in theload_synthesize_token_from_keyring— Load Synthesize Bio API Token from Keyring. Loads the previously stored Synthesize Bio API token from the systemhas_synthesize_token— Check if Synthesize Bio API Token is Set. Checks whether a Synthesize Bio API token is currently set in theclear_synthesize_token— Clear Synthesize Bio API Token. Clears the Synthesize Bio API token from the environment for the
Constants
API_BASE_URL— API Base URL. Base URL for the Synthesize Bio APIDEFAULT_TIMEOUT— Default Timeout. Default timeout (seconds) for outbound HTTP requestsDEFAULT_POLL_INTERVAL_SECONDS— Default Poll Interval. Default polling interval (seconds) for async model queriesDEFAULT_POLL_TIMEOUT_SECONDS— Default Poll Timeout. Default maximum timeout (seconds) for async model queries