Service API Integration · 01
Before You Start (Provided by Your Deployer)
The following values are not fixed by this document. Request them from your OpenJellyfish deployer / service administrator:
| Item | Description | Example placeholder |
|---|---|---|
| Base URL | Public HTTPS address of the instance + /api/v1 prefix | https://<your-deploy-domain>/api/v1 |
| Service API Key | Format sk-svc-..., created under Settings → Service Management → API Keys | sk-svc-<provided-by-deployer> |
| Service ID (optional) | Standalone chat page at /s/<service_id>; used to distinguish multiple services | svc_xxxxxxxx |
One key per service — keep it safe. Contact your deployer admin to rotate or add keys. Never commit keys to public repos or embed them in frontend code.
Examples below use environment variables — replace with your actual values before copying:
bash
export JF_BASE_URL="https://<your-deploy-domain>/api/v1"
export JF_API_KEY="sk-svc-<provided-by-deployer>"