Creates several spatial annotations on a physical sample in a single request. Send the annotations as an array in the request body.
UUID of the physical sample
Array of annotations to create. Each item has the same shape as the body of a single annotation create request.
Name of the property being annotated
Value of the annotated property
Coordinate reference frame. One of sample_relative or stage_absolute.
Units for the coordinate values
X coordinate of the annotation
Y coordinate of the annotation
Z coordinate of the annotation
Unit for the property value
Characterization source type
UUID of the data item the annotation is derived from
Arbitrary key-value metadata for the annotation
Response
Returns an array of the created spatial annotation objects.
UUID of the physical sample the annotation belongs to
Name of the annotated property
Value of the annotated property
Unit for the property value, or null if not set
Characterization source type, or null if not set
Coordinate reference frame. One of sample_relative or stage_absolute.
Units for the coordinate values, or null if not set
X coordinate of the annotation, or null if not set
Y coordinate of the annotation, or null if not set
Z coordinate of the annotation, or null if not set
UUID of the data item the annotation is derived from, or null if not set
Arbitrary key-value metadata, or null if not set
ISO 8601 timestamp of the last update
Version string of the annotation record
import requests
response = requests.post(
"https://api.atomscale.ai/physical_samples/a1b2c3d4-5678-90ab-cdef-1234567890ab/annotations/bulk",
headers={
"X-API-KEY": "YOUR_API_KEY",
"Content-Type": "application/json"
},
json={
"annotations": [
{
"property_name": "thickness",
"property_value": 25.1,
"coord_ref_frame": "sample_relative",
"coord_units": "mm",
"coord_x": 1.5,
"coord_y": 2.0
},
{
"property_name": "thickness",
"property_value": 24.8,
"coord_ref_frame": "sample_relative",
"coord_units": "mm",
"coord_x": 3.0,
"coord_y": 2.0
}
]
}
)
annotations = response.json()
[
{
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"physical_sample_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"property_name": "thickness",
"property_value": 25.1,
"property_unit": null,
"char_source_type": null,
"coord_ref_frame": "sample_relative",
"coord_units": "mm",
"coord_x": 1.5,
"coord_y": 2.0,
"coord_z": null,
"data_id": null,
"annotation_metadata": null,
"last_updated": "2024-01-16T09:30:00Z",
"version": "0.269.1"
}
]
