Word JavaScript API overview

A Word add-in interacts with objects in Word by using the Office JavaScript API, which includes two JavaScript object models:

  • Word JavaScript API: These are the application-specific APIs for Word. Introduced with Office 2016, the Word JavaScript API provides strongly-typed objects that you can use to access objects and metadata in a Word document.

  • Common APIs: Introduced with Office 2013, the Common API can be used to access features such as UI, dialogs, and client settings that are common across multiple types of Office applications.

This section of the documentation focuses on the Word JavaScript API, which you'll use to develop the majority of functionality in add-ins that target Word on the web, or Word 2016 and later. For information about the Common API, see Common JavaScript API object model.

Learn programming concepts

See Word JavaScript object model in Office Add-ins for information about important programming concepts.

Learn about API capabilities

Use other articles in this section of the documentation to learn how to get the whole document from an add-in, use search options in your Word add-in to find text, and more. See the table of contents for the complete list of available articles.

For hands-on experience using the Word JavaScript API to access objects in Word, complete the Word add-in tutorial.

For detailed information about the Word JavaScript API object model, see the Word JavaScript API reference documentation.

Try out code samples in Script Lab

Use Script Lab to get started quickly with a collection of built-in samples that show how to complete tasks with the API. You can run the samples in Script Lab to instantly see the result in the task pane or document, examine the samples to learn how the API works, and even use samples to prototype your own add-in.

See also