For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
The number of requests permitted in the current rate limit window.
X-RateLimit-RemainingintegerOptional
The number of requests still available in the current rate limit window. When several limits apply, this reflects the per-API-key limit, so a request can be rejected while this value is above zero.
X-RateLimit-ResetintegerOptional
The number of seconds until the current rate limit window resets.
Response
The requested sample.
idstringformat: "^spl_[a-zA-Z0-9]{10,22}$"
Unique identifier for a sample.
sample_idstring<=255 characters
The human-readable identifier written on the sample itself. This is a label, not an API identifier — use id to address the sample through the API.
sample_definition_idstring or nullformat: "^sdf_[a-zA-Z0-9]{10,22}$"
The sample definition describing what was collected. Null for a sample recorded without one.
typestring or null<=255 characters
What was collected. Free-form text drawn from your team’s configuration rather than a fixed set of values.
labelstring or null<=20 characters
The short label your team has given the sample type, for use where the full type name does not fit.
statusenum
Whether a sample has been collected yet. A planned sample was scheduled from a sample definition but not yet taken.
Allowed values:
timepointstring or nullformat: "^-?P(?:[0-9]+D)?(?:T(?:[0-9]+H)?(?:[0-9]+M)?(?:[0-9]+(?:\.[0-9]+)?S)?)?$"
When the sample is due, as an offset from the study event it hangs off. Null for a sample that is not scheduled.
collected_atdatetime or null
The time the sample was collected. Null while the sample is only planned.
detailslist of objects
The attributes measured on the sample.
commentsstring or null
Any note recorded alongside the sample.
metadatamap from strings to any or null
The metadata associated to the sample.
studyobject or null
The study the sample was collected under. Null when the animal is not on a study.
animalobject
The animal a record belongs to, as embedded in dosages, measurements, observations and samples. Carries the same attributes as an animal retrieved directly, except that the cage, study and treatment group are given as identifiers rather than embedded objects.
userobject or null
The user who collected the sample.
created_atdatetime
UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.
updated_atdatetime
UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.
