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

# How a model version would be served

> Engine, Python compatibility and input columns, for the publish dialog.



## OpenAPI

````yaml get /api/mlflow/registered-models/{name}/serving-info
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/mlflow/registered-models/{name}/serving-info:
    get:
      tags:
        - MLflow
      summary: How a model version would be served
      description: Engine, Python compatibility and input columns, for the publish dialog.
      operationId: get_serving_info_api_mlflow_registered_models__name__serving_info_get
      parameters:
        - name: name
          in: path
          required: true
          schema:
            type: string
            description: Registered model name.
            title: Name
          description: Registered model name.
        - name: version
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Model version, e.g. `3`. Mutually exclusive with `alias`.
            title: Version
          description: Model version, e.g. `3`. Mutually exclusive with `alias`.
        - name: alias
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Model alias, e.g. `production`. Mutually exclusive with `version`.
            title: Alias
          description: Model alias, e.g. `production`. Mutually exclusive with `version`.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServingInfoResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unprocessable Content
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    ServingInfoResponse:
      properties:
        model_name:
          type: string
          title: Model Name
        resolved_version:
          type: string
          title: Resolved Version
        engine:
          anyOf:
            - $ref: '#/components/schemas/ServingEngine'
            - type: 'null'
          description: Engine the model would be served with; None if it can't be served.
        flavors:
          items:
            type: string
          type: array
          title: Flavors
        model_python:
          anyOf:
            - type: string
            - type: 'null'
          title: Model Python
        serving_python:
          type: string
          title: Serving Python
        python_compatible:
          type: boolean
          title: Python Compatible
        input_columns:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Input Columns
          description: >-
            Input column names from the model's signature, if it has a
            column-based one.
        input_types:
          anyOf:
            - additionalProperties:
                type: string
              type: object
            - type: 'null'
          title: Input Types
          description: >-
            MLflow type of each signature input column (for example double,
            string, boolean or datetime), if the model has a column-based
            signature.
        has_signature:
          type: boolean
          title: Has Signature
      type: object
      required:
        - model_name
        - resolved_version
        - flavors
        - serving_python
        - python_compatible
        - has_signature
      title: ServingInfoResponse
      description: >-
        What the Portal needs to know about a model version before publishing
        it.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
    ServingEngine:
      type: string
      enum:
        - spark
        - pyfunc
      title: ServingEngine
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.