Skip to content

Models

Pydantic v2 models for all Crucible API objects. All models are importable from crucible.models or directly from crucible.

from crucible.models import Dataset, Sample, Project, Instrument, InstrumentReference, ProjectReference, User, PublicUser, ResourceCapabilities, DeletionRequest

crucible.models.Project

crucible.models.Dataset

crucible.models.InstrumentReference

Lightweight instrument identity embedded in dataset responses.

crucible.models.ProjectReference

Lightweight project identity embedded in dataset responses.

crucible.models.Sample

crucible.models.Instrument

crucible.models.User

crucible.models.PublicUser

Public-safe user record embedded in resource responses.

crucible.models.ResourceCapabilities

Caller-specific actions available for an exact resource response.

crucible.models.EffectiveResourceAccess

A user's effective permission on one resource.

crucible.models.DeletionRequest

A pending or resolved request to delete a resource.