API Keys

Generating your API key

Open your Jourvex dashboard and go to Settings → API Access. Click Generate API Key to create a new key.

Jourvex only shows the raw API key once during generation and cannot retrieve it later. Copy and store it somewhere safe before leaving the page.

Your key will look similar to this:

jvx_live_aBcDeFgHiJkLmNoPqRsTuVwXyZ...

Storing your key safely

Your API key should always be stored as an environment variable on your server.

Never hardcode it in source code, commit it to version control, or expose it through browser JavaScript.

Set as an environment variable

JOURVEX_API_KEY=jvx_live_aBcDeFgHiJkLmNoPqRsTuVwXyZ...

Read it in your backend

import os

JOURVEX_API_KEY = os.environ["JOURVEX_API_KEY"]

const JOURVEX_API_KEY = process.env.JOURVEX_API_KEY;

Using your key in requests

Pass your API key as a Bearer token in the Authorization header of every Journey API request.

GET https://jourvex-api.onrender.com/api/journey/{journey_id}

Authorization: Bearer jvx_live_...

import requests
import os

res = requests.get(
    f"https://jourvex-api.onrender.com/api/journey/{journey_id}",
    headers={
        "Authorization": f"Bearer {os.environ['JOURVEX_API_KEY']}"
    }
)

journey = res.json()

const res = await fetch(
  `https://jourvex-api.onrender.com/api/journey/${journeyId}`,
  {
    headers: {
      Authorization: `Bearer ${process.env.JOURVEX_API_KEY}`
    }
  }
);

const journey = await res.json();

Checking key status

Your dashboard shows the prefix of your active key and the last time it was used.

Review this periodically to confirm your integration is active and to detect unexpected usage patterns.

The full key is never shown again after generation. Only the prefix is displayed so you can identify which key is active without exposing the full secret.

Rotating your key

If you believe your key has been exposed or you want to issue a fresh one, rotate it from Settings → API Access in your dashboard.

Rotating invalidates your current key immediately. Requests using the old key will stop working as soon as rotation completes.

After rotation your dashboard will display the prefix of the new key and a last used timestamp of never until the first successful request is made.

Error responses

The Journey API returns standard HTTP status codes. These are the most common responses.

Best practices