Skip to main content

Provider API

The provider exposes a REST API on the configured port (default 3333):

EndpointMethodDescription
/api/v1/healthGETLiveness check
/api/v1/statusGETProvider status (disk usage, file count, chain sync)
/api/v1/filesGETPaginated list of stored files
/api/v1/files/:idGETMetadata for a single file
/api/v1/uploadPOSTMultipart upload — form fields fid (file ID) and file (binary data)
/api/v1/download/:idGETDownload a stored file by ID

The upload endpoint validates that the fid corresponds to a file staged on-chain before accepting the data.