Quickstart

This guide walks you from zero to a working API call against the Meridian test environment. You will create an API key, create a project, and read it back.

Prerequisites

• A Meridian account - sign up free if you don't have one.
• curl, or one of the official SDKs installed.
• A terminal with your API key exported as an environment variable.

1. Get an API key

Every workspace ships with two environments: test and live. API keys are scoped to one environment.

1. Open the dashboard → Developers → API keys.
2. Click Create key, choose the test environment, and copy the key. It starts with mrnd_test_.

export MERIDIAN_API_KEY=mrnd_test_4f8e2c1a9b7d3e5f6a0c

2. Create a project

A project is the container for everything you build - connections, webhooks, and sync jobs all live inside one.

curl -X POST https://api.meridian.dev/v2/projects \
  -H "Authorization: Bearer $MERIDIAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "my-first-project", "region": "us-east"}'

import { Meridian } from "@meridian/sdk";

const client = new Meridian(process.env.MERIDIAN_API_KEY);

const project = await client.projects.create({
  name: "my-first-project",
  region: "us-east",
});

import os
from meridian import Meridian

client = Meridian(os.environ["MERIDIAN_API_KEY"])

project = client.projects.create(
    name="my-first-project",
    region="us-east",
)

3. Read it back

curl https://api.meridian.dev/v2/projects/prj_9kLm2xVb7nQe \
  -H "Authorization: Bearer $MERIDIAN_API_KEY"

A 200 OK response means your key, environment, and project are all wired up correctly.

What's next