⚡Hermes Docs
Getting Started

Quickstart

Get started with Hermes in 5 minutes

Quickstart

Get up and running with the Hermes API or CLI in minutes.

Step 1: Get Your API Key

  1. Log in to the Hermes Dashboard
  2. Navigate to API Keys in the sidebar
  3. Click Create New Key
  4. Copy your key (starts with hermes_)

⚠️ Warning: Store your API key securely. It won't be shown again after creation.

Step 2: Make Your First API Call

Test that everything works by checking system health:

curl https://api.hermes.camie.ai/health
const res = await fetch('https://api.hermes.camie.ai/health');
const data = await res.json();
console.log(data);
{
  "status": "ok",
  "subsystems": {
    "sub-1": "up",
    "sub-2": "up",
    "sub-3": "up",
    "sub-4": "up",
    "sub-5": "up",
    "sub-6": "up"
  }
}

Step 3: List Your Leads

curl -H "Authorization: Bearer hermes_your_api_key" \
  https://api.hermes.camie.ai/v1/leads
const res = await fetch('https://api.hermes.camie.ai/v1/leads', {
  headers: { 'Authorization': 'Bearer hermes_your_api_key' }
});
const data = await res.json();
console.log(data);

Step 4 (Optional): Install the CLI

git clone https://github.com/Camie-Tech/hermes-cli.git
cd hermes-cli
npm install

Create a .env file:

HERMES_HOST=https://api.hermes.camie.ai
HERMES_TOKEN=your_jwt_token

Test it:

node ./bin/hermes.js health

Next Steps

Introduction

Project Hermes — Cold outreach & lead generation platform

Authentication

API keys and JWT tokens for Hermes API access

On this page

QuickstartStep 1: Get Your API KeyStep 2: Make Your First API CallStep 3: List Your LeadsStep 4 (Optional): Install the CLINext Steps