Skip to main content
  • Kontakt API Reference Manual
  • Welcome to the Kontakt Lua API Reference Manual

Welcome to the Kontakt Lua API Reference Manual

Welcome to the Kontakt Lua API reference manual. Kontakt Lua API is the technology which enables programmatic Kontakt instrument editing and creation workflow through a straightforward imperative approach, directly running within Kontakt itself.

This resource is a reference manual that covers every function, command, constant and other elements of the Kontakt Lua API. Where applicable, it also includes examples and short code snippets that demonstrate how a given function can be used. To learn more about Kontakt, refer to the Kontakt User Manual.

You can navigate this manual through the menu on the left, which groups elements of the API language in functions. Alternatively, if you are looking for a specific command you can use the search bar.

We hope you enjoy exploring the Kontakt Lua API!

What's New in Kontakt 7.8

New Features

Improved Features

  • When creating a resource container, typing .nkr extension is not required anymore.

  • When drag and dropping a Lua script onto Kontakt’s rack, it will now be listed in recently used scripts.

  • If there is an error when creating a resource container, dialog will not be created any longer, instead this information will be logged to the terminal.

Fixes

  • When creating a resource container, scripts from Resources/scripts folder would not be available to the builder for linking immediately.

  • When linking a script via set_instrument_script_linked_filename(), the script would not be applied.