Skip to main content

​
Create a project

​
What this is for

A project is where your API keys, webhooks and records live. Most teams keep one project per app or environment, for example one for a patient app and one for an internal tool. The Create a new project screen is where you name a project and choose how powerful its server should be. Your first project is created for you as part of setting up an organization, using this same screen; later ones use it too.

​
Before you start

  • You must be an owner or admin of the organization. Members cannot create projects, and if you open the address anyway the page simply says it cannot be found.
  • Your organization must have no unpaid invoice. While one is overdue, new projects are paused: see Billing.
  • It helps to know your plan. Free projects run on a shared sandbox and can only be the Small size. Pro and Team projects choose a compute size and can have a failover standby. The compute size is the strength of the server behind the project: more CPU and memory, higher price.

​
Step by step

1

Open the screen

From the project menu in the top bar choose New project, or select New project on the Projects page. For a brand-new organization you arrive here automatically. The page is headed Create a new project: “Your project holds its own API keys, webhooks and records.”
2

Check the organization

Organization shows where the project will be created. Open the menu to switch to another organization you belong to; each shows its plan in brackets.
3

Name the project

Type a Project name (placeholder “Project name”). It must be 3 to 60 characters. It starts with a suggestion built from your email, such as “Jane’s project”. You can rename it later in Project settings.
4

Look at the region

Region is fixed and cannot be changed: United States (us-east-1), with the note “Projects are available in the United States only for now.”
5

Choose a compute size

Under Compute size pick a row. Each shows its size and what it costs:What you can pick depends on your plan:
  • Free: only Small, shown as Shared sandbox. The other sizes carry a Pro and Team tag and cannot be selected. A note says “Larger sizes and a dedicated server come with Pro and Team.”
  • Pro: the first project includes Small (marked Included). Larger sizes show their monthly price.
  • Team: the first project includes Medium. Small is marked Below the plan and cannot be chosen for the first project.
  • Later projects on Pro or Team can use any size, each at its own price.
6

Decide on failover standby (Pro and Team)

Failover standby is a second copy of your server that takes over if the first one fails. On Team it is on and included (“Included with Team.”). On Pro it is a switch, off by default: “A second copy that takes over if the first fails. Priced at the compute size.”
7

Read the cost line

At the bottom left, a paid plan shows either Additional costs with an amount per month, or “Included in your plan.” (first project) or “No additional cost.”. The first project is included at the size your plan comes with, so only a larger size, or a Pro standby, is extra. Every later project is billed at its own size.
8

Select Create new project

The button reads Creating… while it works. If there are additional costs, a box titled Confirm compute costs opens first: “This project’s compute adds the amount a month to your bill once the server is ready, whatever its usage. By continuing you agree to the additional cost.” Select I understand to go ahead, or close the box to change your choices. Cancel takes you back without creating anything.
On success you go to the setup screen, which creates a test key and shows it once. That part is described in Create an organization.

​
What you’ll see

  • A notice above the buttons: “Dedicated projects are rolling out. Your project starts on the sandbox, with test keys and synthetic data, and moves to its own server when it is ready.” On a paid plan it adds “Compute is billed by the hour, and only once the server is ready.” Both messages say the same thing: nothing is billed for compute until the project is on its own server, and from then it is billed by the hour at the monthly price shown.
  • If this is your organization’s first project and it still has the automatic Default project, setting it up renames that project (or replaces it with a new one if it is untouched) instead of adding a second. Replacing it can only be done by the owner.

​
Common questions

The sandbox is a shared practice area with invented data and test keys. A dedicated server is yours alone and is where real patient data goes, with live keys, on Pro and Team. New projects start on the sandbox and move across when their server is ready.
Yes. The size on this screen is a starting point (“You can change this later”); see Compute and disk.
Free is a shared sandbox, so only Small applies. Upgrade the organization from Billing to unlock the others.
Only one region is available today, so there is nothing to choose.
No. You can rename a project in its settings. Deleting one is a separate, owner-only action with a confirmation: see Project settings.

​
Troubleshooting