Lynx Blockchain
  • Welcome
  • Technical Evolution and Architecture Overview
  • History of Lynx
    • Evolution of a Blockchain
    • Hybrid Proof of Work (HPoW) Protocol
    • Pioneering Blockchain Data Storage
    • Evolution to Proof of Stake
    • Next Generation Data Storage Architecture
    • Preserving Knowledge
  • Lynx Core
    • Hardware and System Requirements
    • Lynx Dynamics
    • Open Source
    • Core Parameters and Strategy
    • Sustainability
    • Circulating Supply Analysis
    • Locked Addresses
    • Data Storage
      • auth
      • fetch
      • fetchall
      • store
      • status
      • list
    • Understanding the Encryption Option
    • Understanding Lynx Staking Wait Times
    • Understanding Asset Retrieval Times
    • Understanding Block Time Targeting in the Lynx Blockchain
    • Understanding the Lynx Blockchain Statistics Report
  • Lynx Administration
    • Public Peer Nodes
    • Understanding Blockchain Bootstrap Files
      • Bootstrap Extraction Script
      • Bootstrap Creation Script
    • How to Sweep a Lynx Wallet
    • Enable/Disable Staking
  • Clevver
    • Revolutionizing Digital Preservation
    • Permanent Storage for Digital Assets
    • Permanent Digital Archives for Journalism
    • How did Clevver originate?
    • Shortened URL Support
    • Assigning Tags to Assets
    • How to delete content
    • Clevver Terms of Service Agreement
  • Clevver API
    • Public Methods
      • Batches
      • Files
      • User
  • ElectrumX
    • Lynx ElectrumX nodes
    • Build Script Details
  • External Links
    • Lynx Explorer
    • Lynx Github
    • Lynx Uptime Report
    • Clevver Website
  • Lynx Bootstraps
  • Wallet Links
    • Komodo Wallet
    • Wally.id Wallet
    • Lynx Paper Wallet
  • Social Links
    • Lynx Discord
    • Lynx on Bluesky
    • Clevver on Bluesky
  • Exchange Links
    • FreiXLite (LYNX/LTC)
  • FreiExchange (LYNX/BTC)
  • Komodo Wallet (SWAP)
  • XredX (LYNX/LTC)
  • XredX (LYNX/DOGE)
  • XredX (LYNX/IL8P)
Powered by GitBook
On this page
  • Get a list of unarchived files associated with your account.
  • Retrieve data about a specific file
  • Update a file
  • Archive a file
  • Unarchive a file
  1. Clevver API
  2. Public Methods

Files

Files stuff here.

Get a list of unarchived files associated with your account.

GET https://clevver.org/api/files

Query Parameters

Name
Type
Description

archived

Boolean

When true returns archived files (default: false)

filter

String

When 'untagged' returns only untagged files. (default: no filter.)

tags

String

A comma delimited list of tags

page

Integer

The page number to retrieve

{
    "data": [
        {
            "id": "95668cc0-1695-46cb-9a15-db16944e6f98",
            "user_id": 1,
            "name": "Monthly Report Jan 2024",
            "filename": "somefile.pdf",
            "file_size": 58404,
            "url": "https://get.clevver.org/4354c6f90a49ca0e1884be4226c56750f078ee74db53109ac6e5807425fbf30a.pdf",
            "forever_url": "https://clvr.ly/4354c6f90a49ca0e1884be4226c56750.pdf",
            "thumb_url": "/uploads/digital_asset/file/95668cc0-1695-46cb-9a15-db16944e6f98/thumb_365233683_214917471203265_1617498711144221366_n.png",
            "cdn_url": "https://clvr.ly/4354c6f90a49ca0e1884be4226c56750",
            "txid": "1dc65cefbb656fb124c6beed75cbe4c0218f94966c6e524911b03740730ea7b0",
            "content_type": "application/pdf",
            "status": "cached",
            "archived": false,
            "preview_type": "pdf",
            "created_at": "2024-01-24T05:26:54.172Z",
            "updated_at": "2024-01-25T04:42:43.458Z",
            "tags": ["report", "january", "2024"]
        }
    ],
    "meta": {
        "tags": ["report", "january", "2024", "december", "november", "2023"],
        "tag_counts": {
            "report": 3,
            "january": 1,
            "2024": 1,
            "december": 1,
            "november": 1,
            "2023": 2
        }
    },
    "pagination": {
        "total_entries": 1,
        "total_pages": 1,
        "current_page": 1,
        "next_page": null,
        "previous_page": null,
        "per_page": 10
    }
}

Retrieve data about a specific file

GET https://clevver.org/api/files/{file_id}

Path Parameters

Name
Type
Description

file_id*

String

The id of the file

{
    "message": "File loaded",
    "status": "success",
    "data": {
        "id": "95668cc0-1695-46cb-9a15-db16944e6f98",
        "user_id": 1,
        "name": "Monthly Report Jan 2024",
        "filename": "somefile.pdf",
        "file_size": 58404,
        "url": "https://get.clevver.org/4354c6f90a49ca0e1884be4226c56750f078ee74db53109ac6e5807425fbf30a.pdf",
        "forever_url": "https://clvr.ly/4354c6f90a49ca0e1884be4226c56750.pdf",
        "thumb_url": "/uploads/digital_asset/file/95668cc0-1695-46cb-9a15-db16944e6f98/thumb_365233683_214917471203265_1617498711144221366_n.png",
        "cdn_url": "https://clvr.ly/4354c6f90a49ca0e1884be4226c56750",
        "txid": "1dc65cefbb656fb124c6beed75cbe4c0218f94966c6e524911b03740730ea7b0",
        "content_type": "application/pdf",
        "status": "cached",
        "archived": false,
        "preview_type": "pdf",
        "created_at": "2024-01-24T05:26:54.172Z",
        "updated_at": "2024-01-25T04:42:43.458Z",
        "tags": ["report", "january", "2024"]
    }
}
{
    "error": "File not found",
    "status": "error",
    "data": []
}

Update a file

PUT https://clevver.org/api/{file_id}

Path Parameters

Name
Type
Description

file_id*

String

The id of the file to update

Query Parameters

Name
Type
Description

tags[]

String

An array of tags for the file

name

String

The name (title) of the file

{
    "message": "File updated",
    "status": "success",
    "data": {
        "id": "95668cc0-1695-46cb-9a15-db16944e6f98",
        "user_id": 1,
        "name": "Monthly Financial Report Jan 2024",
        "filename": "somefile.pdf",
        "file_size": 58404,
        "url": "https://get.clevver.org/4354c6f90a49ca0e1884be4226c56750f078ee74db53109ac6e5807425fbf30a.pdf",
        "forever_url": "https://clvr.ly/4354c6f90a49ca0e1884be4226c56750.pdf",
        "thumb_url": "/uploads/digital_asset/file/95668cc0-1695-46cb-9a15-db16944e6f98/thumb_365233683_214917471203265_1617498711144221366_n.png",
        "cdn_url": "https://clvr.ly/4354c6f90a49ca0e1884be4226c56750",
        "txid": "1dc65cefbb656fb124c6beed75cbe4c0218f94966c6e524911b03740730ea7b0",
        "content_type": "application/pdf",
        "status": "cached",
        "archived": false,
        "preview_type": "pdf",
        "created_at": "2024-01-24T05:26:54.172Z",
        "updated_at": "2024-01-25T04:42:43.458Z",
        "tags": ["report", "january", "2024", "finance"]
    }
}

Archive a file

PATCH https://clevver.org/apifiles/{file_id}/archive

Path Parameters

Name
Type
Description

file_id

String

The id of the file to archive

{
    "message": "File archived",
    "status": "success",
    "data": {
        "id": "95668cc0-1695-46cb-9a15-db16944e6f98",
        "user_id": 1,
        "name": "Monthly Report Jan 2024",
        "filename": "somefile.pdf",
        "file_size": 58404,
        "url": "https://get.clevver.org/4354c6f90a49ca0e1884be4226c56750f078ee74db53109ac6e5807425fbf30a.pdf",
        "forever_url": "https://clvr.ly/4354c6f90a49ca0e1884be4226c56750.pdf",
        "thumb_url": "/uploads/digital_asset/file/95668cc0-1695-46cb-9a15-db16944e6f98/thumb_365233683_214917471203265_1617498711144221366_n.png",
        "cdn_url": "https://clvr.ly/4354c6f90a49ca0e1884be4226c56750",
        "txid": "1dc65cefbb656fb124c6beed75cbe4c0218f94966c6e524911b03740730ea7b0",
        "content_type": "application/pdf",
        "status": "cached",
        "archived": true,
        "preview_type": "pdf",
        "created_at": "2024-01-24T05:26:54.172Z",
        "updated_at": "2024-01-25T04:42:43.458Z",
        "tags": ["report", "january", "2024"]
    }
}

Unarchive a file

PATCH https://clevver.org/apifiles/{file_id}/unarchive

Path Parameters

Name
Type
Description

file_id

String

The id of the file to unarchive

{
    "message": "File restored",
    "status": "success",
    "data": {
        "id": "95668cc0-1695-46cb-9a15-db16944e6f98",
        "user_id": 1,
        "name": "Monthly Report Jan 2024",
        "filename": "somefile.pdf",
        "file_size": 58404,
        "url": "https://get.clevver.org/4354c6f90a49ca0e1884be4226c56750f078ee74db53109ac6e5807425fbf30a.pdf",
        "forever_url": "https://clvr.ly/4354c6f90a49ca0e1884be4226c56750.pdf",
        "thumb_url": "/uploads/digital_asset/file/95668cc0-1695-46cb-9a15-db16944e6f98/thumb_365233683_214917471203265_1617498711144221366_n.png",
        "cdn_url": "https://clvr.ly/4354c6f90a49ca0e1884be4226c56750",
        "txid": "1dc65cefbb656fb124c6beed75cbe4c0218f94966c6e524911b03740730ea7b0",
        "content_type": "application/pdf",
        "status": "cached",
        "archived": false,
        "preview_type": "pdf",
        "created_at": "2024-01-24T05:26:54.172Z",
        "updated_at": "2024-01-25T04:42:43.458Z",
        "tags": ["report", "january", "2024"]
    }
}
PreviousBatchesNextUser

Last updated 11 months ago

Page cover image