Skip to main content
POST
/
metrology
/
stream
/
initialize
from atomscale.streaming import TimeseriesStreamer

streamer = TimeseriesStreamer(api_key="YOUR_API_KEY", points_per_chunk=100)
data_id = streamer.initialize(
    stream_name="MBE Run 2024-01-15 Thickness Monitor",
    physical_sample="GaN-001",
    project_id="d290f1ee-6c54-4b01-90e6-d701748f0851",
)

{
  "data_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "processed_data_id": "e3a1b2c3-4567-89ab-cdef-234567890abc"
}

Documentation Index

Fetch the complete documentation index at: https://docs.atomscale.ai/llms.txt

Use this file to discover all available pages before exploring further.

Creates a new metrology streaming session by initializing data catalogue and processed metrology catalogue entries. Returns a data_id to use for subsequent chunk uploads.
​
points_per_chunk
integer
required
Number of points per chunk (fixed for the duration of the stream). Must be greater than 0.
​
stream_name
string
Human-readable name for the stream
​
synth_source_id
integer
Growth instrument ID to link. Must belong to your organization.
​
physical_sample_id
string
UUID of an existing physical sample to associate with this stream
​
project_id
string
UUID of a project to associate with this stream

​
Response

​
data_id
string
required
UUID for the newly created stream. Use this ID for subsequent chunk uploads and finalization.
​
processed_data_id
string
UUID for the processed data entry
from atomscale.streaming import TimeseriesStreamer

streamer = TimeseriesStreamer(api_key="YOUR_API_KEY", points_per_chunk=100)
data_id = streamer.initialize(
    stream_name="MBE Run 2024-01-15 Thickness Monitor",
    physical_sample="GaN-001",
    project_id="d290f1ee-6c54-4b01-90e6-d701748f0851",
)

{
  "data_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "processed_data_id": "e3a1b2c3-4567-89ab-cdef-234567890abc"
}