Skip to content

API, SDK & CLI

SA exposes the same canonical use cases through multiple driving adapters.

Core use cases

  • RenderCommunication
  • ValidateRequest
  • ListCapabilities
  • ValidateRuntime
  • ExplainGeneration

Python SDK

Conceptually:

from semantik_architect import SemantikArchitect

sa = SemantikArchitect.from_runtime_root("runtime")

sa.validate_request(request)
sa.render(request)
sa.explain(request)
sa.capabilities()
sa.validate_runtime("runtime-set-id")

render() accepts either a canonical CommunicationRequest or its public mapping/JSON shape.

CLI

semantik-architect --runtime-root runtime validate-request request.json
semantik-architect --runtime-root runtime render request.json
semantik-architect --runtime-root runtime explain request.json
semantik-architect --runtime-root runtime capabilities
semantik-architect --runtime-root runtime validate-runtime <runtime-set-id>
semantik-architect --runtime-root runtime conformance suite.json
semantik-architect --runtime-root runtime serve --host 127.0.0.1 --port 8765

Use - instead of a request filename where supported to read JSON from standard input.

Explain generation

explain is a diagnostic view of planning/runtime choices. It is not an epistemic authority and does not replace the original structured content.

Stable errors

Application failures use a machine-readable error envelope with:

code
category
stage
message_safe
retryable
request_id?
runtime_set_id?
details?

See Errors-and-Troubleshooting.