16a183beaef3

latestOpenAPI 3.0.02026-08-11267297516.7 KB
Uploads

Upload a file

Upload a file and get back its permanent public URL on the Gleap CDN. Send the request as multipart/form-data with the file in a form field named file (maximum size 100 MB). Files are stored in a folder scoped to the project passed in the project header.

The returned fileUrl can be used anywhere a URL is accepted — most commonly as the image source inside help center article content, which is TipTap JSON where images are nodes of the shape { "type": "image", "attrs": { "src": "<fileUrl>" } }. To add images to articles in bulk (e.g. UI screenshots for many articles), call this endpoint once per file, collect the returned URLs, and reference them in the article content when creating or updating articles.

post/uploads

Headers

projectstring required

Response

Ok

successboolean required
fileUrlstring required

Permanent public URL of the stored file on the Gleap CDN.