This reference is generated directly from the OpenAPI spec. Every operation and schema has a stable URL keyed by its operationId / schema name, so deep links remain valid even when paths or tags change.

Overview

Reference notes that apply across every endpoint — authentication, data formats, error handling, and rate limits. Each topic has its own page in the sidebar.

Resource groups

Functions

A Function is the core unit of the Nyckel platform — a live, self-improving classification (or detection / search) pipeline addressed by a single stable id. These endpoints create, list, fetch, update, and delete Functions.

Labels

A Label is one possible output of a Function — the categories your Function can predict. Labels are scoped to a single Function.

Samples

A Sample is one input recorded against a Function, optionally carrying an Annotation (the ground-truth Label) and a Prediction (the model’s guess). Samples are the training data and the audit trail of every invocation captured by InvokeCapture.

Fields

Fields describe the structured columns of a tabular Function’s input (name + type: Text, Number, or Image).

Invoke

Send data to a trained Function and receive a Prediction. This is the runtime endpoint that powers production traffic. Invocations may be captured as Samples via the capture flag (see CaptureReason and SampleOrigin).

Search Functions

Search Functions return the nearest Samples to a query input rather than a Label. Invoke a Search Function with either raw input data or an existing sampleId to find similar Samples.

All schemas

See the schema index for the full list of object types.