(DEPRECATED) Apiary IPFS HTTP API description
API Blueprint
Clone or download


PSA - This specification is out of date, please use API Docs for a up to date reference.

We working towards generating Apiary compliant HTTP API documentation automatically and tests the different implementations to see if they are compliant. Until that happens, we have a docs generation tool that grabs the endpoints from go-ipfs and generates the documentation.

The tool is http-api-docs and generated docs are stored in the Website Repo

Apiary IPFS HTTP API description

standard-readme compliant

Apiary IPFS HTTP API description

Live API

This is the IPFS HTTP API spec, currently based on using the go-ipfs implementation. You can find the official API spec at the specs repo.


Go look at the Live API, or check out the apiary.apib source in this repository. If you would like to run the curl commands, please have an ipfs daemon running. For more on that, go to go-ipfs.


Feel free to join in. All welcome. Open an issue!

This repository falls under the IPFS Code of Conduct.

Want to hack on IPFS?