Quickstart
Start uploading and retrieving content in no time
Getting Started with Pinata
Whether you’re brand new or a seasoned developer, Pinata makes it simple to store and retrieve content with speed and security. All you need to kick off your journey is a free Pinata account!
1. Get API key and Gateway URL
Inside the Pinata App select “API Keys” from the sidebar, then click “New Key” in the top right. We would recommend starting with Admin privileges and unlimited uses to start. You will receive a pinata_api_key, pinata_api_secret, and a JWT. The JWT is the most common authentication method and what we’ll be using below.
Next you will want to grab your Gateway domain by clicking the Gateways tab in the sidebar. You should see it listed in the format fun-llama-300.mypinata.cloud and you will want to copy it exactly like that.
2. Choose Your Setup
Pinata offers two different APIs you can choose from:
Public IPFS
The IPFS API has been Pinata’s bread and butter for over five years, and is specially designed to work with Web3 applications such a DeFi, NFTs, Gaming, and more! Keep in mind since IPFS is a peer-to-peer protocol, any files uploaded through this API will be public.
Private IPFS
Private IPFS keeps files private by default, where you can grant access to a file by generating temporary URLs. It’s great when you want to gate content behind an auth mechanism, whether that’s an auth provider or through decentralized technology.