Quickstart Guide

This guide shows you how to set up and use Trelae to manage files in your app.

1. Create a project

Go to trelae.com/projects/new to create a new project. All you need is a name so that you can identify it later. The name does not need to be unique.

2. Create an API key

Generate an API key from your newly created project’s dashboard. We will use this to authenticate our requests.

3. Install an SDK

Trelae provides SDKs for many programming languages to allow conveninent access to our APIs. Install the SDK of your preferred language to get started.

You can also consume our REST API directly, although we don’t recommend it.

4. Create a namespace

All files go into a namespace. They help you organize files and keep them isolated.

Every namespace can either be private or public. Public namespaces receive a URL that can allow anybody on the internet to access the files within them. Private namespaces allow you to control access by requesting a signed URL that expires.

You can configure the region for your namespaces. By default, it uses AWS us-east-1.

You can also choose a name for your namespace. This is simply a label that helps you identify it later. It does not need to be unique.

You can create a namespace through your project dashboard’s UI, or programmatically.

5. Upload a file

Our REST API supports two methods to upload a file: simple and multipart. For this guide, we will stick to the simple approach.

You have to first request for an upload url, then upload the file by making a PUT request to that URL.

6. Download a file

If you created a public namespace, it could take around 15 minutes for your files to be accessible via the public URL. However, for both public and private namespaces, files are immediately accessible by requesting a signed download URL.