Skip to main content
GET
/
rheed
/
stream
/
{data_id}
import requests

response = requests.get(
    "https://api.atomscale.ai/rheed/stream/d290f1ee-6c54-4b01-90e6-d701748f0851",
    headers={"X-API-KEY": "YOUR_API_KEY"}
)
settings = response.json()

{
  "data_item_name": "MBE Run 2024-01-15 AM",
  "fps_capture_rate": 30.0,
  "project_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "physical_sample_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "create_physical_sample_name": null,
  "rotational_period": null,
  "rotations_per_min": null
}
Retrieves the settings that a RHEED streaming session was created with, such as its capture rate and any associated project or physical sample.
​
data_id
string
required
The data entry UUID for the streaming session

​
Response

​
data_item_name
string
Name of the streaming session
​
fps_capture_rate
number
Frame capture rate of the recording source in frames per second
​
project_id
string
Project associated with the stream
​
physical_sample_id
string
Physical sample associated with the stream
​
create_physical_sample_name
string
Name of the physical sample to create if it does not exist. Only used when physical_sample_id is not provided.
​
rotational_period
number
For rotating samples, the period in frames per rotation
​
rotations_per_min
integer
For rotating samples, the number of rotations per minute
import requests

response = requests.get(
    "https://api.atomscale.ai/rheed/stream/d290f1ee-6c54-4b01-90e6-d701748f0851",
    headers={"X-API-KEY": "YOUR_API_KEY"}
)
settings = response.json()

{
  "data_item_name": "MBE Run 2024-01-15 AM",
  "fps_capture_rate": 30.0,
  "project_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "physical_sample_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "create_physical_sample_name": null,
  "rotational_period": null,
  "rotations_per_min": null
}