Skip to main content

Module genome

Module genome 

Source
Expand description

Genome API Endpoints - Exact port from Python /v1/genome/*

Structs§

GenomeFileUploadForm
Multipart file upload schema for Swagger UI.

Functions§

delete_amalgamation_cancellation
Cancel a pending genome amalgamation operation.
get_amalgamation
Get current amalgamation status and configuration.
get_amalgamation_history_exact
Get history of all genome amalgamation operations performed.
get_circuits
Get list of available circuit templates from the circuit library.
get_cortical_template
Get metadata about all available cortical types including supported encodings and configurations.
get_defaults_files
Get list of available embedded default genome templates (barebones, essential, test, vision).
get_diff
Get a diff comparison between two genomes showing their differences.
get_download
Download the current genome as a JSON document.
get_download_region
Download a specific brain region from the genome.
get_file_name
Get the current genome file name.
get_genome_number
Get the current genome number or generation identifier.
get_metadata
Get genome metadata (alternative endpoint to properties).
get_name
Get the current genome name.
get_properties
Get genome properties including metadata, size, and configuration details.
get_timestamp
Get the genome creation or modification timestamp.
post_amalgamation_by_filename
Perform genome amalgamation by specifying a filename.
post_amalgamation_by_payload
Perform genome amalgamation using a direct JSON payload.
post_amalgamation_by_upload
Perform genome amalgamation by uploading a genome file.
post_amalgamation_destination
Set the destination for genome amalgamation (merging genomes).
post_append_file
Append structures to the genome from a file.
post_clone
Clone the current genome with a new name, creating an independent copy.
post_export_format
Export genome in a specific format (JSON, YAML, binary, etc.).
post_genome_append
Append additional structures to the current genome.
post_load
Load a genome from a file by name.
post_merge
Merge another genome into the current genome, combining their structures.
post_reset
Reset genome to its default state, clearing all customizations.
post_save
Save the current genome to a file with optional ID and title parameters.
post_transform
Transform genome between different formats (flat to hierarchical or vice versa).
post_upload
Upload and load a genome from JSON payload.
post_upload_barebones_genome
Load the minimal barebones genome with only essential neural structures.
post_upload_essential_genome
Load the essential genome with core sensory and motor areas.
post_upload_file
Upload and load a genome from a file.
post_upload_file_edit
Upload a genome file with edit mode enabled.
post_upload_string
Upload and load a genome from a JSON string.
post_validate
Validate a genome structure for correctness and completeness.