For the complete documentation index, see llms.txt. This page is also available as Markdown.

Ontology resources

List, filter, retrieve, create, and save Workspace Ontologies.

Outcome: List, filter, retrieve, create, and save Workspace Ontologies.

for ontology in client.ontologies.list(data_type="image"):
    print(ontology.id, ontology.title)

ontology = client.ontologies.get("ONTOLOGY_HASH")
ontology.description = "Updated policy"
ontology.save()

project = client.projects.create(
    "Cat review",
    ontology_hash=ontology.id,
)

ontologies.create(title, description="", structure=None, data_type="image") accepts an OntologyStructure or compatible structure data. Project attachment copies the Workspace Ontology so Unitlab can preserve project-specific version history.

Operating contract

Concern
Required behavior

Execution surface

Pinned unitlab==3.0.0 application environment on Python 3.10+.

Identity

Least-privilege API key supplied through approved configuration.

Target resolution

Stable resource IDs and an explicitly bounded target set.

Success evidence

Typed return fields, server-side state, and downstream acceptance of the result.

Failure and recovery boundary

Condition
Response

Authentication or authorization fails

Stop, correct the service identity or access model, rotate exposed credentials, and rerun a read-only check.

Validation or entitlement rejects the operation

Correct the input or entitlement; do not retry an unchanged request.

A request times out

Inspect remote state before repeating a mutation because the server may have accepted it.

Asynchronous processing exceeds its deadline

Preserve the Batch Queue or release ID, continue bounded monitoring, and inspect item-level failures.

Only part of a batch succeeds

Keep successful identifiers, isolate failed rows, and retry only the corrected subset.


Related Unitlab capability guides: enterprise data annotation workflows