Getting Started
Implementation Notes
🌐 REST API Information
URL: https://name.pulsr.ai/v1/getLabels/
Recommended:
- Max requests per second
100 - Max concurrent requests
1000
Supported Filetypes:
🖼️ How to get your art labeled
The Pulsr NAME API can automatically detect contents and characteristics for most image file types. The API accepts either raw image files or HTTPS/IPFS image links.
⌚️ When to label your NFTs
At some point prior to an NFT mint, run your NFT's image through NAME API to automatically generate labels that can be included in the metadata.
🎨 Where to store label info
The description property of NFT metadata is where bonus text such as these automatic labels shine brightest.
A line at the end of your NFT's description (ex: keywords: label-1, label-2, ...) can net you maximum search support across many platforms, aggregators and marketplaces.
🤌 Additional label notes
You may also opt to add the labels into an attribute of your NFT's attributes property and this can also improve search performance.
However, do avoid placement of labels in non-standard NFT properties as these are unlikely to be indexed or picked up by the NFT search engines.
🖌️ User curation
Always best to give your creators a chance to review, edit, and adjust automatic labels if possible. This is typically baked into the same UI where they can adjust other aspects of the metadata such as attributes, description, title, etc...
🤖 Automatic Curation
There are a few common cases where it is not possible to have the creator adjust labels. Such as generative art created on the fly or when there is a massive number of pieces to be minted >= 1000.
For situations like this, you may opt to only include labels with a very high confidence score. See API results for more info confidence score.