Semogram Docs
APIResources

Ontology and read bindings

Inspect compiled meaning and connect terms to data

Ontology resources are project-scoped. A compiled package defines the terms, links, shapes and constraints used by queries and materializations. Read bindings connect those terms to workspace endpoint records. A definition, compiled package and record result are different resources.

Inspect the compiled package

With ontologies:read and a project UUID:

curl --fail-with-body -H "Authorization: Bearer $SEMOGRAM_API_KEY" \
  "https://platform.semogram.com/api/v1/projects/$SEMOGRAM_PROJECT_ID/ontology"

The response contains ontology with package metadata and collection counts. If there is no compiled package, expect a not-found response rather than an automatically generated ontology.

The ontology family includes versions, terms, links, shapes, constraints and imports, plus term-record reads and compilation. Definition routes support authoring, version history, branch comparison and activation. The catalog lists each method rather than assuming every collection supports CRUD.

Read bindings

GET /ontology/read-bindings accepts ontologyPackageId, dataEndpointId, status and list paging, returning {bindings, pagination}. POST creates a validated binding using bindings:write; detail GET/PUT/DELETE manages the selected binding.

A binding must reference a compatible ontology package, term and actual workspace endpoint. Validation checks those references and mapping. Required named permissions constrain consumers independently of query operation scopes. Saving a binding does not copy database records or materialize facts.

Choose the operation

Use definition/version actions to change meaning, compile to produce a usable package, bindings to configure source access and published query execution to retrieve a consumer result. Pipeline materialization and prediction work are separate workflows; do not assume an ontology GET performs them. The Ontology section explains complete definitions, assertions, materialization and query scenarios.