API Reference

All endpoints, parameters, request/response formats, and error codes.

Base URL

https://api.ipfs.ninja

All requests require an API key via the X-Api-Key header. See Authentication for details.

Endpoints

Method	Path	Description	Page
POST	/upload/new	Upload a file to IPFS	Files
GET	/upload/list	List uploaded files	Files
GET	/file/:cid	Get file metadata by CID	Files
POST	/pin	Pin existing CID from IPFS network	Pinning
GET	/pin/:cid	Check pin status	Pinning
GET	/user/profile	Get user profile	Profile
POST	/apikeys	Create API key	API Keys
GET	/apikeys	List API keys	API Keys
DELETE	/apikeys/:key	Delete API key	API Keys
GET	/analytics	Usage analytics	Analytics
PUT	/gateway-settings	Update gateway settings	Gateways
POST	/gateway-tokens	Create gateway token	Gateways
GET	/gateway-tokens	List gateway tokens	Gateways
DELETE	/gateway-tokens/:prefix	Delete gateway token	Gateways
POST	/upload/signed-url	Generate signed upload token	Signed Tokens
GET	/signed-tokens	List signed tokens	Signed Tokens
DELETE	/signed-tokens/:tokenId	Revoke signed token	Signed Tokens
GET	/image/:cid	Optimize image on-the-fly	Image Optimization

S3-Compatible API

Use any AWS SDK to upload and manage files on IPFS Ninja. Point your S3 client at https://s3.ipfs.ninja with your API key as credentials.

https://s3.ipfs.ninja

S3 Operation	Description
PutObject	Upload a file to IPFS
GetObject	Download a file
HeadObject	Get file metadata
DeleteObject	Unpin and delete a file
ListObjectsV2	List files with prefix filtering
CreateMultipartUpload	Start a multipart upload (up to 5 GB)
UploadPart	Upload a part
CompleteMultipartUpload	Finish multipart upload
ListBuckets	List your gateways
CreateBucket	Create a gateway
DeleteBucket	Delete a gateway

See S3 Compatibility for full documentation, code examples, and migration guides.