Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Small File Uploads (POST)

Upload files up to 100MB using simple HTTP POST with multipart/form-data.

Endpoint

POST https://ipfs.pinner.xyz/api/upload

Content-Type

Use multipart/form-data with the file in the file field.

Form Fields

FieldTypeRequiredDescription
fileFileYesThe file to upload
namestringNoCustom display name

Query Parameters

ParameterTypeRequiredDescription
archive_modestringNoextract or preserve (archives only)

Request Headers

HeaderValueDescription
AuthorizationBearer TOKENYour API token

Examples

Basic upload:
curl -X POST "https://ipfs.pinner.xyz/api/upload" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@document.pdf"
With custom name:
curl -X POST "https://ipfs.pinner.xyz/api/upload" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@document.pdf" \
  -F "name=my-document"
Archive with extract mode:
curl -X POST "https://ipfs.pinner.xyz/api/upload?archive_mode=extract" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@archive.zip"
Archive with preserve mode:
curl -X POST "https://ipfs.pinner.xyz/api/upload?archive_mode=preserve" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "file=@archive.zip"

Response

{
  "id": "12345",
  "cid": "bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq",
  "name": "document.pdf",
  "size": 1048576,
  "mimeType": "application/pdf",
  "operationId": 12345
}

Limits

LimitValue
Max file size100MB
Supported formatsAny file type

See Also