> ## 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.

# Score profiles with a predictive model

> Score profiles with the named model, reusing the cached fit from the most recent train (fitting on demand if none is cached). Post a `contact_id` to score exactly one contact, or omit it to score the model's activation population and return the top-ranked profiles (highest score/value first) up to `limit`. Classification models return a probability `score`; the lifetime-value model returns `predicted_value_cents`. Returns `422` when the model cannot be fit, and `404` when a requested `contact_id` is not in the scoring population. Owner / admin / developer only.



## OpenAPI

````yaml /openapi.yaml post /api/v1/cdp/predictive-models/{model}/score
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
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/cdp/predictive-models/{model}/score:
    post:
      tags:
        - CDP
      summary: Score profiles with a predictive model
      description: >-
        Score profiles with the named model, reusing the cached fit from the
        most recent train (fitting on demand if none is cached). Post a
        `contact_id` to score exactly one contact, or omit it to score the
        model's activation population and return the top-ranked profiles
        (highest score/value first) up to `limit`. Classification models return
        a probability `score`; the lifetime-value model returns
        `predicted_value_cents`. Returns `422` when the model cannot be fit, and
        `404` when a requested `contact_id` is not in the scoring population.
        Owner / admin / developer only.
      parameters:
        - schema:
            type: string
            enum:
              - churn_propensity
              - conversion_intent
              - lifetime_value
              - engagement_fatigue
          in: path
          name: model
          required: true
          description: Model key from `GET /api/v1/cdp/predictive-models`.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                contact_id:
                  type: string
                  minLength: 1
                  maxLength: 128
                  description: >-
                    Score just this contact. Omit to score and rank the whole
                    activation population.
                limit:
                  type: integer
                  minimum: 1
                  maximum: 500
                  default: 50
                  description: >-
                    Maximum number of ranked profiles to return in population
                    mode.
            examples:
              population:
                summary: Rank the top 25 at-risk profiles
                value:
                  limit: 25
              single:
                summary: Score one contact
                value:
                  contact_id: cont_01hxy2q9m4
      responses:
        '200':
          description: Scored profile(s) for the model.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      model:
                        type: string
                      kind:
                        type: string
                        enum:
                          - classification
                          - regression
                      output_unit:
                        type: string
                      population_scored:
                        type: integer
                        description: >-
                          Population-mode only — how many profiles were scored
                          before ranking.
                      limit:
                        type: integer
                      count:
                        type: integer
                        description: >-
                          Population-mode only — number of ranked profiles
                          returned.
                      scored:
                        description: >-
                          A single scored profile (single-contact mode) or the
                          ranked top-N array (population mode).
                        oneOf:
                          - $ref: '#/components/schemas/CdpScoredProfile'
                          - type: array
                            items:
                              $ref: '#/components/schemas/CdpScoredProfile'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
        '404':
          description: The requested contact_id is not in the model's scoring population.
        '422':
          description: The model could not be fit (status `insufficient_data`).
components:
  schemas:
    CdpScoredProfile:
      type: object
      description: >-
        A single scored profile. Classification models set `score` (a
        probability); the lifetime-value model sets `predicted_value_cents`.
      required:
        - contact_id
      properties:
        contact_id:
          type: string
        display_name:
          type:
            - 'null'
            - string
        score:
          type: number
          description: Predicted probability (0..1) — classification models only.
        predicted_value_cents:
          type: number
          description: Predicted lifetime value in cents — regression model only.
    ResponseMeta:
      type: object
      required:
        - request_id
        - timestamp
      additionalProperties: false
      properties:
        request_id:
          type: string
          description: Unique request identifier (also returned as X-Request-Id header)
        timestamp:
          type: string
          format: date-time
        docs_url:
          type: string
          format: uri
          nullable: true
  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_*)

````