CreateResult

Read paths, identity, version, digest, and validation report returned by create_octx().

CreateResult is the immutable result object returned after create_octx() succeeds. It provides the published Package path, identity, version, digest, and validation report in one place.

Getting the object

from octx import create_octx

result = create_octx(
    "./.octx-workspace",
    source="./knowledge",
    name="Product Guide",
    output="./product-guide.octx",
)

A CreateResult is returned only after the Package has been completely built, validated, and successfully published.

Fields

Field	Purpose
`output`	Absolute `Path` to the published `.octx` file.
`workspace`	Absolute `Path` to the production workspace.
`asset_id`	Asset UUIDv7.
`version`	SemVer of this Release.
`created_at`	Release creation time.
`package_digest`	`sha256:` Package Digest.
`document_ids`	Read-only mapping from `knowledge/...md` to Document UUIDv7.
`report`	`ValidationReport` completed before publication.
`status`	Always `"ready"`.

Serialization

result.to_dict() returns a JSON-serializable structure suitable for CLIs, logs, or API responses:

payload = result.to_dict()
print(payload["asset_id"], payload["package_digest"])