> ## 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.

# Start RHEED Stream

> Start a new RHEED streaming session

Starts a new RHEED streaming session by creating a streaming data item for live analysis during growth.

<ParamField body="data_item_name" type="string" required>
  Name for the streaming session
</ParamField>

<ParamField body="fps_capture_rate" type="number" required>
  Frame capture rate in frames per second (must be greater than 0, max 120)
</ParamField>

<ParamField body="project_id" type="string">
  Project to associate the stream with
</ParamField>

<ParamField body="physical_sample_id" type="string">
  Physical sample being monitored
</ParamField>

<ParamField body="create_physical_sample_name" type="string">
  If set, creates a new physical sample with this name and associates it with the stream
</ParamField>

<ParamField body="rotational_period" type="number">
  Rotational period in seconds (for rotating samples)
</ParamField>

<ParamField body="rotations_per_min" type="integer">
  Rotations per minute (for rotating samples)
</ParamField>

## Response

Returns the UUID of the newly created streaming data entry.

<RequestExample>
  ```python SDK theme={null}
  from atomscale.streaming import RHEEDStreamer

  streamer = RHEEDStreamer(api_key="YOUR_API_KEY")
  data_id = streamer.initialize(
      fps=30.0,
      rotations_per_min=0.0,
      chunk_size=60,
      stream_name="MBE Run 2024-01-15 AM",
      physical_sample="GaN-001",
      project_id="d290f1ee-6c54-4b01-90e6-d701748f0851",
  )
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      "https://api.atomscale.ai/rheed/stream/",
      headers={
          "X-API-KEY": "YOUR_API_KEY",
          "Content-Type": "application/json"
      },
      json={
          "data_item_name": "MBE Run 2024-01-15 AM",
          "fps_capture_rate": 30,
          "project_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "physical_sample_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab"
      }
  )
  data_id = response.json()
  ```

  ```bash cURL theme={null}
  curl -X POST "https://api.atomscale.ai/rheed/stream/" \
    -H "X-API-KEY: YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "data_item_name": "MBE Run 2024-01-15 AM",
      "fps_capture_rate": 30,
      "project_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "physical_sample_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab"
    }'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  "d290f1ee-6c54-4b01-90e6-d701748f0851"
  ```
</ResponseExample>