Developer API and Cipher SDK

The Cipher SDK brings Surbee's response checks into your own forms, apps, and data pipelines. You send a response, and Cipher returns a quality score, a keep, review, or discard recommendation, and the reasons behind it. You do not need a Surbee plan to use it.

Everything for developers lives in the platform console at platform.surbee.dev. Sign in with the same Surbee account you use for the app. From the app, you can also open Settings, then the Connectors tab, and click Open console.

Pricing

The SDK is pay as you go. You buy API credits in advance and each scored response is paid from that balance.

Tiers 1 and 2 run on-device and are free.

Getting started

The first time you open the console, a short setup asks you to:

1. Confirm your email with a six-digit code.
2. Add your full name and date of birth. You must be 18 or older to use the developer platform.
3. Name your organisation and say what best describes you.
4. Create your first API key, or choose I'll do this later.
5. Add some API credits, or skip and top up later.

The console

The sidebar has five pages, plus links to Docs, Help, and Feedback.

• Overview. Your requests, spend, how many responses passed Cipher, and your API keys, over the last 7, 30, or 90 days.
• Usage. Charts of requests and cost. Filter by date range (Today, 7 days, 30 days, 3 months, 12 months, or custom) and by API key. Click Export to download your usage and cost as CSV files.
• API keys. Create, rotate, and revoke keys.
• Top up. Buy API credits.
• Billing. Your payments, with an invoice and a receipt for each one.

Create an API key

1. Open API keys and click Create key.
2. Give it a Name, such as "Production backend".
3. Choose the Highest tier the key may request (Tier 1 to Tier 5).
4. Choose a Rate limit, from 30 to 600 requests a minute.
5. Pick its Scopes: Validate (score one response at a time), Batch validate (score many responses in one call), or Generate (survey generation endpoints).
6. Click Create key.

Keys start with cipher_sk_. The key is shown once, right after you create it, so copy it and click I have saved it. Keep keys on your server and never put them in a web page or app that users can inspect.

If a key leaks, Rotate it to get a new secret, or Revoke it to turn it off for good.

Top up API credits

1. Open Top up.
2. Pick an amount ($5, $10, $25, $50, $100, or $500) or enter a custom amount between $5 and $1,000.
3. Click Continue to payment and complete the checkout.

Payments are handled by Polar, so your card details never reach Surbee. The credits are added to your balance once the payment completes.

Install the SDK

The SDK is published on npm as @surbee/cipher:

pnpm add @surbee/cipher

For setup, request examples, the full list of checks, and every option, read the developer docs.