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

# Generate model from the given data sample

> Generate model from the given data sample



## OpenAPI

````yaml POST /v3/model-factory
openapi: 3.0.3
info:
  title: Fiddler API - 2.0
  description: APIs to interact with Fiddler
  termsOfService: https://fiddler.ai/about/terms
  contact:
    email: support@fiddler.ai
  license:
    name: Proprietary
    url: '2.0'
  version: '2.0'
servers: []
security:
  - BearerAuth: []
tags:
  - name: access-key
    description: CRUD operations for API keys
  - name: agent-v3
    description: CRUD for the Agent Registry (Stage 1, manual entries)
  - name: aggregation-invalidation-request-v3
    description: Endpoints related to retrieving aggregation invalidation requests
  - name: alert-rules-v3
    description: CRUD for Alert Rules, Summary, and Stats APIs
  - name: application-v3
  - name: auth
    description: Authentication strategies and login flows
  - name: baseline-v3
    description: CRUD for baseline
  - name: catalog-v3
    description: >-
      Entity catalog provides paginated, searchable discovery of entity names
      (attribute keys, agent names, span types, span names, score names,
      evaluator config names) and their distinct values. Powered by ClickHouse
      materialized views — no worker or PostgreSQL dependency.
  - name: chart-annotation-v3
    description: Endpoints related to retrieving chart annotations
  - name: chart-v3
    description: CRUD for chart
  - name: queries-v3
    description: v3 queries API
  - name: configuration-v3
    description: >
      Read and change runtime configurations (Config Manager) for your
      organization, its projects, and its models.


      **Private preview.** These endpoints accept requests on every deployment.

      Whether a saved value takes effect depends on two deployment settings that
      are off by default:

      one makes Fiddler read stored values,

      and the other runs the configuration worker, which applies retention
      changes to stored data.

      Contact your Fiddler Customer Success Manager before using these
      endpoints.


      This reference documents the data retention (TTL) settings:

      `PROD_EVENTS_TTL_DAYS`, `GENAI_TRACES_TTL_DAYS`, and
      `GENAI_METRICS_TTL_DAYS`.

      The API accepts other registered settings too;

      contact your Fiddler Customer Success Manager before changing any of them.

      **Retention settings permanently delete data** once it is older than the
      configured period.

      When existing data is affected depends on the setting; see each setting's
      description.
  - name: cost-evaluators-v3
    description: >
      Paginated roll-up of per-evaluator LLM cost and token usage, aggregated
      hourly. Available only on deployments with evaluator cost reporting
      enabled.
  - name: cp-policy-v3
    description: >
      Configure Control Plane policies from policy packs, build them into signed
      revisions, and promote a revision so policy decision points evaluate it.
      These endpoints are served by the Control Plane policy administration
      service, and every one returns `404` while the policy engine is turned off
      for the deployment. Permissions come from the `Policy` authorization
      resource: Org Admins and Org Members hold `Policy: List` and `Policy:
      Read`, and only Org Admins hold `Policy: Create`, `Policy: Update` and
      `Policy: Delete`.
  - name: custom-metrics-v3
  - name: dimensionality-reduction-v3
  - name: environment-v3
    description: Endpoints related to environment management
  - name: evals
  - name: datasets
  - name: evaluation-v3
  - name: evaluator-v3
  - name: rule-evaluators-v3
  - name: experiment-v3
  - name: explainability-v3
  - name: llm_rca-v3
  - name: file-upload
    description: Endpoints related to file uploading.
  - name: fql-expressions-v3
    description: >
      Endpoints for listing FQL (Fiddler Query Language) functions available for
      GenAI custom metrics. Used by the frontend for autocomplete and signature
      hints in the FQL editor.
  - name: genai-alert-rules-v3
    description: CRUD API for GenAI Alert Rules
  - name: genai-custom-metrics-v3
    description: API for GenAI Custom Metrics
  - name: genai-filters-v3
    description: API for GenAI Filters
  - name: genai-metrics-v3
    description: >-
      Endpoints for pre-aggregated GenAI metrics. All metric data is
      pre-aggregated hourly by a Celery-based metric collector; no real-time
      aggregation is performed at request time.
  - name: guardrails-api
    description: Endpoints related to retrieving Guardrails specific data
  - name: ingestion-v3
  - name: intercom-api
    description: Endpoints related to intercom APIs
  - name: jobs-v3
  - name: llm-gateway-v3
  - name: auth-login
  - name: auth-logout
  - name: mcp-client-setup-v3
    description: Endpoints for retrieving MCP client setup instructions.
  - name: metrics-v3
    description: Metrics endpoints
  - name: model-v3
  - name: dashboard-v3
  - name: model-deployment-v3
  - name: monitoring-summary-v3
  - name: histograms-v3
  - name: organization-roles-v3
    description: Update user org role
  - name: organization-settings-v3
    description: Update organization settings such as timezone, email configuration, etc.
  - name: pagerduty-api
    description: CRUD for Pagerduty services.
  - name: project-v3
  - name: project-roles-v3
    description: Project role assignment management
  - name: scores-v3
    description: Unified CRUD for scores and annotations
  - name: searchable-text-key-v3
    description: >-
      Manage the global searchable text keys table that controls which OTel
      attribute keys are routed to the full-text-searchable `ValueContent`
      column in the unified attributes table. Changes propagate to the backing
      ClickHouse dictionary within 1-2 minutes and affect all tenants.
  - name: segments-v3
  - name: semantic-mapping-v3
    description: >-
      Manage the global semantic name mappings table that maps raw OTel
      attribute keys to canonical semantic concepts. Changes propagate to the
      backing ClickHouse dictionary within 1-2 minutes and affect all tenants.
  - name: server-info-v3
    description: Endpoints related to retrieving server information
  - name: service-account
    description: >
      Service accounts and their API keys. A human Org Admin manages the service
      accounts of their own organization: create, read, update, and
      enable/disable (there is no delete — an account is disabled instead), and
      issue, rename, enable/disable, and revoke each account's API keys (a key's
      expiry is fixed at creation and changed only by rotating the key). An API
      key is an `fks_` secret that inherits the account's grants and cannot
      manage service accounts; an active, unexpired key must be disabled before
      it can be revoked, and it authenticates only while both it and its account
      are active. Scopes here are capability scopes (what the account may do),
      not OAuth scopes.
  - name: sessions-v3
    description: v3 session APIs
  - name: span-v3
  - name: team-roles-v3
  - name: team-v3
  - name: traces-v3
    description: v3 trace api for monitoring
  - name: fetch-sessions-v3
    description: v3 fetch sessions api for monitoring
  - name: user-access-key
    description: >
      CRUD operations for user API keys. All endpoints are user-scoped — each
      user can only operate on their own API keys. No one including Org admins
      have access to other users' API keys.
  - name: users-v3
  - name: version-compatibility-v3
  - name: webhooks
externalDocs:
  url: https://docs.fiddler.ai
  description: Find out more about Fiddler
paths:
  /v3/model-factory:
    post:
      tags:
        - model-v3
      summary: Generate model from the given data sample
      description: Generate model from the given data sample
      operationId: modelFactory
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModelFactoryRequest'
      responses:
        '200':
          description: Generated model
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/ModelFactoryResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
components:
  schemas:
    ModelFactoryRequest:
      type: object
      required:
        - file_id
      properties:
        file_id:
          type: string
          format: uuid
        spec:
          $ref: '#/components/schemas/ModelSpecObject'
        max_cardinality:
          type: integer
          minimum: 1
          maximum: 100000
          default: 1000
        sample_size:
          type: integer
          minimum: 10000
          maximum: 100000
          default: 10000
    ApiResponse:
      type: object
      description: |
        Response object for standard API responses.
      properties:
        api_version:
          type: string
          default: '3.0'
          enum:
            - '2.0'
            - '3.0'
          description: |
            API version.
        kind:
          type: string
          default: NORMAL
          enum:
            - NORMAL
          description: |
            Type of response, indicating a normal response.
    ModelFactoryResponse:
      type: object
      properties:
        schema:
          $ref: '#/components/schemas/ModelSchemaObjectResponse'
        spec:
          $ref: '#/components/schemas/ModelSpecObject'
    ModelSpecObject:
      type: object
      properties:
        schema_version:
          type: integer
          description: Schema version. Internally used. Leave empty.
          default: 1
        inputs:
          type: array
          description: List of input columns
          items:
            type: string
        outputs:
          type: array
          description: List of output columns
          items:
            type: string
        targets:
          type: array
          description: List of target columns
          items:
            type: string
        decisions:
          type: array
          description: List of decision columns
          items:
            type: string
        metadata:
          type: array
          description: List of metadata columns
          items:
            type: string
        custom_features:
          type: array
          description: List of custom feature columns
          items:
            $ref: '#/components/schemas/CustomFeature'
    ModelSchemaObjectResponse:
      type: object
      description: Model schema with the details of each column
      properties:
        schema_version:
          type: integer
          description: Schema version
          default: 1
        columns:
          type: array
          items:
            $ref: '#/components/schemas/ModelSchemaColumnObjectResponse'
    ErrorResponse:
      type: object
      description: |
        Response object for errors returned by the API.
      properties:
        api_version:
          type: string
          default: '3.0'
          enum:
            - '2.0'
            - '3.0'
          description: |
            API version of the response.
        kind:
          type: string
          default: ERROR
          enum:
            - ERROR
          description: |
            Type of response, usually indicating an error.
        error:
          type: object
          properties:
            code:
              type: integer
              format: int32
              description: >
                Represents the code for this error, typically an HTTP response
                code.
              default: 400
              enum:
                - 400
                - 401
                - 403
                - 404
                - 409
                - 410
                - 422
                - 429
                - 500
                - 501
                - 503
            message:
              type: string
              description: >
                A human-readable message providing more details about the error.
                If there are multiple errors, it will be the message for the
                first error.
              example: Resource Not Found
            errors:
              type: array
              description: >
                Container for additional information regarding the error,
                especially for multiple errors.
              items:
                type: object
                properties:
                  reason:
                    type: string
                    description: >
                      Unique identifier for this error, different from the error
                      code.
                    example: ResourceNotFoundException
                  message:
                    type: string
                    description: >
                      A human-readable message providing more details about the
                      error. If there is only one error, this field will match
                      error.message.
                    example: Resource Not Found
                  help:
                    type: string
                    description: >
                      Link to support or documentation providing more
                      information on the error.
    CustomFeature:
      type: object
      required:
        - name
      properties:
        type:
          type: string
          enum:
            - FROM_COLUMNS
            - FROM_VECTOR
            - FROM_TEXT_EMBEDDING
            - FROM_IMAGE_EMBEDDING
            - ENRICHMENT
        name:
          description: Name of the custom feature
          type: string
        columns:
          type: array
          items:
            type: string
        centroids:
          type: array
          items:
            type: number
        tf_idf:
          type: array
          items:
            type: object
        n_clusters:
          type: integer
        monitor_components:
          type: boolean
    ModelSchemaColumnObjectResponse:
      allOf:
        - $ref: '#/components/schemas/ModelSchemaColumnObject'
        - type: object
          properties:
            id:
              type: string
              description: Internal column identifier
          required:
            - id
    ModelSchemaColumnObject:
      type: object
      description: A model column representation
      required:
        - name
        - data_type
      properties:
        name:
          type: string
          description: Column name
        data_type:
          $ref: '#/components/schemas/ModelColumnsDataTypeEnum'
        min:
          nullable: true
          type: number
          description: Min value of integer/float column
        max:
          nullable: true
          type: number
          description: Max value of integer/float column
        categories:
          nullable: true
          type: array
          description: List of unique values of a categorical column
          items:
            anyOf:
              - type: string
              - type: number
              - type: boolean
        bins:
          nullable: true
          type: array
          description: >-
            Bin boundary values for integer/float column histograms. Must be a
            strictly increasing array of numbers spanning [min, max]. If
            omitted, uniform bins are auto-generated from min and max. Minimum 2
            and maximum 16 boundary values (1 to 15 bins).
          items:
            type: number
          maxItems: 16
          minItems: 2
        replace_with_nulls:
          nullable: true
          type: array
          description: Replace the list of given values to null if found in the events data
          items:
            anyOf:
              - type: string
              - type: number
        n_dimensions:
          nullable: true
          type: integer
          description: Number of dimensions of a vector column
    ModelColumnsDataTypeEnum:
      type: string
      description: Data type of the column
      enum:
        - int
        - float
        - str
        - bool
        - category
        - timestamp
        - vector
  responses:
    '400':
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    '401':
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    '404':
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    '500':
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````