Introduction

PinArkive API Documentation

Upload, pin and manage IPFS content using clusters and gateways.

Base URL

https://api.pinarkive.com/api/v3

Use this base for all API requests.

Authentication

All requests require an API key (or Bearer token). Send it in the header:

Header example:

X-API-Key: YOUR_API_KEY

Or:

Authorization: Bearer YOUR_API_KEY

See Authentication for details and Quick Start to get started in under 2 minutes.

Quick Start

Get from zero to your first upload in four steps:

  1. Create account — Sign up at pinarkive.com (opens in a new tab)
  2. Generate API key — Dashboard → API Keys, scope files:write
  3. Upload a file — POST /files with multipart form data
  4. Get CID — Response includes cid; use it at https://gateway.pinarkive.com/ipfs/<cid>

Quick Start →

Files API

EndpointDescription
Upload fileUpload a file (multipart)
Upload directoryUpload multiple files
PinPin an existing CID
List filesList your uploads
Delete fileRemove a pin
Get clustersList clusters and gateways

View all endpoints →

Examples

AppDescriptionLink
Upload PlaygroundDrag-and-drop file uploadssample1.pinarkive.com (opens in a new tab)
Encrypted ShareSecure, time-limited sharingsample2.pinarkive.com (opens in a new tab)
API PlaygroundTest API in the browserplayground.pinarkive.com (opens in a new tab)

Quick links: pinarkive.com (opens in a new tab) · GitHub (opens in a new tab)

Quick Start