---
title: "Create a segment"
method: POST
path: "/tenants/{slug}/segments"
tags: ["segments"]
---

# Create a segment

`POST /tenants/{slug}/segments`

## Request

- Base URL: `https://api.animam.ai`
- URL: `https://api.animam.ai/tenants/{slug}/segments`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`
  - OAuth 2 (authorization code, authorization URL `https://api.animam.ai/oauth/authorize`, token URL `https://api.animam.ai/oauth/token`, scopes: `segments:write`)

Creates a new segment. The REST endpoint auto-generates a slug from `name`; pass `slug` explicitly only via the MCP tool.

## Path parameters

- `slug` string, required: Tenant slug (URL-safe identifier).

## Request body

- CreateSegmentBody
  - `slug` string, required
  - `name` string, required
  - `systemPrompt` string, required
  - `welcomeMessage` string
  - `isDefault` boolean

## Response `201`

Created segment.

- object
  - `segment` SegmentDetail, required
    - `slug` string, required
    - `name` string, required
    - `systemPrompt` string, required
    - `welcomeMessage` string, nullable, required
    - `formConfig` FormConfig, nullable, required
      - `enabled` boolean, required
      - `intent` string, required
      - `confirmationMessage` string
      - `fields` FormField[], required
        - `name` string, required
        - `label` string, required
        - `type` 'text' | 'email' | 'phone' | 'textarea', required
        - `required` boolean, required
    - `isDefault` boolean, required
    - `isActive` boolean, required

---

[API](https://skmtc.dev/animam/apis/animam-api.md) · [All operations](https://skmtc.dev/animam/apis/animam-api/llms.txt) · [OpenAPI document](https://skmtc.dev/animam/apis/animam-api/revisions/138c3cf374f1?raw)