Reference¶

Reference pages specify SDK contracts and map them to Python modules and symbols. The generated API corpus is available through the Python API index.

Documents¶

Document	Summary
Client behavior and errors	Compare client ownership, synchronization, cleanup, return values, and failure behavior.
Request and response contracts	Specify endpoint metadata, typed validation, success-response pairing, follow-up requests, and cleanup contracts.
Generation parameters and features	Map image, text, alchemy, generic, template, and versioned parameter models to their supported uses.
Worker generation transitions	Specify generation lifecycle states, allowed progress, terminal outcomes, and job ownership.
Package and code map	Locate public clients, models, parameters, worker primitives, backend adapters, and supporting utilities.
SDK glossary	Define SDK-specific terms and link broader Horde concepts to the shared Haidra vocabulary.
Troubleshooting	Diagnose validation, availability, timeout, cleanup, download, async-session, and backend-conversion failures.
Contributor conventions	Collect SDK naming, typing, model, test, documentation, and generated-file requirements.
AI Horde endpoint map	Map each AI Horde endpoint and HTTP method to its SDK request and successful response types.

Not yet documented in full. Each page describes its subsystem briefly and names the code that holds the behavior.

Document	Scope
Backend parsing contracts	Describe typed normalization contracts for backend-native payloads and results.
Dispatch interfaces	Specify pop strategies, dispatch parameters, adapters, and backend conversion boundaries.
Chaining interfaces	Specify flow graphs, contexts, nodes, edges, executors, and failure propagation.
Ratings API reference	Specify ratings endpoints, client behavior, request models, and response models.
Deployment configuration	Describe the worker deployment configuration namespace and its compatibility boundary.
Model-reference integration	Describe the boundary between SDK requests and the external Horde model-reference package.
Logging reference	Describe SDK logger setup, progress and completion levels, and sensitive-field handling.
Safety and localization utilities	Describe prompt-safety checks, localization helpers, and their policy boundaries.
Image utilities	Describe image encoding, decoding, resizing, and validation helpers used at API and backend boundaries.