v1

latestOpenAPI 3.1.02026-07-175793186.0 KB

optimization

List Optimization Modules

Return the list of registered optimizable DSPy modules.

get/api/v1/optimization/modules

Successful Response

slugstring required

Unique module identifier slug.

labelstring required

Human-readable module label.

descriptionstring

Human-readable description of what this module optimizes.

program_specstring required

DSPy program specification string.

required_dataset_keysstring[] required

Dataset keys required for this module's examples.

input_keysstring[]

Dataset keys used as DSPy inputs for this optimization target.

output_keysstring[]

Dataset keys scored as DSPy outputs for this optimization target.

runtime_module_namestring nullable

Runtime module registry name when this target adapts a runtime module.

signature_class_namestring nullable

DSPy signature class optimized by this target, when available.

optimization_target_kindstring

Optimization target kind such as custom, runtime-signature, or skill.

offline_onlyboolean

Whether this module can only be optimized through offline optimization endpoints.