For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
GuidesIntegrationsAPI ReferencesRelease notes
GuidesIntegrationsAPI ReferencesRelease notes
    • APIs overview
  • Upload API
    • Errors
  • REST API
    • Authentication
    • File Metadata
    • Add Ons
    • Changelog
    • Versioning
  • URL API
    • File Information
    • File Names
      • GETFile with a custom name
    • File groups
    • Image processing limitations
    • Image compression
    • Image resize and crop
    • Image rotation
    • Image overlays
    • Image colors
    • Image definition
    • Image recognition
    • Other image operations
    • Proxy
    • Signed URLs
    • CDN settings
    • Integrations
Dashboard
LogoLogo
URL API

File Names

Previous

File with a custom name

Next
Built with

Your original filenames can be accessed via REST API.

Make a request to receive a JSON response with file parameters including original_filename.

You can set an optional filename that users will see instead of the original name:

https://:subdomain.ucarecd.net/:uuid/:filename

:filename should comply with file name conventions and it should be a valid part of a URL. For example, filename.ext.

Here are some examples with full CDN URLs:

Safe:
// adding a simple filename
https://1gkkwxp4lp.ucarecd.net/85b5644f-e692-4855-9db0-8c5a83096e25/image.jpg
// using a char allowed in the pchar definition
https://1gkkwxp4lp.ucarecd.net/85b5644f-e692-4855-9db0-8c5a83096e25/image@2x.jpg
// allowed in pchar together with Image Transformations
https://1gkkwxp4lp.ucarecd.net/85b5644f-e692-4855-9db0-8c5a83096e25/-/preview/-/resize/550x/image@1x.jpg
// using a sub-delim allowed in pchar together with Image Transformations
https://1gkkwxp4lp.ucarecd.net/85b5644f-e692-4855-9db0-8c5a83096e25/-/preview/-/grayscale/image_black&white@2x.jpg
// using percent-encoded gen-delims that are not allowed in pchar
https://1gkkwxp4lp.ucarecd.net/85b5644f-e692-4855-9db0-8c5a83096e25/-/preview/-/grayscale/image%5Bdesaturated%5D@2x.jpg
Unsafe:
// using gen-delims that are not allowed in pchar without encoding
https://1gkkwxp4lp.ucarecd.net/85b5644f-e692-4855-9db0-8c5a83096e25/-/preview/-/grayscale/image[desaturated]@2x.jpg