Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/WyattBrashear/CLIF/llms.txt

Use this file to discover all available pages before exploring further.

CLIF provides a single user-data endpoint that returns account statistics for the authenticated user. Use it to display storage usage, check how close you are to your allocation limit, or surface account details in an integration.

​
POST /fetch-userdata

Return account information and storage statistics for the authenticated user.

​
Request parameters

​
user_id
string
required
Your unique user identifier, returned at registration.
​
pass_hash
string
required
SHA-256 hex digest of your password.

​
Response fields

​
status
string
required
"success" when credentials are valid and data is returned.
​
user_id
string
required
The authenticated user’s unique identifier.
​
user_name
string
required
The display name associated with this account.
​
allocation_limit
number
required
Maximum storage available to this user, in bytes. Set by the server administrator in CLIF.json. The default is 20000 bytes.
​
used_data
number
required
Total bytes currently consumed by the user’s stored files.
​
data_percent
number
required
Storage utilization as an integer percentage: (used_data / allocation_limit) * 100, truncated to a whole number.
data_percent is returned as an integer. A value of 6 means 6% of your allocation is in use, not 0.06.

​
Example

curl -X POST http://127.0.0.1:8000/fetch-userdata \
  -H "Content-Type: application/json" \
  -d '{
    "user_id": "YOUR_USER_ID",
    "pass_hash": "YOUR_PASS_HASH"
  }'
Success response
{
  "status": "success",
  "user_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "user_name": "alice",
  "allocation_limit": 20000,
  "used_data": 1234,
  "data_percent": 6
}

Build docs developers (and LLMs) love

Get started for freeTalk to us