Batches
Clevver file storage works by creating batches which store one or more files on the block chain.
Get active batch jobs.
GET https://clevver.org/api/batches
The process of storing files on the blockchain can take some time and is an asynchronous process. This request will return a list of actively running batch storage jobs.
{
"status": "success",
"data": [
{
"id": "5c893d75-2a8b-4712-b56f-89377ac97681",
"status": "processing",
"progress": 10.3,
"created_at": "2023-11-01 13:53:12"
},
{
"id": "0adc8bf2-ec4a-415e-8074-cba50dd9e0b4",
"status": "processing",
"progress": 97,
"created_at": "2023-11-01 13:48:12"
},
]
}Create a new batch
POST https://clevver.org/api/batches
In order to store files on Clevver, you must first create a batch. Files can then be attached to the batch and later started by calling the start method.
{
"status": "success",
"data": {
"id": "5c893d75-2a8b-4712-b56f-89377ac97681",
"status": "created",
"progress": 0,
"created_at": "2023-11-01 13:53:12",
"message": "Batch created successfully"
}
}Start a storage job
POST https://clevver.org/api/batches/{batch_id}/start
Once a storage job has been created and files have been attached to it, you can then start the job. Starting the job will begin the process of storing the files onto the blockchain.
Path Parameters
batch_id*
String
The id of the batch
{
"status": "success",
"data": {
"id": "5c893d75-2a8b-4712-b56f-89377ac97681",
"status": "processing",
"progress": 0,
"created_at": "2023-11-01 13:53:12",
"message": "Batch job started"
}
}Get a storage job
GET https://clevver.org/api/batches/{batch_id}
You can query individual batches to check their status and/or progress.
Path Parameters
batch_id*
Strring
The id of the batch
{
"status": "success",
"data": {
"id": "5c893d75-2a8b-4712-b56f-89377ac97681",
"status": "delivered",
"progress": 100,
"created_at": "2023-11-01 13:53:12",
}
}Upload and attach a file to a batch
POST https://clevver.org/api/batches/{batch_id}/files
In order to store files on the block chain they must first be attached to a batch.
Path Parameters
batch_id*
String
The id of the batch
Request Body
file*
File
The file being uploaded
{
{
"message": "Asset successfully uploaded",
"status": "success",
"data": {
"id": "d37dffe9-60d5-4df4-ae0c-93bf42ac2137",
"status": "created",
"file": {
"url": "/uploads/digital_asset/file/d37dffe9-60d5-4df4-ae0c-93bf42ac2137/myphoto.png",
"thumb": {
"url": "/uploads/digital_asset/file/d37dffe9-60d5-4df4-ae0c-93bf42ac2137/thumb_myphoto.png"
}
},
"file_size": 1752887,
"estimated_cost": null,
"created_at": "2024-01-24T05:32:50.692Z",
"updated_at": "2024-01-24T05:32:50.692Z",
"txid": null,
"task_id": null,
"serialized_metadata": "{}",
"should_be_cached": true,
"stored_on": null,
"short_slug": null,
"checksum": "f604699904334d333b17b872b1183d22f604699904334d333b17b872b1183d22",
"user_id": 2,
"name": "myphoto.png",
"archived": false,
"duplicate": false,
"tag_list": []
}
}Last updated