Page cover image

Public Methods

Clevver file storage works by creating Jobs 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

NameTypeDescription

*

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's status

GET https://clevver.org/api/batches/{batch_id}

You can query individual batches to check their status and/or progress.

Path Parameters

NameTypeDescription

*

String

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",
  }
}

Last updated