--- title: 🔩  Topia Public API description: Advanced programmatic tools at your fingertips! --- [Skip to content](https://resources.topia.io/topia-public-api#main-content) [![Topia Logo](https://22253251.fs1.hubspotusercontent-na1.net/hub/22253251/hubfs/Topia%20Logo.png?width=150&height=82&name=Topia%20Logo.png)](https://topia.io/) - [Resources Home](https://resources.topia.io/) Open main navigation Close main navigation - [Resources Home](https://resources.topia.io/) - [Contact Support](mailto:support@topia.io) [Contact Support](mailto:support@topia.io) How can we help you? - There are no suggestions because the search field is empty. 1. [Topia Resources](https://resources.topia.io/?hsLang=en) 2. [Customize Your World](https://resources.topia.io/customize-your-world?hsLang=en) 3. [Make Your World Interactive](https://resources.topia.io/customize-your-world?hsLang=en#make-your-world-interactive) # 🔩  Topia Public API ## Advanced programmatic tools at your fingertips! ![circleCheck](https://22253251.fs1.hubspotusercontent-na1.net/hubfs/22253251/Latest%20UI%20Icons%20-%202025/circleCheck.svg)[Public API](https://resources.topia.io/topia-public-api#public-API) ![circleCheck](https://22253251.fs1.hubspotusercontent-na1.net/hubfs/22253251/Latest%20UI%20Icons%20-%202025/circleCheck.svg) [Generate an API Key](https://resources.topia.io/topia-public-api#generate-API-key) ![circleCheck](https://22253251.fs1.hubspotusercontent-na1.net/hubfs/22253251/Latest%20UI%20Icons%20-%202025/circleCheck.svg) [Custom Applications using Topia's SDK](https://resources.topia.io/topia-public-api#SDK) ![circleCheck](https://22253251.fs1.hubspotusercontent-na1.net/hubfs/22253251/Latest%20UI%20Icons%20-%202025/circleCheck.svg) [Interactive Key Pairs](https://resources.topia.io/topia-public-api#interactive-key-pairs)   ---   ### **Public API** This goes out to all of our World Builders, Makers, and Dreamers who want to build beyond what is currently possible in Topia. Our Public API has a plethora of programmatic goodies, including API calls for Media, Whitelisting, Scenes, Assets, and much much more! A world of engineering-driven customization is now at your fingertips. We can't wait to see what you make. Head on over to the link below to experience our Public API. **[Topia Public API Documentation](https://api.topia.io/api-docs/)** ![](https://22253251.fs1.hubspotusercontent-na1.net/hub/22253251/hubfs/Knowledge%20Base%20Import/downloads.intercomcdn.comio476964913ef2c897129a766d840fd1b4aTopia+Public+API.png?width=600&height=245&name=downloads.intercomcdn.comio476964913ef2c897129a766d840fd1b4aTopia+Public+API.png)   ---   ### **API Key Generator** The final puzzle piece is in place to programmatically unleash Topia experiences never before seen by both Topis and humans alike: the ability to generate an API Key granting you keys to your virtual kingdom! ##### **Generate an API Key:** 1. ​Go to**[Topia Dashboard](https://topia.io/t/dashboard)** 2. Select ![trigger](https://22253251.fs1.hubspotusercontent-na1.net/hubfs/22253251/Latest%20UI%20Icons%20-%202025/trigger.svg) **Integrations** 3. Click the **Generate New API Key button** to get a key   ---   ### **Software Development Kit (SDK)** The Topia Client Library leverages the Topia Public API and allows users to interact with the Topia systems and modify their world programmatically. With the SDK, you can now build custom middleware features for Topia! All of the documentation about the SDK can be found on the [Topia dashboard](https://topia.io/t/dashboard/integrations).    ---   ### **Interactive Key Pairs** Interactive key pairs (public and private) allow users to develop custom middleware applications or use “interactive” (middleware integrated) scenes acquired from Marketplace without needing the world owner's API key. The private key should be added to middleware applications to initialize an instance of the Topia SDK.   ##### **Create a Key Pair:** 1. Go to**[Topia Dashboard](https://topia.io/t/dashboard)** 2. Select ![trigger](https://22253251.fs1.hubspotusercontent-na1.net/hubfs/22253251/Latest%20UI%20Icons%20-%202025/trigger.svg) **Integrations** 3. In the *Interactive Key Pairs* section, click **Add Key Pair**   ##### **To Implement the Key:** 1. Enter Topia World 2. Locate the asset you want to use for your application  3. Click **Builder Mode ![builder](https://22253251.fs1.hubspotusercontent-na1.net/hubfs/22253251/Latest%20UI%20Icons%20-%202025/builder.svg)** on the left sidebar 4. Click ![edit](https://22253251.fs1.hubspotusercontent-na1.net/hubfs/22253251/Latest%20UI%20Icons%20-%202025/edit.svg) **edit** on the asset to open the *Select Drawer* 5. Click the **Configuration** tab then select** Integrations** 6. Under *Developer Configuration:* - Toggle on **Add player session credentials** - Add the public key to the **Developer Public Key** field   - [Getting Started](https://resources.topia.io/getting-started?hsLang=en#main-content) - [Using Topia](https://resources.topia.io/getting-started?hsLang=en#using-topia) - [Socializing](https://resources.topia.io/getting-started?hsLang=en#socializing) - [Navigating the Toolbar](https://resources.topia.io/getting-started?hsLang=en#navigating-the-toolbar) - [Customize Your World](https://resources.topia.io/customize-your-world?hsLang=en#main-content) - [Building Your World](https://resources.topia.io/customize-your-world?hsLang=en#building-your-world) - [Scenes & Scene Marketplace](https://resources.topia.io/customize-your-world?hsLang=en#scenes-scene-marketplace) - [Advanced Building Techniques](https://resources.topia.io/customize-your-world?hsLang=en#advanced-building-techniques) - [Make Your World Interactive](https://resources.topia.io/customize-your-world?hsLang=en#make-your-world-interactive) - [External Add On Widgets & Embeds](https://resources.topia.io/customize-your-world?hsLang=en#external-add-on-widgets-embeds) - [World Settings](https://resources.topia.io/world-settings?hsLang=en#main-content) - [Customize World Layout & Location](https://resources.topia.io/world-settings?hsLang=en#customize-world-layout-location) - [Update Your World Settings](https://resources.topia.io/world-settings?hsLang=en#update-your-world-settings) - [Troubleshooting](https://resources.topia.io/troubleshooting?hsLang=en) [![Topia Logo](https://22253251.fs1.hubspotusercontent-na1.net/hub/22253251/hubfs/Topia%20Logo.png?width=150&height=82&name=Topia%20Logo.png "Topia Logo")](https://topia.io/) Go to [topia.io](https://topia.io/) [mailto:support@topia.io](mailto:support@topia.io) Copyright © 2025, Topia Interactive, Inc.