Search...

API Reference Overview

The API Reference section provides a complete, structured, and searchable catalog of every public class, function, request object, response object, and service included in the Norman SDK and Norman Core SDK.

This part of the documentation is designed for developers who want:

  • A precise understanding of all available client-side APIs

  • Clear type definitions for models and request/response objects

  • Complete descriptions of all SDK service methods

  • Low-level behavior of utilities, helpers, and protocol abstractions

  • Direct links to the exact source definitions (without digging in the repo)

Unlike the Guides or Quick Start, which focus on how to use the SDK, this reference section focuses on what exists and how it behaves.

API Reference Overview

The API Reference section provides a complete, structured, and searchable catalog of every public class, function, request object, response object, and service included in the Norman SDK and Norman Core SDK.

This part of the documentation is designed for developers who want:

  • A precise understanding of all available client-side APIs

  • Clear type definitions for models and request/response objects

  • Complete descriptions of all SDK service methods

  • Low-level behavior of utilities, helpers, and protocol abstractions

  • Direct links to the exact source definitions (without digging in the repo)

Unlike the Guides or Quick Start, which focus on how to use the SDK, this reference section focuses on what exists and how it behaves.

What You Will Find Here:

1. Norman SDK (High-Level Client)

The developer-friendly entry point for interacting with Norman-managed models:

  • High-level service clients

  • Output handles

  • Strongly-typed objects

  • Simple deploy → invoke → fetch output flows

This layer is designed to be intuitive, ergonomic, and easy to integrate into apps, scripts, and backend services.

2. Norman Core SDK (Low-Level Internal API)

A thin, precise wrapper used for internal operations and advanced integrations:

  • HTTP and Socket clients

  • Authentication, registration, and account flows

  • Model upload, file push/pull, retrieval services

  • Invocations, status flags, notifications, pairing, and more

This layer exposes the underlying REST and realtime protocols Norman uses internally.

3. Objects & Models

All request/response models, enums, dataclasses, and structured objects used throughout the SDKs, including:

  • Models, ModelBase, Previews, Assets

  • Invocations & InvocationSignatures

  • QueryConstraints & filtering structures

  • Notifications & Status Flags

  • Pairing & Download request objects

  • Login / Register / Signup objects

  • Utility enums used throughout the APIs

Every field is documented, typed, and described.

4. Utilities

All helper utilities available to SDK developers:

  • Date handling

  • UUID optimization

  • Streaming utilities

  • File utilities

  • Random generators

  • Dot-syntax resolution

  • Singleton pattern utilities

These utilities power both the SDK and internal services, and are documented to help developers extend, debug, or integrate advanced functionality.

How to Use This Reference

The API Reference is structured to help you:

  • Understand each public object without cryptic source diving

  • Quickly find the exact model or request object used by a service

  • Explore all class methods and parameters

  • Navigate large SDKs through mkdocstrings auto-generated pages

  • Discover internal utilities that may help your own application logic

Each page in this section is auto-generated from the actual source code and kept in sync with the SDK, ensuring accuracy and completeness.

Who This Section Is For

  • Developers integrating Norman into production systems

  • Contributors extending the SDK or writing custom tools

  • Engineers building custom clients around Norman’s APIs

  • Anyone who needs precise details, not conceptual guides

If the Guides and Tutorials show how,
the API Reference shows exactly what exists and how it behaves.

Next Steps

Browse through the API groups in the navigation:

·

©

2026

On this page:

1. Norman SDK (High-Level Client)

2. Norman Core SDK (Low-Level Internal API)

3. Objects & Models

4. Utilities

How to Use This Reference

Who This Section Is For

Next Steps