---
title: "Try the OpenEmail API from the docs"
description: "Send a real request from any page of the OpenEmail API reference, with a temporary key that lasts an hour and is scoped to that call."
url: "https://openemail.uk/features/api-playground"
---

[Developers](https://openemail.uk/developers/features.md#doors)

# Try it in the docs Read about a call, then make it.

Every docs page for an API operation has a Try it panel. Fill in the parameters and the body, send it, and the real response comes back beside it.

[Open mail](https://openemail.uk/mail/inbox) [Get Started](https://openemail.uk/signup.md)[Developer features](https://openemail.uk/developers/features.md)

In short

## What is an API playground?

A form inside API documentation that sends real requests, so you can see what a call returns before you write code for it. Here it sits on the page that documents the call, and every response comes with the cURL command that does the same.

How it works

## A key scoped to this call

Signed in as the workspace owner, you can make a temporary key for the page. It has exactly the permissions that call needs, works for an hour and asks for your verification code first.

## Or bring your own key

A key you paste is held only in the page’s memory, never saved, and forgotten after an hour without use. Check my key shows what it may do.

## A send from the docs is a send

A request that sends mail or deletes something needs a second click within five seconds, because it is real.

What you get

## In the product today

The cURL to match

The real response comes back with the cURL command that does the same.

Always the newest key

A new temporary key replaces the last one made this way.

Temporary inboxes too

The temporary inbox calls work with an inbox token instead of a key.

Good practice

## Getting the most out of it

1. 01
   
   Let the page make the key
   
   A temporary key holds exactly the permissions the call on that page needs, and it stops working after an hour.
2. 02
   
   Check a pasted key first
   
   Before you send with a key of your own, press Check my key to see what it may do.
3. 03
   
   Send to yourself first
   
   A send from the docs is a real send, so put one of your own addresses in the To field while you try things out.

Questions

## Asked often

Keep going

## Works well with

REST API

A documented HTTP API with issuable, scopable, revocable keys.

API keys

A key per job, limited to the scopes and senders it needs, with every call logged.

Start

## Your domain, your mail.

Point a domain at OpenEmail and read it in a mailbox built around it. The free plan covers one domain.

[Open mail](https://openemail.uk/mail/inbox) [Get Started](https://openemail.uk/signup.md)[Read the reference](https://openemail.uk/docs/knowledge/developers/api-playground.md)