Skip to main content

Overview

Wize Snap helps teams turn lightweight profile context and communication drafts into decision-science guidance.

This documentation is for teams integrating the Wize Snap API into their own products, CRMs, communication tools, and internal workflows.

What You Can Build

  • Predict a decision profile from a person's name, role, age range, and notes.
  • Analyse a message against a decision profile — either a stored snapId or a direct profile code — for clearer outreach or internal communication.
  • Authenticate server-side integrations with an x-api-key header.

API Surface

Wize Snap exposes two API routes:

  • POST /api/v1/snap for Predict Profile.
  • POST /api/v1/snap/comms for Analyse Comms.

No other backend routes are part of the public API documentation.

API Billing & Credits

important

API usage is billed separately from the main platform web/extension subscriptions. Standard subscription snaps or LinkedIn snaps tokens cannot be used as API credits.

  • Initial Grant: Every user account starts with 100 free API credits upon generating an API key.
  • Dedicated Billing: Once the initial credits are exhausted, add more from the API Credits tab of the Subscription & Billing page (/dashboard/subscription) — no payment method needs to be added beforehand, checkout is handled by Stripe.
  • Recurring Plans: Starter, Core, Growth, and Scale plans grant a fixed number of credits once per billing cycle (monthly or yearly).
  • One-Time Packs: Small, Medium, and Large credit packs add credits to your balance immediately, with no recurring commitment.
  • Per-Call Cost: Predict Profile costs 1 credit per call; Analyse Comms costs 2 credits per call.

See Getting Started for exact plan and pack pricing.

Documentation Map

  • Walkthrough: The single place to start — a guided, end-to-end tutorial covering both calls and how to read the responses.
  • Getting Started: Connect your API key, learn about billing, and make your first two calls.
  • Product Guide: Understand when to use Predict Profile and Analyse Comms.
  • API Reference: Review authentication, request bodies, and response examples.
  • Releases: Track documentation and public API changes.