> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Materialize a lookalike preview into a static segment

> Promote an AI lookalike PREVIEW into a persisted, static contact segment ready for one-click audience activation. Runs the same centroid-k-NN scoring as `/expand` (so the materialized set equals the preview), then persists the net-new candidates as a NEW static segment (no rules/filters, auto_refresh=false) whose `segment_id` feeds the CDP audience-activation surface. Returns 201 with `materialized: true` and the new segment; when the preview yields no candidates it returns 200 with `materialized: false` and a `reason`, persisting nothing.



## OpenAPI

````yaml /openapi.yaml post /api/v1/contacts/segments/{id}/materialize-lookalike
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
paths:
  /api/v1/contacts/segments/{id}/materialize-lookalike:
    post:
      tags:
        - Contacts
      summary: Materialize a lookalike preview into a static segment
      description: >-
        Promote an AI lookalike PREVIEW into a persisted, static contact segment
        ready for one-click audience activation. Runs the same centroid-k-NN
        scoring as `/expand` (so the materialized set equals the preview), then
        persists the net-new candidates as a NEW static segment (no
        rules/filters, auto_refresh=false) whose `segment_id` feeds the CDP
        audience-activation surface. Returns 201 with `materialized: true` and
        the new segment; when the preview yields no candidates it returns 200
        with `materialized: false` and a `reason`, persisting nothing.
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                limit:
                  type: integer
                  minimum: 1
                  maximum: 500
                  default: 100
                  description: >-
                    Number of net-new lookalike contacts to materialize (matches
                    the `/expand` preview cap so preview equals the materialized
                    set).
                sample_size:
                  type: integer
                  minimum: 1
                  maximum: 200
                  default: 50
                  description: Seed members sampled for the centroid (see `/expand`).
                name:
                  type: string
                  minLength: 1
                  maxLength: 200
                  description: >-
                    Optional override for the new segment's name; defaults to
                    "Lookalike of <seed segment name>".
      responses:
        '200':
          description: The preview yielded no candidates; nothing was persisted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      materialized:
                        type: boolean
                        enum:
                          - false
                      seed_segment_id:
                        type: string
                      seed_count:
                        type: integer
                      candidate_count:
                        type: integer
                      reason:
                        type: string
                        description: >-
                          Actionable reason the lookalike could not be
                          materialized (e.g. empty seed, embeddings unavailable,
                          or no lookalikes found).
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
        '201':
          description: A new static lookalike segment was materialized.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      materialized:
                        type: boolean
                        enum:
                          - true
                      seed_segment_id:
                        type: string
                      segment:
                        type: object
                        additionalProperties: true
                        description: The newly created static segment record.
                      member_count:
                        type: integer
                      activation_ready:
                        type: boolean
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````