OptixLog Docs
Python SDKManagement API

Project Config

Fetch project configuration with project.config.get() and convert it to a plain dict.

project.config is a ProjectConfigResource. It has a single method: .get().

Fetching config

project_config.py
from optixlog import SDKClient
from optixlog.management import Management

client = SDKClient(base_url="https://optixlog.leidos.com", api_key="sk-opt-...")
mgmt = Management(client)
project = mgmt.project("proj_grating_7f3a")

config = project.config.get()

print(config.id)           # "proj_grating_7f3a"
print(config.name)         # "Grating Coupler Lab"
print(config.description)  # str | None
print(config.category)     # str | None
print(config.icon)         # str | None
print(config.notes)        # str | None
print(config.status)       # e.g. "active"
print(config.created_at)   # datetime (UTC)
print(config.updated_at)   # datetime (UTC)

project.config.get() raises NotFoundError if the project does not exist or the API key does not have access to it.

Converting to a dict

ProjectConfig is a frozen dataclass. Call .to_dict() to get a plain dict[str, Any] suitable for serialization. Datetime fields are serialized as ISO 8601 strings.

data = config.to_dict()
# {
#   "id": "proj_grating_7f3a",
#   "name": "Grating Coupler Lab",
#   "description": None,
#   "category": "photonics",
#   "icon": None,
#   "notes": None,
#   "status": "active",
#   "created_at": "2025-01-15T09:00:00+00:00",
#   "updated_at": "2026-01-20T14:30:00+00:00",
# }
import json
print(json.dumps(data, indent=2))

ProjectConfig fields

Prop

Type

On this page