Fleets API

The Fleets API enables you to create and manage groups of agents working together as fleets.

Create Fleet

Create a new fleet with specified agents and configuration.

from agentic_fleet import Fleet, FleetType

fleet = Fleet.create(
    name="code_development",
    type=FleetType.CODE_DEVELOPMENT,
    agents=["agt_123abc", "agt_456def"],
    config={
        "coordination_pattern": "sequential",
        "max_rounds": 5
    }
)

HTTP Request

POST /v1/fleets

Request Body

{
  "name": "code_development",
  "type": "code_development",
  "agents": ["agt_123abc", "agt_456def"],
  "config": {
    "coordination_pattern": "sequential",
    "max_rounds": 5
  }
}

Response

{
  "fleet_id": "flt_789xyz",
  "name": "code_development",
  "type": "code_development",
  "agents": ["agt_123abc", "agt_456def"],
  "status": "active",
  "created_at": "2025-02-24T15:30:00Z"
}

List Fleets

Retrieve a list of all fleets.

fleets = Fleet.list(limit=10, offset=0)

HTTP Request

GET /v1/fleets

Query Parameters

ParameterTypeDescription
limitintegerMaximum number of fleets to return
offsetintegerNumber of fleets to skip
typestringFilter by fleet type
statusstringFilter by fleet status

Response

{
  "fleets": [
    {
      "fleet_id": "flt_789xyz",
      "name": "code_development",
      "type": "code_development",
      "status": "active"
    }
  ],
  "total": 1,
  "has_more": false
}

Get Fleet

Retrieve details about a specific fleet.

fleet = Fleet.get("flt_789xyz")

HTTP Request

GET /v1/fleets/{fleet_id}

Response

{
  "fleet_id": "flt_789xyz",
  "name": "code_development",
  "type": "code_development",
  "agents": ["agt_123abc", "agt_456def"],
  "config": {
    "coordination_pattern": "sequential",
    "max_rounds": 5
  },
  "status": "active",
  "created_at": "2025-02-24T15:30:00Z",
  "last_active": "2025-02-24T16:00:00Z"
}

Update Fleet

Update an existing fleet’s configuration.

fleet = Fleet.update(
    "flt_789xyz",
    name="advanced_development",
    config={
        "max_rounds": 10
    }
)

HTTP Request

PATCH /v1/fleets/{fleet_id}

Request Body

{
  "name": "advanced_development",
  "config": {
    "max_rounds": 10
  }
}

Response

{
  "fleet_id": "flt_789xyz",
  "name": "advanced_development",
  "type": "code_development",
  "config": {
    "coordination_pattern": "sequential",
    "max_rounds": 10
  },
  "status": "active",
  "updated_at": "2025-02-24T16:05:00Z"
}

Delete Fleet

Delete a fleet.

Fleet.delete("flt_789xyz")

HTTP Request

DELETE /v1/fleets/{fleet_id}

Response

{
  "deleted": true,
  "fleet_id": "flt_789xyz"
}

Fleet Types

Available fleet types and their use cases:

TypeDescription
CODE_DEVELOPMENTSoftware development workflows
RESEARCHResearch and analysis tasks
CREATIVECreative content generation
SUPPORTCustomer support and assistance
CUSTOMCustom fleet configurations

Coordination Patterns

Available coordination patterns for fleet management:

PatternDescription
sequentialAgents work in a fixed sequence
parallelAgents work simultaneously
hierarchicalAgents work in a tree structure
dynamicPattern adapts based on task