Getting started

This guide covers onboarding. For endpoints, request parameters, and response schemas, use the API reference — generated from the deployed API and kept up to date.

Prerequisites

Step 1: Get an API key

Most API keys are provisioned by Nory. Some integrations are instead connected by the customer from Nory Settings → Integrations, which mints the key without Nory in the loop — your Nory contact will tell you which applies to you.

Contact your Nory account manager or integrations team to request a key. You will receive a secret key once, in this format:

nory_live_sk_<random-token>

Store it securely. The full key is shown only at creation time and cannot be retrieved later. If you lose it, request a new key and revoke the old one.

See Authentication for how to send the key on requests.

Step 2: Base URL

Production: https://api.prod.nory.ai

All partner endpoints are under /api/v1.

Step 3: Make your first call

Open the API reference, click Authorize, and enter your key as a Bearer token. Pick any GET /api/v1/* operation, use Try it out, and execute the request.

Each API key is scoped to a single brand — you will only see data for your brand. Keys are read-only by default; creating employees needs write access, which is enabled per integration — by Nory, or by the customer when they connect the integration themselves.

Step 4: Explore further

Preview status

The Public API is in limited preview (V0). Endpoints, fields, and behaviour may change. We will communicate breaking changes to partners in advance where possible. A field with a fixed set of values may gain new ones, so handle a value you don't recognise rather than rejecting the response.