List Sample Annotations

import requests

response = requests.get(
    "https://api.atomscale.ai/physical_samples/a1b2c3d4-5678-90ab-cdef-1234567890ab/annotations/",
    headers={"X-API-KEY": "YOUR_API_KEY"},
    params={"property_name": "thickness"}
)
annotations = response.json()

curl "https://api.atomscale.ai/physical_samples/a1b2c3d4-5678-90ab-cdef-1234567890ab/annotations/?property_name=thickness" \
  -H "X-API-KEY: YOUR_API_KEY"

[
  {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "physical_sample_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "property_name": "thickness",
    "property_value": 25.1,
    "property_unit": "nm",
    "char_source_type": "xrd",
    "coord_ref_frame": "sample_relative",
    "coord_units": "mm",
    "coord_x": 1.5,
    "coord_y": 2.0,
    "coord_z": null,
    "data_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "annotation_metadata": null,
    "last_updated": "2024-01-16T09:30:00Z",
    "version": "0.269.1"
  }
]

GET

physical_samples

{physical_sample_id}

annotations

import requests

response = requests.get(
    "https://api.atomscale.ai/physical_samples/a1b2c3d4-5678-90ab-cdef-1234567890ab/annotations/",
    headers={"X-API-KEY": "YOUR_API_KEY"},
    params={"property_name": "thickness"}
)
annotations = response.json()

curl "https://api.atomscale.ai/physical_samples/a1b2c3d4-5678-90ab-cdef-1234567890ab/annotations/?property_name=thickness" \
  -H "X-API-KEY: YOUR_API_KEY"

[
  {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "physical_sample_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "property_name": "thickness",
    "property_value": 25.1,
    "property_unit": "nm",
    "char_source_type": "xrd",
    "coord_ref_frame": "sample_relative",
    "coord_units": "mm",
    "coord_x": 1.5,
    "coord_y": 2.0,
    "coord_z": null,
    "data_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "annotation_metadata": null,
    "last_updated": "2024-01-16T09:30:00Z",
    "version": "0.269.1"
  }
]

Returns the spatial annotations recorded on a physical sample. Use the query parameters to filter by property, characterization source, or a spatial bounding box.

string

required

UUID of the physical sample

string

Filter to annotations with this property name

string

Filter to annotations from this characterization source type

number

Lower bound on the x coordinate for spatial filtering

number

Upper bound on the x coordinate for spatial filtering

number

Lower bound on the y coordinate for spatial filtering

number

Upper bound on the y coordinate for spatial filtering

Response

Returns an array of spatial annotation objects.

string

Annotation UUID

string

UUID of the physical sample the annotation belongs to

string

Name of the annotated property

number

Value of the annotated property

string

Unit for the property value, or null if not set

string

Characterization source type, or null if not set

string

Coordinate reference frame. One of sample_relative or stage_absolute.

string

Units for the coordinate values, or null if not set

number

X coordinate of the annotation, or null if not set

number

Y coordinate of the annotation, or null if not set

number

Z coordinate of the annotation, or null if not set

string

UUID of the data item the annotation is derived from, or null if not set

object

Arbitrary key-value metadata, or null if not set

string

ISO 8601 timestamp of the last update

string

Version string of the annotation record

import requests

response = requests.get(
    "https://api.atomscale.ai/physical_samples/a1b2c3d4-5678-90ab-cdef-1234567890ab/annotations/",
    headers={"X-API-KEY": "YOUR_API_KEY"},
    params={"property_name": "thickness"}
)
annotations = response.json()

curl "https://api.atomscale.ai/physical_samples/a1b2c3d4-5678-90ab-cdef-1234567890ab/annotations/?property_name=thickness" \
  -H "X-API-KEY: YOUR_API_KEY"

[
  {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "physical_sample_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "property_name": "thickness",
    "property_value": 25.1,
    "property_unit": "nm",
    "char_source_type": "xrd",
    "coord_ref_frame": "sample_relative",
    "coord_units": "mm",
    "coord_x": 1.5,
    "coord_y": 2.0,
    "coord_z": null,
    "data_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "annotation_metadata": null,
    "last_updated": "2024-01-16T09:30:00Z",
    "version": "0.269.1"
  }
]

Update Sample Target Material

Create Sample Annotation

Introduction

Data Catalogue

Data Upload

Projects

Physical Samples

RHEED

SEM

Spectroscopy

OES

SIMS

Optical

Metrology

Tags

Target Materials

Instruments

Response

​Response

Response