docs: document the cid_version upload option and unixfs-v1-2025 profile - #113
Merged
Conversation
The v3 uploads API accepts a cid_version option (v0, v1, unixfs-v1-2025) that selects the UnixFS import profile used to hash an upload, but none of it was documented. - Add a "CID Version" section to the uploading files guide: profile comparison table, kubo equivalents, how to pass the option on form-data, resumable (TUS) and signed-URL uploads, and the folder-sharding caveat for unixfs-v1-2025. - Add cid_version to POST /files and POST /files/sign in the uploads OpenAPI spec so it shows up in the API reference. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
obo20
approved these changes
Aug 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The v3 uploads API accepts a
cid_versionoption that selects the UnixFS import profile used to hash an upload —v0,v1(default) and, since files-v3#415,unixfs-v1-2025(IPIP-499). None of it was documented.files/uploading-files.mdx): new "CID Version" section under How to Upload Files with a profile comparison table (CID format, leaf encoding, chunk size, max links,ipfs addequivalent), when to reach for each, and how to pass the option on form-data, resumable (TUS) and signed-URL uploads.pinata-api-v3-uploads.yaml):cid_versionadded toPOST /files(multipart form field) andPOST /files/sign(JSON body), so it renders in the endpoint pages.Notes
unixfs-v1-2025's wider chunk/link settings apply to file DAGs; directory shard settings are unchanged, so folder uploads large enough to shard (~2,000+ entries) may not match atest-cid-v1-widekubo import. That is the current server behaviour.cidVersion()type is still"v0" | "v1", so the SDK example usesv0and a tip points to the API forunixfs-v1-2025. Worth a follow-up inpinata-sdkto widen the type.🤖 Generated with Claude Code