Get a sandbox key

Flume issues sandbox keys by request. Send one email with the details below. There is no sign-up form and no dashboard today.

Ask for a key

Email support@tryflume.ai with the details below.

Request a sandbox key

Subject: Sandbox key request

Company name:

Your name and work email:

What you are building (iframe, API, or both):

Page origins that will frame the iframe (for example https://app.yourcompany.com, http://localhost:3000):

Image hosts your item photos are served from (for example cdn.yourcompany.com):

Redirect hosts for deep links, if any:

What should you send?

Detail	Why Flume needs it	Example
Company name	To name your platform	Acme Design
Your name and work email	To send the key
What you are building	Iframe, API, or both	Iframe
Page origins	Only these pages may frame the iframe	https://app.acme.example, http://localhost:3000
Image hosts	Flume fetches item photos only from these hosts	cdn.acme.example
Redirect hosts	A deep link may return the user only to these hosts	app.acme.example

• An origin is a scheme, a host and a port. It has no path and no trailing slash.
• A local origin such as http://localhost:3000 can be an allowed origin in the sandbox. Ask for it. The port must match exactly.

What do you get back?

You get	Notes
A sandbox partner key	It starts with sk_dev_. Flume cannot show it again. Store it in a secret manager
Your partner slug	The short name inside your key and your links
The origins and hosts Flume set for you	Check them against what you asked for

What happens next?

From a key to live, step by step. The order to build in. Each step has a page.

Read this diagram as text

1. Get a sandbox key, and have Flume set your page origin as an allowed origin.
2. Start a session from your backend with POST /start-iframe-session.
3. Mount the iframe on your page: the iframe tag and the host snippet.
4. Exchange the connect code on your backend and store the user access token.
5. Write the saved item, once per save_uuid, and reply to the iframe.
6. Handle close, expiry, the ready timer and errors.
7. Finish the go-live checklist in the sandbox.
8. Ask Flume for live access, then switch the base URL and the key.

1. Flume reads your request and replies by email.
2. You store the key and run the quickstart.
3. After that you rotate and revoke keys yourself. See Rotate your key.
4. When your integration works in the sandbox, follow the go-live checklist to ask for live access.

Flume does not publish a response time for key requests.

What a sandbox key cannot do

• It does not work on live. See Environments.
• It cannot change your allowed origins, image hosts or redirect hosts. Ask Flume.