Skip to main content
GET
Get Available Swarm Types

Headers

x-api-key
string
required

Response

Successful Response

Response model for supported swarm types.

Attributes: status (bool): Indicates success of the operation. timestamp (str): The ISO formatted timestamp of the response. swarm_types (List[str]): A list of available swarm type names. swarm_types_metadata (List[SwarmTypeMetadata]): Rich metadata for every swarm type: description, category, best-for use cases, tuning parameters and docs link.

status
boolean
default:true

Indicates whether fetching swarm types was successful.

timestamp
string
default:2026-08-24T19:29:34.312981

The ISO formatted timestamp when this response was generated.

swarm_types
string[]

A list of supported swarm type names.

swarm_types_metadata
SwarmTypeMetadata · object[]

Rich metadata for every swarm type: description, category, best-for use cases, tuning parameters and documentation link.