Skip to content
darkblock-logo
Darkblock Docs
  • Pages
    • What is Darkblock?
      • How does it work?
        • Creating a darkblock
        • Viewing Darkblock content
      • The Darkblock Protocol
      • Supported Blockchains
      • HIDEME Sample NFT with Darkblocks
    • For Creators
    • Products
      • The Darkblock API
      • The Darkblock Viewer
      • The Upgrader
      • The Darkblock Web App
      • The Darkblock TV App
    • Features
      • NFT Upgrades
      • Collection Upgrades
      • Content Stacking
      • Editing Metadata
      • Send to Kindle
    • Use Cases
      • Comics and Books
      • Movies
      • Content Creation
      • PFPs
      • Gamified Experiences
    • Developer Integration
      • Getting Started
      • The Darkblock API Overview
        • Get an API Key
      • Embed Darkblocks into any website
        • NPM
          • Ethereum
          • Polygon
          • Solana
          • Tezos
          • Avalanche
          • Customization
      • Direct Integration
      • HIDEME UGC (User Generated Content)
      • Content Monetization
        • Subscriptions using Unlock Protocol
        • Content Rental with Unlock Protocol
    • Help / Support
      • Terminology
      • Help, I made a mistake!
    • Tutorials
      • Unlockable Party Pack
darkblock-logo
Darkblock Docs
/
/
The Darkblock API Overview

The Darkblock API Overview

Get an API Key
The Darkblock API enables you to create Darkblock unlockable content and build products that enable your users to do the same.
⁠
Check out the Darkblock API Swagger docs
⁠
⁠
⁠
Make sure you get an API Key!
⁠
⁠

Create darkblocks
​
⁠
⁠

NFT Upgrades
​
⁠
⁠
For adding content to pre-existing NFTs (NFT upgrades) you can use the
mintDarkblockUpgrade
⁠
API directly.
Collection Upgrades
​
⁠
⁠
Multiple NFTs can be upgraded at the same time by using the
mintDarkblockUpgradeCollection
⁠
API endpoint. Traits or token ranges within collections can also be targeted.
Forward Lookup (advanced)
​
⁠
⁠
If you want to create the Darkblock first, and embed the Darkblock-ID in the NFT metadata you can use the
mintDarkblock
⁠
API.

Accessing and viewing darkblocks
​
⁠
⁠

You can either use our
embeddable Darkblock Viewer
⁠
to enable access to Darkblock content, or you can bring your own viewer, or enable native integration using
direction integration
⁠
.
Want to print your doc?
This is not the way.
Try clicking the ··· in the right corner or using a keyboard shortcut (
CtrlP
) instead.