Bulk Create Sample Annotations

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()

curl -X POST "https://api.atomscale.ai/physical_samples/a1b2c3d4-5678-90ab-cdef-1234567890ab/annotations/bulk" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "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
      }
    ]
  }'

[
  {
    "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"
  }
]

POST

physical_samples

{physical_sample_id}

annotations

bulk

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()

curl -X POST "https://api.atomscale.ai/physical_samples/a1b2c3d4-5678-90ab-cdef-1234567890ab/annotations/bulk" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "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
      }
    ]
  }'

[
  {
    "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"
  }
]

Creates several spatial annotations on a physical sample in a single request. Send the annotations as an array in the request body.

string

required

UUID of the physical sample

array

required

Array of annotations to create. Each item has the same shape as the body of a single annotation create request.

Show properties

string

required

Name of the property being annotated

number

required

Value of the annotated property

string

Coordinate reference frame. One of sample_relative or stage_absolute.

string

Units for the coordinate values

number

X coordinate of the annotation

number

Y coordinate of the annotation

number

Z coordinate of the annotation

string

Unit for the property value

string

Characterization source type

string

UUID of the data item the annotation is derived from

object

Arbitrary key-value metadata for the annotation

Response

Returns an array of the created 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.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()

curl -X POST "https://api.atomscale.ai/physical_samples/a1b2c3d4-5678-90ab-cdef-1234567890ab/annotations/bulk" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "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
      }
    ]
  }'

[
  {
    "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"
  }
]

Introduction

Data Catalogue

Data Upload

Projects

Physical Samples

RHEED

SEM

Spectroscopy

OES

SIMS

Optical

Tool State

Tags

Target Materials

Instruments

Response