Pinata
docs.pinata.cloud
Developer ToolsAdd file uploads and retrieval in minutes so you can focus on your app — because you’ve got better things to code than infrastructure.
llms.txt
Pinata Docs
Docs
- API Keys
- Billing
- Limits
- Webhooks: Subscribe to Pinata API events using Webhooks
- Workspaces
- HTTP API: Authenticate, manage agents, and talk to gateways over HTTP
- Channels: Let people talk to your agent on Telegram, Slack, or Discord
- Chat: Talk to your agent through the web interface
- Concepts: Terms, file layout, and how the pieces fit together
- Console: A real terminal inside your agent's container
- Danger: Full agent inventory, plus restart and delete
- Error Reference: Look up an API error code and how to resolve it
- Issues & Boards: Assign work to agents on a kanban board, review the diff, ship it
- Logs: Stream your agent engine's output in real time
- Manifest Reference: Every field in manifest.json, the source of truth for an agent's configuration
- Models: Pick which AI models this agent can use
- Overview: Hosted AI agents that can run code, manage files, and connect to other services
- Domains & Routes: Expose web services from inside your agent to the internet
- Secrets: Where API keys and credentials live
- Skills: Reusable capability packages you can attach to an agent
- Files & Snapshots: Browse, version, and edit your agent's workspace
- Tasks: Run prompts on a schedule
- Creating Templates: Share your agent configuration as a template
- Templates: Deploy pre-configured agents in one click
- Troubleshooting: What to check when your agent isn't behaving
- Add File To Group:
org:groups:write - Add Signature to CId:
org:files:write - Add Swap:
org:files:write - Cancel Request:
org:files:write - Create Group:
org:groups:write - Create Signed Upload URL:
org:files:write - Delete File by ID:
org:files:write - Delete File Vectors:
org:write - Delete Group:
org:groups:write - Get File by ID:
org:files:read - Get Group:
org:groups:read - Get Signature for a CID:
org:files:read - Create Download Link:
org:files:write - Get Swap History:
org:files:read - Create Custom Domain for Gateway:
org:gateways:write - Create Gateway:
org:gateways:write - Create Gateway Host Origin Restriction:
org:gateways:write - Create Gateway IP Address Restriction:
org:gateways:write - Create Gateway Key Restriction:
org:gateways:write - Delete Gateway:
org:gateways:write - Delete Gateway Custom Domain:
org:gateways:write - Gateway Custom Domain Details:
org:gateways:read - Gateway Details:
org:gateways:read - Gateway Domain Available:
org:gateways:read - Get Marketplace Plugin Details:
org:gateways:read - Install Gateway Plugin:
org:gateways:write - List Gateway Plugins:
org:gateways:read - List Gateways:
org:gateways:read - List Installed Plugins for Gateway:
org:gateways:read - List Marketplace Plugins:
org:gateways:read - Revoke Gateway Key:
org:gateways:write - Revoke Host Origin Restriction:
org:gateways:write - Revoke IP Address Restricton: `org:gateways:write:
- Time Interval Gateway Analytics:
org:analytics:read - Top Gateway Analytics:
org:analytics:read - Uninstall Gateway Plugin:
org:gateways:write - List Files:
org:files:read - List Groups:
org:groups:read - Pin by CID:
org:files:write - Query File Vectors:
org:write - Query Pin Requests:
org:files:read - Remove File From Group:
org:groups:write - Remove Signature from CID:
org:files:write - Remove Swap:
org:files:write - Update File:
org:files:write - Update Group:
org:groups:write - Upload a File:
org:files:write - Create API Key:
org:write - List API Keys:
org:write - Revoke API Key:
org:write - Vectorize a File:
org:write - Add CID to Payment Instruction: Associates a CID with a payment instruction
- List CIDs for Payment Instruction: Returns a paginated list of CIDs associated with a payment instruction
- Remove CID from Payment Instruction: Removes a CID association from a payment instruction
- Create Payment Instruction: Creates a new payment instruction
- Delete Payment Instruction: Deletes a payment instruction (soft delete). All CID mappings must be deleted first.
- Get Payment Instruction: Retrieves a specific payment instruction by ID
- List Payment Instructions: Returns a paginated list of payment instructions
- Update Payment Instruction: Updates an existing payment instruction
- Upload a File: Uploads a file to Pinata's public IPFS network
- Retrieve a Private File: Retrieves a private file from IPFS by its CID
- Introduction: Getting started with the Pinata API
- Deleting Files
- Groups
- Key-Values
- List & Query Files
- MPP Server: Account-free IPFS uploads and downloads using crypto payments via the Machine Payments Protocol
- Quick Start: Upload and download files from IPFS using the MPP Server
- Self-Hosting: Deploy your own MPP Server on Cloudflare Workers
- Collections: View your NFT collections and their IPFS CIDs
- Overview: Backup your NFT collections to Pinata
- Sync: Pin your NFT CIDs to Pinata
- Wallets: Add wallets to backup your NFT collections
- Presigned URLs
- Private IPFS
- Signatures: Learn how to use Pinata to cryptographically sign CIDs
- Uploading Files
- File Vectors (Beta)
- Introduction
- Accessing Paid Content
- Payment Instructions Guide
- Quick Start
- x402 Services
- Astro: Get started using Pinata with Astro
- Hono
- Next.js: Get started using Pinata with Next.js
- Node.js
- React
- Remix: Get started using Pinata with Remix
- SvelteKit
- Dedicated IPFS Gateways
- Gateway Access Controls
- Image Optimizations
- Content Addressable: Use the Content Addressable plugin to include CID signatures
- Getting Started: Learn how to use Dedicated Gateway plugins to supercharge your IPFS delivery system
- Hot Swaps: Use the Hot Swaps plugin to make one CID map to another
- Retrieving Files
- How does IPFS work with NFTs?
- What are CIDs?
- What are IPFS Gateways?
- What is IPFS?
- What is Pinning?
- LLM Docs
- Quickstart: Start uploading and retrieving content in no time
- bandwidth:
org:analytics:read - requests:
org:analytics:read - Config
- addSwap:
org:files:write - delete:
org:files:write - deleteSwap:
org:files:write - deleteVectors:
org:files:write - getSwapHistory:
org:files:read - list:
org:files:read - queryVectors:
org:files:write - update:
org:files:write - vectorize:
org:files:write - addSwap:
org:files:write - delete:
org:files:write - deleteSwap:
org:files:write - getSwapHistory:
org:files:read - list:
org:files:read - queue:
org:files:read - update:
org:files:write - createAccessLink:
org:files:write - get:
org:files:write - convert
- get
- Getting Started: Get up and running with the Pinata IPFS SDK
- addFiles:
org:groups:write - create:
org:groups:write - delete:
org:groups:write - get:
org:groups:read - list:
org:groups:read - removeFiles:
org:groups:write - update:
org:groups:write - addFiles:
org:groups:write - create:
org:groups:write - delete:
org:groups:write - get:
org:groups:read - list:
org:groups:read - removeFiles:
org:groups:write - update:
org:groups:write - create:
org:write - list:
org:write - revoke:
org:write - React Hooks: A collection of React hooks to use with Pinata
- add:
org:files:write - delete:
org:files:write - get:
org:files:read - add:
org:files:write - delete:
org:files:write - get:
org:files:read - Analytics
- Config
- Files
- Gateways
- Groups
- Keys
- Signatures
- Uploads
- x402
- base64:
org:files:write - createSignedURL:
org:files:write - file:
org:files:write - json:
org:files:write - url:
org:files:write - base64:
org:files:write - cid:
org:files:write - createSignedURL:
org:files:write - file:
org:files:write - fileArray:
org:files:write - json:
org:files:write - url:
org:files:write - V2 Migration Guide
- add
- list
- remove
- x402 Monetization
- create
- delete
- get
- list
- update
- Agents CLI: Create, manage, and interact with AI agents from the command line
- IPFS: Upload and manage files, groups, gateways, keys, and swaps
- CLI Overview: The official CLI for Pinata written in Go
- Community SDKs
- Quickstart: Register your first AI agent on-chain using ERC-8004 and Pinata
- Services & IPFS: Service endpoint types and IPFS usage in ERC-8004 agents
- Overview: Use the Pinata MCP server to give AI assistants access to IPFS file storage
- Tools Reference: Complete reference for all Pinata MCP server tools
- Pinata Expo Hooks: A collection of Expo compatible hooks to use with Pinata
OpenAPI Specs
- pinata-x402-api-v3
- pinata-api-v3
- pinata-api-v3-uploads
- pinata-x402-api-v1
- pinata-api-ipfs
- pinata-farcaster-api-030924
- pinata-farcaster-api-030724
Optional
Related
Meet the modern standard for public facing documentation. Beautiful out of the box, easy to maintain, and optimized for user engagement.
/llms.txt
5,436 tokens
/llms-full.txt
181,290 tokens
Developer Tools
Search through billions of items for similar matches to any object, in milliseconds. It’s the next generation of search, an API call away.
/llms.txt
15,715 tokens
/llms-full.txt
588,629 tokens
Developer Tools
Build and deploy reliable background jobs with no timeouts and no infrastructure to manage.
/llms.txt
12,202 tokens
/llms-full.txt
387,586 tokens
Developer Tools
Get the simple developer experience of SQLite in production, and scale your multi-tenant backend with unlimited databases.
/llms.txt
10,006 tokens
/llms-full.txt
163,317 tokens
Developer Tools
Upstash is a serverless data platform providing low latency and high scalability for real-time applications.
/llms.txt
52,307 tokens
/llms-full.txt
1,200,134 tokens
Developer Tools
One-click deployments built for teams, tuned for Laravel, loaded with tools and goodies you're going to love.
/llms.txt
565 tokens
/llms-full.txt
11,330 tokens
Developer Tools