Animam.ai

Animam.ai Segments API

Conversation segments (audiences).

GitHub OpenAPI

Operations 3

GET /tenants/{slug}/segments List segments #
POST /tenants/{slug}/segments Create a segment #
PUT /tenants/{slug}/segments/{slugOrId} Update a segment #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/animam-ai/openapi/animam-ai-segments-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/animam-ai/json-schema/animam-ai-create-corpus-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/animam-ai/json-schema/animam-ai-update-tenant-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/animam-ai/json-schema/animam-ai-corpus-entry-schema.json
📊
JSONSchema
https://artifacts.apis.io/animam-ai/json-schema/animam-ai-segment-detail-schema.json
📊
JSONSchema
https://artifacts.apis.io/animam-ai/json-schema/animam-ai-list-corpus-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/animam-ai/json-schema/animam-ai-create-segment-body-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/animam-ai:animam-ai-segments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

animam-ai-segments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Animam Ai Segments API
  version: 2.1.0
  contact:
    name: Animam
    url: https://animam.ai
  license:
    name: Proprietary
  description: 'Operations tagged segments across 2 of this provider''s published API definitions: animam-ai-openapi.json, animam-ai-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.animam.ai
  description: Production
tags:
- name: Segments
  description: Conversation segments (audiences).
paths:
  /tenants/{slug}/segments:
    get:
      tags:
      - Segments
      summary: List segments
      security:
      - bearerAuth: []
      - apiKey: []
      - oauth2:
        - segments:read
      parameters:
      - schema:
          type: string
          description: Tenant slug (URL-safe identifier).
          example: dr-martin
        required: true
        description: Tenant slug (URL-safe identifier).
        name: slug
        in: path
      responses:
        '200':
          description: List of segments.
          content:
            application/json:
              schema:
                type: object
                properties:
                  segments:
                    type: array
                    items:
                      $ref: '#/components/schemas/SegmentSummary'
                required:
                - segments
      operationId: getTenantsBySlugSegments
      x-operation-id-source: derived
    post:
      tags:
      - Segments
      summary: Create a segment
      description: Creates a new segment. The REST endpoint auto-generates a slug from `name`; pass `slug` explicitly only via the MCP tool.
      security:
      - bearerAuth: []
      - apiKey: []
      - oauth2:
        - segments:write
      parameters:
      - schema:
          type: string
          description: Tenant slug (URL-safe identifier).
          example: dr-martin
        required: true
        description: Tenant slug (URL-safe identifier).
        name: slug
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSegmentBody'
      responses:
        '201':
          description: Created segment.
          content:
            application/json:
              schema:
                type: object
                properties:
                  segment:
                    $ref: '#/components/schemas/SegmentDetail'
                required:
                - segment
      operationId: postTenantsBySlugSegments
      x-operation-id-source: derived
    servers:
    - url: https://api.animam.ai
      description: Production
  /tenants/{slug}/segments/{slugOrId}:
    put:
      tags:
      - Segments
      summary: Update a segment
      description: Path identifier is `segmentId` (UUID) on the REST endpoint or `slug` via MCP. Both refer to the same segment.
      security:
      - bearerAuth: []
      - apiKey: []
      - oauth2:
        - segments:write
      parameters:
      - schema:
          type: string
          description: Tenant slug (URL-safe identifier).
          example: dr-martin
        required: true
        description: Tenant slug (URL-safe identifier).
        name: slug
        in: path
      - schema:
          type: string
          description: Segment UUID (REST) or slug (MCP).
        required: true
        description: Segment UUID (REST) or slug (MCP).
        name: slugOrId
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSegmentBody'
      responses:
        '200':
          description: Updated segment.
          content:
            application/json:
              schema:
                type: object
                properties:
                  segment:
                    $ref: '#/components/schemas/SegmentDetail'
                required:
                - segment
      operationId: putTenantsBySlugSegmentsBySlugOrId
      x-operation-id-source: derived
    servers:
    - url: https://api.animam.ai
      description: Production
components:
  schemas:
    UpdateSegmentBody:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
        systemPrompt:
          type: string
          minLength: 1
        welcomeMessage:
          type: string
        formConfig:
          $ref: '#/components/schemas/FormConfig'
        isActive:
          type: boolean
    SegmentDetail:
      type: object
      properties:
        slug:
          type: string
        name:
          type: string
        systemPrompt:
          type: string
        welcomeMessage:
          type:
          - string
          - 'null'
        formConfig:
          $ref: '#/components/schemas/FormConfig'
        isDefault:
          type: boolean
        isActive:
          type: boolean
      required:
      - slug
      - name
      - systemPrompt
      - welcomeMessage
      - formConfig
      - isDefault
      - isActive
    CreateSegmentBody:
      type: object
      properties:
        slug:
          type: string
          minLength: 1
          maxLength: 100
          pattern: ^[a-z0-9-]+$
        name:
          type: string
          minLength: 1
          maxLength: 255
        systemPrompt:
          type: string
          minLength: 1
        welcomeMessage:
          type: string
        isDefault:
          type: boolean
      required:
      - slug
      - name
      - systemPrompt
    FormField:
      type: object
      properties:
        name:
          type: string
        label:
          type: string
        type:
          type: string
          enum:
          - text
          - email
          - phone
          - textarea
        required:
          type: boolean
      required:
      - name
      - label
      - type
      - required
    SegmentSummary:
      type: object
      properties:
        slug:
          type: string
        name:
          type: string
        isDefault:
          type: boolean
        isActive:
          type: boolean
        corpusCount:
          type: integer
        conversationsCount:
          type: integer
      required:
      - slug
      - name
      - isDefault
      - isActive
      - corpusCount
      - conversationsCount
    FormConfig:
      type:
      - object
      - 'null'
      properties:
        enabled:
          type: boolean
        intent:
          type: string
        confirmationMessage:
          type: string
        fields:
          type: array
          items:
            $ref: '#/components/schemas/FormField'
      required:
      - enabled
      - intent
      - fields
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key (ak_...) or JWT
      description: 'Static API key (`Authorization: Bearer ak_xxx`) or short-lived JWT issued by /oauth/token.'
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Alternative header for legacy integrations.
    oauth2:
      type: oauth2
      description: OAuth 2.1 + PKCE for MCP-style agent integrations.
      flows:
        authorizationCode:
          authorizationUrl: https://api.animam.ai/oauth/authorize
          tokenUrl: https://api.animam.ai/oauth/token
          scopes:
            corpus:read: Read knowledge base entries
            corpus:write: Create / update / delete knowledge base entries
            segments:read: Read segments
            segments:write: Create / update segments
            settings:read: Read tenant settings
            settings:write: Update tenant settings
            stats:read: Read analytics and usage data
externalDocs:
  url: https://animam.ai/llms-full.txt
  description: Agent-readable full documentation (Markdown).
x-refined-from:
- animam-ai-openapi.json
- animam-ai-original.json