API Keys

Blog

Community

Pinata Docs

Files SDK

IPFS SDK

API Reference

Pinata App

Support

Get an FID's storage limits.

Start uploading and retrieving content in no time

Quickstart

Next.js

React

SvelteKit

Astro

Remix

Node.js

LLM Docs

Workspaces

Billing

Limits

Uploading Files

File Groups

List & Query Files

Deleting Files

Retrieving Files

Key-Values

File Vectors (Beta)

Image Optimizations

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

Hot Swaps

The official CLI for the Files API written in Go

Files CLI

Pinning Files

Groups

Learn how to list files inside your Pinata account

Listing Files

Metadata & Options

Learn how to use Pinata to cryptographically sign CIDs

Signatures

Dedicated IPFS Gateways

Gateway Access Controls

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

Community SDKs

Getting Started

Config

testAuthenticaiton

list

update

delete

vectorize

queryVectors

deleteVectors

addSwap

getSwapHistory

deleteSwap

file

json

base64

createSignedURL

create

addFiles

removeFiles

requests

bandwidth

revoke

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

Create Signed Upload URL

List Files

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

Create Group

Get Group

List Groups

Add File To Group

Remove File From Group

Update Group

Delete Group

Add Swap

Get Swap History

Remove Swap

Create API Key

List API Keys

Revoke API Key

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

Update File Metadata

Delete File (Unpin)

Get a Group

Add CIDs to Group

Remove CIDs from a 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

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

Get Started

Account Management

Files

IPFS Files

Farcaster

Get an FID's storage limits.

Query Parameters

Response