Quickstart

Get a match-evaluation call working from your stack in under five minutes.

1. Sign in to the partner portal

Head to partner.geminhay.com, create an account, and create an organization. Every organization gets its own API keys, billing, and usage analytics.

2. Create an API key

Inside your org, go to API Keys → New Key. Pick the Test environment for development and copy the secret — you'll only see it once.

ak_test_01HG... (key id)
sk_test_••••••• (secret — store securely)

The Test environment counts toward your dev quota separately from Live, so you can poke around without bleeding into the production budget.

3. Install an SDK

npm

npm install @geminhay/sdk

pip

pip install geminhay

gradle

implementation("dev.geminhay:geminhay-sdk:1.0.0")

4. Make your first call

Evaluate the compatibility between two end-users by passing their public profile data:

TypeScript

import { GeminhayClient } from '@geminhay/sdk';

const client = new GeminhayClient({
  apiKey: process.env.GEMINHAY_API_KEY!,
});

const result = await client.matches.evaluate({
  userA: { id: 'usr_a', photos: ['https://…/a1.jpg'], bio: '…' },
  userB: { id: 'usr_b', photos: ['https://…/b1.jpg'], bio: '…' },
});

console.log(result.confidence);   // 0.0 – 1.0
console.log(result.reasonCategory);  // 'shared_hobbies' | …

Python

from geminhay import Client

client = Client(api_key=os.environ["GEMINHAY_API_KEY"])

result = client.matches.evaluate(
    user_a={"id": "usr_a", "photos": [...], "bio": "…"},
    user_b={"id": "usr_b", "photos": [...], "bio": "…"},
)

print(result.confidence, result.reason_category)

Java

GeminhayClient client = GeminhayClient.builder()
    .apiKey(System.getenv("GEMINHAY_API_KEY"))
    .build();

MatchEvaluation result = client.matches().evaluate(userA, userB);

System.out.println(result.confidence());
System.out.println(result.reasonCategory());

5. Watch it land in the portal

Within ~60 seconds, your call shows up under Usage → Engagement Funnel in the partner portal. You'll see latency, status, and (if you wire up the event ingestion endpoint) downstream reply rates.

What's next

• API Reference — every endpoint, every parameter.
• Authentication — key rotation, env separation.
• Pricing & Quotas — capability-level metering.
• SDK guides — language-specific notes.