Versioning
SDK package version, server API surface version (v0), and schema_version in optixlog.toml.
OptixLog uses three independent version identifiers. Understanding which version refers to what prevents confusion when upgrading or debugging compatibility issues.
SDK package version
The optixlog Python package is currently at version 0.1.0.
Check the installed version:
optixlog --version
# 0.1.0
python -c "import optixlog; print(optixlog.__version__)"
# 0.1.0The SDK follows Semantic Versioning. While the version is 0.x.y, breaking changes may occur at minor version increments. Once the SDK reaches 1.0.0, only major version increments will introduce breaking changes.
Server API surface: v0
The server exposes a versioned API surface labeled v0. The SDK communicates exclusively with this surface. The v0 routes used by the SDK are:
| Endpoint group | Purpose |
|---|---|
v0.whoami | Validate an API key and retrieve identity (key type, org, user email). Used by optixlog login and optixlog whoami --validate. |
v0.projects.* | List projects accessible to the API key. Used by optixlog init. |
v0.codegen.schema | Fetch the full schema contract for a set of project ids. Used by optixlog generate. |
v0.ingest | Create or update a workflow node in a project graph. Used by Pipeline.ingest() / PipelineProject.ingest(). |
Not a REST reference
This page is a brief orientation, not a full REST or tRPC reference. The server endpoints are not part of the public SDK contract — interact with the server exclusively through the SDK and CLI.
The default base URL for all v0 requests is https://optixlog.leidos.com. Override it with --base-url, OPTIXLOG_BASE_URL, or the api_base_url field in ~/.optixlog/credentials.toml.
schema_version in optixlog.toml
The schema_version field in optixlog.toml is an integer that records the version of the schema contract format that was in use when the project was initialized:
[optixlog]
api_base_url = "https://optixlog.leidos.com"
schema_version = 1Only schema_version = 1 is currently supported. The field is optional and defaults to 1 when omitted.
This version is separate from the SDK package version and the server API surface version. It refers specifically to the shape of the JSON contract document (the schema_version field inside the contract JSON itself). If the contract format ever changes in a breaking way, schema_version will be incremented and the codegen will reject old-format contracts.
Version compatibility matrix
| SDK version | Supported schema_version | Server API surface |
|---|---|---|
0.1.0 | 1 | v0 |
Glossary
Definitions for every term used across the OptixLog SDK and CLI documentation — organization, project, workflow node, codegen, OptixClient, and more.
Troubleshooting
Common problems and fixes for the OptixLog SDK and CLI — authentication, stale bindings, missing config, fixture mode, type errors, and more.