API → MLOpen a websocket to prompt the ML copilot

Parameters

• conversation_id

  string / UUID

  optional

• replay

  boolean

  optional

• bodyapplication/json

  oneOf

  optional

  One of

  • headers

    object

    required

    Object Properties

    • headers

      object

      optional

    • type

      string

      optional

      Possible values

      • headers

  • user

    object

    optional

    Object Properties

    • content

      string

      optional

    • current_files

      object

      optional

    • forced_tools

      array

      optional

    • mode

      string

      optional

      Possible values

      • fast:  Use a combination of models and reasoning effort for fast results.
      • thoughtful:  Use a model and effort that results in thoughtful responses.

    • model

      string

      optional

      Possible values

      • gpt5_nano:  gpt-5-nano
      • gpt5_mini:  gpt-5-mini
      • gpt5_codex:  gpt-5-codex
      • gpt5:  gpt-5
      • o3_mini:  o3-mini
      • azure_o3_mini:  azure o3-mini
      • azure_gpt4o:  azure gpt-4o
      • azure_gpt4o_mini:  azure gpt-4o-mini

    • project_name

      string

      optional

    • reasoning_effort

      string

      optional

      Possible values

      • low:  Low reasoning
      • medium:  Medium reasoning
      • high:  High reasoning

    • source_ranges

      array

      optional

      Array of

      • file

        string

        optional

      • prompt

        string

        optional

      • range

        object

        optional

        Object Properties

        • end

          object

          optional

          Object Properties

          • column

            integer

            optional

          • line

            integer

            optional

        • start

          object

          optional

          Object Properties

          • column

            integer

            optional

          • line

            integer

            optional

    • type

      string

      optional

      Possible values

      • user

  • system

    object

    optional

    Object Properties

    • command

      string

      optional

      Possible values

      • new:  Reset the conversation state, by creating a new state.
      • bye:  Disconnect the client, which can be used to end the session.

    • type

      string

      optional

      Possible values

      • system

Returns

• Websocket responses

  Name

  Type

  Req.

  body

  oneOf

  optional

  One of

  • object

    Object Properties

    • session_data

      object

      optional

      Object Properties

      • api_call_id

        string

        optional
  • object

    Object Properties

    • conversation_id

      object

      required

      Object Properties

      • conversation_id

        string

        optional
  • object

    Object Properties

    • delta

      object

      required

      Object Properties

      • delta

        string

        optional
  • object

    Object Properties

    • tool_output

      object

      optional

      Object Properties

      • result

        oneOf

        optional

        One of

        • text_to_cad

          object

          optional

          Object Properties

          • error

            string

            optional

          • outputs

            object

            optional

          • project_name

            string

            optional

          • status_code

            integer

            optional

          • type

            string

            optional

            Possible values

            • text_to_cad

        • edit_kcl_code

          object

          optional

          Object Properties

          • error

            string

            optional

          • outputs

            object

            optional

          • project_name

            string

            optional

          • status_code

            integer

            optional

          • type

            string

            optional

            Possible values

            • edit_kcl_code

        • mechanical_knowledge_base

          object

          optional

          Object Properties

          • response

            string

            optional

          • type

            string

            optional

            Possible values

            • mechanical_knowledge_base
  • object

    Object Properties

    • error

      object

      optional

      Object Properties

      • detail

        string

        optional
  • object

    Object Properties

    • info

      object

      optional

      Object Properties

      • text

        string

        optional
  • object

    Object Properties

    • project_updated

      object

      optional

      Object Properties

      • files

        object

        optional
  • object

    Object Properties

    • reasoning

      oneOf

      optional

      One of

      • text

        object

        optional

        Object Properties

        • content

          string

          optional

        • type

          string

          optional

          Possible values

          • text

      • markdown

        object

        optional

        Object Properties

        • content

          string

          optional

        • type

          string

          optional

          Possible values

          • markdown

      • kcl_docs

        object

        optional

        Object Properties

        • content

          string

          optional

        • type

          string

          optional

          Possible values

          • kcl_docs

      • kcl_code_examples

        object

        optional

        Object Properties

        • content

          string

          optional

        • type

          string

          optional

          Possible values

          • kcl_code_examples

      • feature_tree_outline

        object

        optional

        Object Properties

        • content

          string

          optional

        • type

          string

          optional

          Possible values

          • feature_tree_outline

      • design_plan

        object

        optional

        Object Properties

        • steps

          array

          optional

          Array of

          • edit_instructions

            string

            optional

          • filepath_to_edit

            string

            optional

        • type

          string

          optional

          Possible values

          • design_plan

      • generated_kcl_code

        object

        optional

        Object Properties

        • code

          string

          optional

        • type

          string

          optional

          Possible values

          • generated_kcl_code

      • kcl_code_error

        object

        optional

        Object Properties

        • error

          string

          optional

        • type

          string

          optional

          Possible values

          • kcl_code_error

      • created_kcl_file

        object

        optional

        Object Properties

        • content

          string

          optional

        • file_name

          string

          optional

        • type

          string

          optional

          Possible values

          • created_kcl_file

      • updated_kcl_file

        object

        optional

        Object Properties

        • content

          string

          optional

        • file_name

          string

          optional

        • type

          string

          optional

          Possible values

          • updated_kcl_file

      • deleted_kcl_file

        object

        optional

        Object Properties

        • file_name

          string

          optional

        • type

          string

          optional

          Possible values

          • deleted_kcl_file
  • object

    Object Properties

    • replay

      object

      optional

      Object Properties

      • messages

        array

        optional
  • object

    Object Properties

    • end_of_stream

      object

      optional

      Object Properties

      • completed_at

        string / ISO-8601

        optional

      • conversation_id

        string

        optional

      • id

        string / UUID

        optional

      • started_at

        string / ISO-8601

        optional

      • whole_response

        string

        optional