Skip to main content
POST
Starts a new RHEED streaming session by creating a streaming data item for live analysis during growth.
​
string
required
Name for the streaming session
​
number
required
Frame capture rate in frames per second (must be greater than 0, max 120)
​
string
Project to associate the stream with
​
string
Physical sample being monitored
​
string
If set, creates a new physical sample with this name and associates it with the stream
​
number
Rotational period in seconds (for rotating samples)
​
integer
Rotations per minute (for rotating samples)
​
boolean
default:"false"
If true, return an object with both data_id and physical_sample_id instead of the bare data entry UUID. Useful when create_physical_sample_name is set and you need the ID of the newly created sample.

​
Response

By default, returns the UUID of the newly created streaming data entry. When return_physical_sample=true, returns an object with data_id and physical_sample_id instead.