Upload files and images

Files or images?

• Files are what your customers get: for example a PDF, a ZIP, a video or an audio file in the content of a product or a lesson. Use POST /v1/files for them.
• Images show on a sales page, in a course, a module, an email or a landing page. Use POST /v1/images for them. If an image is already at a public URL, you need no upload: put the URL in directly.

Upload a file

1. Create the upload:

   curl -X POST "https://api.tentary.com/v1/files" \
     -H "Authorization: Bearer $TENTARY_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"file_name": "Workbook.pdf", "size_bytes": 123456}'

   The answer has a file_id and an upload_url. The upload_url is valid for 20 minutes.

2. Send the bytes with HTTP PUT to the upload_url, without extra headers:

   curl -T Workbook.pdf "<upload_url>"

3. Finish the upload with POST /v1/files/{file_id}/finish.

Then use the file_id in a content block of a product or a lesson, for example {"type": "file", "file_id": 601}.

This way works for files up to 5 GB.

Short way for small files

A public file of at most 10 MB can also go in one step. Send only the url instead of file_name and size_bytes:

curl -X POST "https://api.tentary.com/v1/files" \
  -H "Authorization: Bearer $TENTARY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://..."}'

Tentary copies the file at once. No finish step is needed.

Upload an image

1. Create the upload with POST /v1/images, with file_name and size_bytes. PNG, JPG, GIF and WebP up to 10 MB are allowed.
2. Send the bytes with HTTP PUT to the upload_url.
3. Finish the upload with POST /v1/images/{upload_id}/finish.

The answer has the image_url. Use it for example in images of a product, as cover_image_url of a course or module, or as img src in the HTML of an email or a landing page.

Note: An image block in the content of a product or a lesson needs a file_id from POST /v1/files, not an image_url.