---
schema_version: "1"
id: 21342f11834a3bcd7591925d9e501c20e82f1416e1fbc1061a9d4202784e8503
title: Access Tableau Embedding API v3
collection: tableau
version: current
locale: en-us
portal_url: https://docs.salesforce.com/tableau/current/en-us/api/embedding_api/docs/embedding_api_get.md
canonical_url: https://help.tableau.com/current/api/embedding_api/en-us/docs/embedding_api_get.html
source_site: help.tableau.com
content_type: documentation
content_hash: 9493b105ca7f02dfe9bb1e85307d4e5bb61411036d10cc5a60fd64ee44cbcb29
description: Documentation for the Tableau Embedding API
---
# Access Tableau Embedding API v3
The Embedding API v3 library is available for use on Tableau Server, Tableau Cloud, Tableau Public, and on the Tableau CDN. To add the Embedding API to your web pages and applications, you simply link to the library. The Embedding API library and a React version of the library are also available as packages from npm.
The Embedding API library contains functions for interacting with the Embedding API. The Embedding API library is available in multiple versions. Each version of the library corresponds to a specific version of Tableau. Additionally, for each version of the Embedding API file, there is also a minified file (`.min`). You can use the minified file in production environments to reduce the amount of data that browsers must download.
## Versions of the Tableau Embedding API
The following table lists the Embedding API v3 library files and the corresponding versions of Tableau. For compatibility, you should use the version of the library that matches the version of Tableau you’re using.
| Tableau Version | Embedding API v3 Files | Availability |
| --- | --- | --- |
| 2026.2 | `tableau.embedding.3.15.0.min.js` | Tableau Cloud, Tableau Server |
| | `tableau.embedding.3.15.0.js` | |
| 2026.1 | `tableau.embedding.3.15.0.min.js` | Tableau Cloud (February 2026) |
| | `tableau.embedding.3.15.0.js` | |
| 2025.3 | `tableau.embedding.3.14.0.min.js` | Tableau Cloud, Tableau Server |
| | `tableau.embedding.3.14.0.js` | |
| 2025.2 | `tableau.embedding.3.13.0.min.js` | Tableau Cloud (June 2025) |
| | `tableau.embedding.3.13.0.js` | |
| 2025.1 | `tableau.embedding.3.12.0.min.js` | Tableau Cloud, Tableau Server |
| | `tableau.embedding.3.12.0.js` | |
| 2024.3 | `tableau.embedding.3.11.0.min.js` | Tableau Cloud (October 2024) |
| | `tableau.embedding.3.11.0.js` | |
| 2024.2 | `tableau.embedding.3.10.0.min.js` | Tableau Cloud, Tableau Server |
| | `tableau.embedding.3.10.0.js` | |
| 2024.1 | `tableau.embedding.3.9.0.min.js` | Tableau Cloud (February) |
| | `tableau.embedding.3.9.0.js` | |
| 2023.3.x | `tableau.embedding.3.8.0.min.js` | Tableau Cloud (December 2023) |
| | `tableau.embedding.3.8.0.js` | |
| 2023.3 | `tableau.embedding.3.6.0.min.js` | Tableau Cloud, Tableau Server |
| | `tableau.embedding.3.6.0.js` | |
| 2023.2 | `tableau.embedding.3.6.0.min.js` | Tableau Cloud |
| | `tableau.embedding.3.6.0.js` | |
| 2023.1 | `tableau.embedding.3.5.0.min.js` | Tableau Cloud, Tableau Server |
| | `tableau.embedding.3.5.0.js` | |
| 2022.4 | `tableau.embedding.3.4.0.min.js` | Tableau Cloud |
| | `tableau.embedding.3.4.0.js` | |
| 2022.3 | `tableau.embedding.3.3.0.min.js` | Tableau Cloud, Tableau Server |
| | `tableau.embedding.3.3.0.js` | |
| 2022.2 | `tableau.embedding.3.2.0.min.js` | Tableau Cloud |
| | `tableau.embedding.3.2.0.js` | |
| 2022.1 | `tableau.embedding.3.1.0.min.js` | Tableau Cloud, Tableau Server |
| | `tableau.embedding.3.1.0.js` | |
| 2021.4 | `tableau.embedding.3.0.0.min.js` | Tableau Cloud, Tableau Server |
| | `tableau.embedding.3.0.0.js` | |
You can access non-minified versions of the library by removing `.min` from the filename, for example, `tableau.embedding.3.6.0.js`. Use the non-minified version of the library during development as it can help when you need to debug your embedding code.
## Where to get the Embedding API v3 library
Starting with Tableau 2021.4, you can get the Embedding API v3 library from multiple locations, including Tableau Server, Tableau Cloud, Tableau Public, and the Tableau CDN (`https://embedding.tableauusercontent.com/`). Starting with Tableau 2024.1, you can get the Embedding API v3 library from npm.
As a general rule, you should always get the Embedding API v3 library from the same Tableau instance that hosts your visualizations. This ensures that you always use a version of the library that is compatible with the version of Tableau you’re using.
## Accessing the library on Tableau
For convenience, you can link to latest version of the library (`tableau.embedding.3.latest`) rather than the specific version for the release (3.0.0, 3.1.0, etc.). The file (`tableau.embedding.3.latest.min.js`, or `tableau.embedding.3.latest.js`) always points to the most recent release of the library on that instance of Tableau. The file (`tableau.embedding.3.latest.min.js`, or `tableau.embedding.3.latest.js`) is only available on Tableau Server, Tableau Cloud, and Tableau Public. If you use the Tableau CDN (`https://embedding.tableauusercontent.com/`), you need to link to the specific version of the file that you want to include.
Note that you cannot link to a local copy of the library (using `file://`), as it will cause Cross-Origin Resource Sharing (CORS) errors. You must link to the library on Tableau or the Tableau CDN, or on a server over HTTPS.
The Embedding API v3 library is a JavaScript ES6 module. To include the library in the HTML code for your web application, you need to set the `type` attribute to `module` in the `
```
Replace `my-server` with the name of your Tableau Server. For example, if your server is `www.example.com`, to use the Embedding API v3 library you would include this line in your HTML page:
```
```
For Tableau Cloud, use the following:
```
```
Replace `Tableau-Pod` with the name of your pod. For example, if your Tableau Pod is `10ax`, the URL would look like this:
```
```
For Tableau Public, use the following:
```
```
* * *
## Installing the npm package
Starting with Tableau Cloud (December 2023), the [Embedding API v3 library](https://www.npmjs.com/package/@tableau/embedding-api) is available from Node Package Manager (npm). Always use a version of the library that is compatible with the version of Tableau that hosts the view or metric. See [Versions of the Tableau Embedding API](#versions-of-the-tableau-embedding-api).
The following command installs the Embedding API v3 library in the `node_modules` folder of the current directory.
```dotnetcli
npm i @tableau/embedding-api
```
To install a specific version of the library, append `@` to the command. For example, to install the 3.12.1 library, use the command.
```dotnetcli
npm i @tableau/embedding-api@3.12.1
```
You can verify the installation by checking files in the `node_modules` folder (there should be a `@tableau` folder).
If a `package.json` file exists in the directory where you ran the npm command to install the package, and specifies the version of the library to use, the latest version of the library that satisfies the semantic versioning is installed. If no `package.json` exists, or no dependency for the library is specified, the latest version of the library is installed.
The following entry in the `package.json` file specifies the `3.12.1` library. The tilde (`~`) in front of the version number indicates that updates to the latest patched minor versions of that library can be used (that is, `3.12.*`). Be sure the version you use matches the version of the library used by the Tableau instance hosting the viz or metric. If you must lock it to a specific version or minor version, omit the tilde (`~`) or wildcard (`*`).
```
"dependencies": {
"@tableau/embedding-api": "~3.12.1"
}
```
### Import the npm package
In your JavaScript or TypeScript code, import the `TableauViz` object and any other classes and objects you need from the Embedding API v3 library. To simplify your code and improve load times, import just the classes you need, for example `TableauViz` to create the JavaScript object and `TableauEventType` to set an event listener. To import `TableauViz` and `TableauEventType`, use the following statement. Note that you import the library using the scoped package.
```
import { TableauViz, TableauEventType } from '@tableau/embedding-api';
```
If you import the library, which is an ES module, be sure to specify `"type": "module"` in your `package.json` file.
```
{
"name": "tableau-viz-demo",
"version": "0.1.0",
"private": true,
"type": "module",
"dependencies": {
"@tableau/embedding-api": "~3.12.1",
"etc. ....": "this example is not complete",
}
}
```
* * *
## Installing the React npm package
A [React version of the Embedding API v3 library](https://www.npmjs.com/package/@tableau/embedding-api-react) is available from Node Package Manager (npm). For information about installing and using the Tableau Embedding React package, see [Using the Tableau Embedding API React Components](/current/api/embedding_api/en-us/docs/embedding_api_react.html).
#### On This Page