Word JavaScript API requirement sets

Requirement sets are named groups of API members. Office Add-ins use requirement sets specified in the manifest or use a runtime check to determine whether an Office application supports APIs that an add-in needs. For more information, see Office versions and requirement sets.

Requirement set availability

Word add-ins run across multiple versions of Office, including Office 2016 or later on Windows, and Office on the web, iPad, and Mac. The following table lists the Word requirement sets, the supported Office client applications, and the minimum builds or versions for those applications where applicable.

Note

To use APIs in any of the numbered requirement sets, WordApiOnline, or WordApiHiddenDocument, you should reference the production library on the Office.js content delivery network (CDN).

For information about using preview APIs, see the Word JavaScript preview APIs article.

Requirement set Office on Windows
- Microsoft 365 subscription
- retail perpetual Office 2016 and later
Office on Windows
(volume-licensed perpetual)
Office on Mac Office on iPad Office on the web
Preview Please use the latest Office version to try preview APIs (you may need to join the Microsoft 365 Insider program)
WordApiOnline 1.1 Not applicable Not applicable Not applicable Not applicable Latest (see requirement set page)
WordApiHiddenDocument 1.5 (Desktop only) Version 2302 (Build 16130.20332) Not available 16.70 Not applicable Not applicable
WordApiHiddenDocument 1.4 (Desktop only) Version 2208 (Build 15601.20148) Not available 16.64 Not applicable Not applicable
WordApiHiddenDocument 1.3 (Desktop only) Version 1612 (Build 7668.1000) Office 2019: Version 1612 (Build 7668.1000) 15.32 Not applicable Not applicable
WordApi 1.7 Version 2311 (Build 17029.20068) Not available 16.79 Not available Supported
WordApi 1.6 Version 2308 (Build 16731.20234) Not available 16.76 16.76 Supported
WordApi 1.5 Version 2302 (Build 16130.20332) Not available 16.70 16.70 Supported
WordApi 1.4 Version 2208 (Build 15601.20148) Not available 16.64 16.64 Supported
WordApi 1.3 Version 1612 (Build 7668.1000) Office 2019: Version 1612 (Build 7668.1000) 15.32 2.22 Supported
WordApi 1.2 Version 1601 (Build 6568.1000) Office 2019: Version 1601 (Build 6568.1000) 15.19 1.18 Supported
WordApi 1.1 Version 1509 (Build 4266.1001) Office 2016: Version 1509 (Build 4266.1001) 15.19 1.18 Supported

Office versions and build numbers

For more information about Office versions and build numbers, see:

See also