API Documentation

UploadHub CDN is a fast file hosting and content delivery network (CDN) designed for FiveM servers. You upload images, video, and audio through a simple HTTP API, and we store, scan, and serve them from a global edge network at https://cdn1.uploadhub.gg.

How to get a token: log in to the dashboard, open the project you want, and go to the API Keys tab (dashboard → project → API Keys). Generate a new token, you will see the full value only once, so store it somewhere safe.

Token security: the token grants full access to uploading and managing files in the project. Use it only server-side (e.g. in a server-side FiveM resource or in your backend). Never place the token in client code, in the browser, or in public repositories. If the token leaks, revoke it in the dashboard immediately and generate a new one.

Every API request must include a token. Pass it in the Authorization header as a raw value - without the "Bearer" prefix:

Authorization: uph_your_api_token

Alternatively, you can pass the token as a ?apiKey= query parameter (useful in environments that don't let you set a header):

https://uploadhub.gg/api/v3/file?apiKey=uph_your_api_token

Base URL for all endpoints:

https://uploadhub.gg

All success responses share a consistent shape { "data": { ... }, "status": "ok" }. Below is the list of available endpoints:

curl: multipart upload

curl -X POST "https://uploadhub.gg/api/v3/file" \
  -H "Authorization: uph_your_api_token" \
  -F "file=@./clip.webp" \
  -F 'metadata={"name":"clip"}'

curl: base64 upload (JSON)

curl -X POST "https://uploadhub.gg/api/v3/file/base64" \
  -H "Authorization: uph_your_api_token" \
  -H "Content-Type: application/json" \
  -d '{
    "base64": "iVBORw0KGgoAAAANSU...",
    "filename": "clip.webp",
    "metadata": { "name": "clip" }
  }'

FiveM: the uploadhub resource. In FiveM server scripts, use the uploadhub resource and its exports. You configure it through the convars uploadhub_api_base (the API base URL) and UPLOADHUB_MEDIA_API_KEY (the API token, kept server-side).

# server.cfg
set uploadhub_api_base "https://uploadhub.gg"
set UPLOADHUB_MEDIA_API_KEY "uph_your_api_token"

Lua: capture a player's screenshot

-- Server-side: capture an image from the player's screen and send it to the CDN
exports.uploadhub:takeServerImage(source, { name = 'clip' }, function(url, id)
    if url then
        print(('Uploaded screenshot: %s (id=%s)'):format(url, id))
    else
        print('Upload failed')
    end
end)

Lua: upload base64 data

-- Server-side: send ready-made base64 data
exports.uploadhub:upload({ base64 = data, filename = 'x.webp' }, function(ok, url)
    if ok then
        print('File URL: ' .. url)
    else
        print('Upload failed')
    end
end)

Each project has its own rate (burst) limit of roughly 60 requests per second. Once it is exceeded, requests return a 429 code, apply exponential backoff and retry.

Error codes. Error responses have the shape { "status": "error", "message": "...", "code": "..." }:

Block on plan overage. We don't offer paid overage, once a plan limit is used up (storage, bandwidth, or request count in the current period), uploads are blocked with a code until the end of the billing period or until you upgrade the plan. Reading and serving existing files keeps working.