API Reference
Complete reference for every class, method, parameter, return value, and error in the OptixLog Python SDK.
This section documents every public symbol in the OptixLog Python SDK. Each entry follows a standard convention so you can quickly find what you need without reading prose.
How to read this reference
Every class and method is documented with the same six-part structure:
Signature — the exact Python signature copied from the source stubs. Always shown in a python code fence so you can paste it directly.
Parameters — a TypeTable listing every argument: its type, whether it is required, its default value, and what it controls.
Returns — the return type and a description of what the value contains.
Side effects — whether the call makes a network request, mutates server state, or does neither. Read-only methods say "None (read-only)".
Raises — which exceptions the method raises and under which conditions.
Example — a minimal, runnable code snippet demonstrating the most common usage.
Module map
| Import path | What lives there |
|---|---|
optixlog | SDKClient, ProjectRef, EntityRef, Page, JSONValue, Order, and all error classes |
optixlog.management | Management, ManagementProject, all collection classes, and all model dataclasses |
optixlog.pipeline | Pipeline, PipelineProject, IngestResult, IngestibleNode protocol |
optixlog_gen (generated) | OptixClient, Projects, project-specific node classes — emitted by optixlog generate into your repo |
Generated module
optixlog_gen is not part of the installed package. It is generated into your repository by running optixlog generate. See Generated Bindings for how to produce it.
Sections
SDKClient
Core client: transport, auth, and project reference handles.
ProjectRef
Opaque project handle returned by SDKClient.project().
OptixClient
Generated per-project typed client with overloaded project() method.
Management API
Read and manage config, teams, members, workflow nodes, and audit events.
Pipeline API
Ingest workflow nodes into a project graph.
Data Models
All frozen dataclasses: ProjectConfig, Organization, WorkflowNode, AuditEvent, and more.
Errors
Exception hierarchy: when each error is raised and how to handle it.
Types
Type aliases and Literal unions used throughout the SDK.