API → MLOpen a websocket to prompt the ML copilot

Parameters

• 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

    • project_name

      string

      optional

    • 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

  • delta

    object

    required

    Object Properties

    • delta

      string

      optional

    • type

      string

      optional

      Possible values

      • delta

  • 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

    • type

      string

      optional

      Possible values

      • tool_output

  • error

    object

    optional

    Object Properties

    • detail

      string

      optional

    • type

      string

      optional

      Possible values

      • error

  • info

    object

    optional

    Object Properties

    • text

      string

      optional

    • type

      string

      optional

      Possible values

      • info

  • reasoning

    object

    optional

    Object Properties

    • text

      string

      optional

    • type

      string

      optional

      Possible values

      • reasoning

  • end_of_stream

    object

    optional

    Object Properties

    • type

      string

      optional

      Possible values

      • end_of_stream

    • whole_response

      string

      optional