Module cortical_area 

Cortical Area API Endpoints - Exact port from Python /v1/cortical_area/*

Reference: feagi-py/feagi/api/v1/cortical_area.py

Structs

CloneCorticalAreaRequest

Request payload for POST /v1/cortical_area/clone

CorticalAreaIdListResponse

CorticalAreaNameListResponse

CorticalTypeMetadata

UnitTopologyData

Functions

delete_bulk

Delete multiple cortical areas by their IDs in a single operation.

delete_cortical_area

Delete a cortical area by ID. Removes the area and all associated neurons and synapses.

delete_multi_cortical_area

Delete multiple cortical areas by their IDs. (Not yet implemented)

get_area_neuron_count

Get the total number of neurons in a specific cortical area.

get_cortical_area_geometry

Get complete cortical area data including geometry, neural parameters, and metadata. Used by Brain Visualizer.

get_cortical_area_id_list

Get a list of all cortical area IDs across the entire genome (IPU, OPU, custom, memory, and core areas).

get_cortical_area_index_list

Get list of all cortical area indices (numerical indices used internally for indexing).

get_cortical_area_name_list

Get a list of all cortical area names (human-readable labels for all cortical areas).

get_cortical_id_name_mapping

Get a map of cortical area IDs to their human-readable names. Returns {cortical_id: name} pairs.

get_cortical_idx_mapping

Get mapping from cortical area IDs to their internal indices. Returns {cortical_id: index}.

get_cortical_locations_2d

Get 2D positions of all cortical areas for visualization. Returns {cortical_id: (x, y)} coordinates.

get_cortical_map_detailed

Get detailed cortical connectivity mappings showing source-to-destination connections with mapping rules.

get_cortical_types

Get available cortical area types: sensory, motor, memory, and custom.

get_cortical_visibility

Get visibility status of all cortical areas. Returns {cortical_id: visibility_flag}.

get_ipu

List all IPU (Input Processing Unit) cortical area IDs. Returns IDs of all sensory cortical areas.

get_ipu_list

Alias for /v1/cortical_area/ipu - list all IPU cortical area IDs.

get_ipu_types

Get metadata for all available IPU types (vision, infrared, etc.). Includes encodings, formats, units, and topology.

get_mapping_restrictions_query

Get restrictions on which cortical areas can connect to which (connection validation rules).

get_memory_usage

Get memory usage of a specific cortical area in bytes (calculated from neuron count).

get_opu

List all OPU (Output Processing Unit) cortical area IDs. Returns IDs of all motor cortical areas.

get_opu_list

Alias for /v1/cortical_area/opu - list all OPU cortical area IDs.

get_opu_types

Get metadata for all available OPU types (motors, servos, etc.). Includes encodings, formats, units, and topology.

get_visualization

Check if visualization is enabled for the system.

post_batch_operations

Execute multiple cortical area operations (create, update, delete) in a single batch.

post_clone

Clone an existing cortical area with all its properties and structure. (Not yet implemented)

post_cortical_area

Create IPU (sensory) or OPU (motor) cortical areas with proper topology and multi-unit support.

post_cortical_area_properties

Get detailed properties of a single cortical area by ID. Request: {cortical_id: string}.

post_cortical_name_location

Get the 2D location of a cortical area by its name. Request: {cortical_name: string}.

post_cortical_type_options

Get available cortical type options for UI selection: Sensory, Motor, Custom, Memory.

post_custom_cortical_area

Create a custom cortical area for internal processing with specified dimensions and position.

post_mapping_restrictions

Get mapping restrictions for specific cortical areas (POST version with request body).

post_mapping_restrictions_between_areas

Get mapping restrictions between two specific cortical areas (connection validation).

post_multi_cortical_area_properties

Get properties for multiple cortical areas. Accepts array ["id1", "id2"] or object {cortical_id_list: […]}.

post_reposition

Move a cortical area to a new position. (Not yet implemented)

post_resize

Resize a cortical area by changing its dimensions. (Not yet implemented)

post_voxel_neurons

Get neurons at specific voxel coordinates within a cortical area.

put_coord_2d

Update the 2D visualization coordinates of a cortical area. (Not yet implemented)

put_coord_3d

Update 3D coordinates of a cortical area (alternative endpoint). (Not yet implemented)

put_coordinates_3d

Update the 3D position of a cortical area. (Not yet implemented)

put_cortical_area

Update properties of an existing cortical area (position, dimensions, neural parameters, etc.).

put_multi_cortical_area

Update properties of multiple cortical areas in a single request. (Not yet implemented)

put_reset

Reset a cortical area to its default state (clear neuron states, etc.). (Not yet implemented)

put_suppress_cortical_visibility

Hide/show cortical areas in visualizations. (Not yet implemented)