Getting Started

Use this guide to make your first Wize Snap API calls.

1. Get An API Key

Use the Developer Console page in your dashboard (under the API Keys tab) to create and manage API keys:

API key dashboardhttps://snap.wizer.business/dashboard/developers?tab=api

Every request to the public API must include your API key.

x-api-key: wz_live_your_api_key

Keep API keys server-side. Do not expose them in browser code, mobile apps, or public repositories.

2. API Billing & Credits

Before using the API, your account needs active API credits:

• Free Start: When you generate your first API key, your account is credited with 100 free API credits automatically.
• Add More Credits: Manage billing under the API Credits tab of the Subscription & Billing page — no payment method needs to be added beforehand, checkout is handled by Stripe:
  API credits dashboardhttps://snap.wizer.business/dashboard/subscription?tab=credits

You can add credits two ways:

1. Subscribe to a recurring plan — credits are granted once per billing cycle (monthly or yearly, paid up front):

   Plan	Monthly credits	Yearly credits	Monthly	Yearly
   Starter	3,000	36,000	$79/mo	$869/yr
   Core	10,000	120,000	$249/mo	$2,739/yr
   Growth	20,000	240,000	$449/mo	$4,939/yr
   Scale	65,000	780,000	$1,290/mo	$14,190/yr

2. Buy a one-time credit pack — added to your balance immediately, no recurring commitment:

   Pack	Credits	Price
   Small	1,000	$35
   Medium	5,000	$150
   Large	25,000	$650

Subscription credits and pack credits are tracked as separate balances but spent together — subscription credits are drawn down first, then pack credits.

important

Billing Separation: Snaps or LinkedIn Snaps tokens purchased via standard subscriptions cannot be used as API credits. API usage is billed exclusively through dedicated API credits.

Credit Cost Per Call

• POST /api/v1/snap (Predict Profile) — 1 credit.
• POST /api/v1/snap/comms (Analyse Comms) — 2 credits.

3. Predict A Profile

Start by creating a profile prediction.

API base URLhttps://backend.snap.wizer.business

POST https://backend.snap.wizer.business/api/v1/snap

{
  "name": "Alex Morgan",
  "ageRange": "35-44",
  "jobType": "Sales Director",
  "notes": "Leads enterprise renewals and prefers concise commercial context."
}

Store the returned data.snapId; it connects the predicted profile to later communication analysis.

4. Analyse Communication

Use the snapId from Predict Profile when sending a communication draft.

POST https://backend.snap.wizer.business/api/v1/snap/comms

{
  "snapId": 123,
  "messageType": "email",
  "messageText": "Hi Alex, I wanted to follow up on the renewal proposal..."
}

Don't have (or want to store) a snapId? Send primaryCode (and optionally secondaryCode) instead — see Analyse Comms API for the full list of codes. Send exactly one of snapId or primaryCode, never both.

5. Handle Errors

Invalid or inactive API keys return 401.

{
  "message": "Invalid or inactive api key",
  "error": "Invalid or inactive api key",
  "statusCode": 401
}

For validation failures, check that every required field is present and has the expected type.

Both endpoints are rate-limited to 120 requests per minute per IP address. Exceeding it returns 429 — see Rate Limiting for the response shape and headers.

Need a new key later? Return to Generate an API key.

Want to try requests without writing any code first? Try it in the Playground.