Pinata Docs

Start uploading and retrieving content in no time

Quickstart

LLM Docs

API Keys

Workspaces

Subscribe to Pinata API events using Webhooks

Webhooks

Billing

Limits

Uploading Files

List & Query Files

Deleting Files

Retrieving Files

Groups

Key-Values

Private IPFS

File Vectors (Beta)

Learn how to use Pinata to cryptographically sign CIDs

Signatures

The official CLI for Pinata written in Go

IPFS CLI

Dedicated IPFS Gateways

Gateway Access Controls

Image Optimizations

Community SDKs

Get up and running with the Private IPFS SDK

Getting Started

V2 Migration Guide

Config

testAuthenticaiton

requests

bandwidth

create

list

revoke

Uploads

Files

Gateways

Analytics

Keys

Next.js

React

SvelteKit

Astro

Remix

Node.js

Pinning Files

Learn how to list files inside your Pinata account

Listing Files

Metadata & Options

What is IPFS?

What is Pinning?

What are CIDs?

What are IPFS Gateways?

How does IPFS work with NFTs?

Pinata SDK  (Archived)

Next.js Starter

Pinata IPFS CLI

Pinata Raycast Extension

Private Groups

Use the Hot Swaps plugin to make one CID map to another

Hot Swaps

The official CLI for the Private IPFS API written in Go

Private IPFS CLI

update

delete

vectorize

queryVectors

deleteVectors

addSwap

getSwapHistory

deleteSwap

file

json

base64

createSignedURL

addFiles

removeFiles

Types

listFiles

pinJobs

unpin

updateMetadata

fileArray

stream

convert

swapCid

swapHistory

topUsageAnalytics

dateIntervalAnalytics

addCids

removeCids

pinnedFileCount

totalStorageSize

Introduction

Test your API keys and your ability to connect to the Pinata API

Test Authentication

Upload a file to Pinata to be pinned to IPFS

Pin File to IPFS

Uploads a JSON object to Pinata and pins it to IPFS

Pin JSON

List all the files on your Pinata account

List Files

Update File Metadata

Delete File (Unpin)

Create Group

Get a Group

List Groups

Update Group

Add CIDs to Group

Remove CIDs from a Group

Delete Group

Upload a file already on the IPFS network to Pinata

Pin By CID

List all currently running pinByHash jobs

List Pin By CID Jobs

Pinning Service API

Create Signed Upload URL

Get File by ID

Create Signed URL

Update File

Delete File by ID

Vectorize an existing file. File must already be part of a group.

Vectorize a File

Query File Vectors

Delete file vectors for an existing file.

Delete File Vectors

Get Group

Add File To Group

Remove File From Group

Add Swap

Get Swap History

Remove Swap

Create API Key

List API Keys

Revoke API Key

Get Signature for a CID

Add Signature to CId

Remove Signature from CID

List Gateways

Gateway Details

Gateway Domain Available

Create Gateway

Delete Gateway

Gateway Custom Domain Details

Create Custom Domain for Gateway

Delete Gateway Custom Domain

Create Gateway Key Restriction

Create Gateway IP Address Restriction

Create Gateway Host Origin Restriction

Revoke Gateway Key

Revoke IP Address Restricton

Revoke Host Origin Restriction

Top Gateway Analytics

Time Interval Gateway Analytics

List Marketplace Plugins

Get Marketplace Plugin Details

List Installed Plugins for Gateway

Install Gateway Plugin

List Gateway Plugins

Uninstall Gateway Plugin