---
title: "CreateSwarmBody"
description: "Request body for creating a Swarm."
section: "Reference"
group: "Types"
order: 215
---

## Definition

```ts
interface CreateSwarmBody {
  workspaceId: string;
  name: string;
  description?: string | undefined;
  instructions?: string | undefined;
  models?: Array<string> | undefined;
}
```

## Fields

| Field          | Type                         | Notes                                                    |
| -------------- | ---------------------------- | -------------------------------------------------------- |
| `workspaceId`  | `string`                     | `required` — Workspace that will own the new swarm.      |
| `name`         | `string`                     | `required` — Swarm name                                  |
| `description`  | `string \| undefined`        | `optional` — Swarm description                           |
| `instructions` | `string \| undefined`        | `optional` — System instructions for the initial version |
| `models`       | `Array<string> \| undefined` | `optional` — Model IDs for the initial version           |