Technical Integration Guide

API Overview

Nyckel exposes a REST API (base path /v0.9/) for invoking classifiers (called Functions). Authentication uses same-origin session cookies or API keys.

Invoking a Function

curl -X POST https://www.nyckel.com/v0.9/functions/{functionId}/invoke \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": "Your account has been compromised! Click here immediately."}'

Response:

{
  "labelName": "Scam",
  "confidence": 0.98
}

Key Concepts

Function: A trained classification model scoped to a data type (image, text, structured).
Sample: A labeled training example uploaded to a Function.
Invoke: The prediction endpoint — returns label + confidence score.
Active Learning: Nyckel automatically flags samples where the model is uncertain, surfacing them for annotation.

Data Types Supported

Type	Input Format	Example Use Case
Image	JPEG/PNG URL or base64	Defect detection, content moderation
Text	Plain string	Spam, intent, sentiment
Structured	JSON key-value pairs	Fraud detection, churn prediction

Infrastructure

Hosted on Nyckel-managed GPU infrastructure — no provisioning required.
SOC2 Type II certified; HIPAA compliant data handling.
Models are isolated per customer; no cross-tenant data sharing.