> ## Documentation Index
> Fetch the complete documentation index at: https://docs.livepeer.org/llms.txt
> Use this file to discover all available pages before exploring further.

> The Livestream API is used to create, retrieve, update, delete stream object from pipeline.

# Overview

### Stream Object

<ResponseField name="id" type="string" readOnly="true">
  Unique identifier for the stream.
</ResponseField>

<ResponseField name="name" type="string">
  Name of the stream.
</ResponseField>

<ResponseField name="creatorId" type="string">
  Reference to the creator-id schema.
</ResponseField>

<ResponseField name="lastSeen" type="number">
  Timestamp of the last activity on the stream.
</ResponseField>

<ResponseField name="sourceSegments" type="number">
  Number of source segments.
</ResponseField>

<ResponseField name="transcodedSegments" type="number">
  Number of transcoded segments.
</ResponseField>

<ResponseField name="sourceSegmentsDuration" type="number">
  Duration of all the source segments in seconds.
</ResponseField>

<ResponseField name="transcodedSegmentsDuration" type="number">
  Duration of all the transcoded segments in seconds.
</ResponseField>

<ResponseField name="sourceBytes" type="number">
  Total bytes of source segments.
</ResponseField>

<ResponseField name="transcodedBytes" type="number">
  Total bytes of transcoded segments.
</ResponseField>

<ResponseField name="ingestRate" type="number">
  Rate at which sourceBytes increases (bytes/second).
</ResponseField>

<ResponseField name="outgoingRate" type="number">
  Rate at which transcodedBytes increases (bytes/second).
</ResponseField>

<ResponseField name="isActive" type="boolean">
  Indicates if the stream is currently active.
</ResponseField>

<ResponseField name="isHealthy" type="object">
  Reference to the stream-health-payload schema for health status.
</ResponseField>

<ResponseField name="issues" type="object">
  Reference to the stream-health-payload schema for human-readable issues.
</ResponseField>

<ResponseField name="createdByTokenName" type="string" readOnly="true">
  Name of the token used to create this stream.
</ResponseField>

<ResponseField name="createdAt" type="number" readOnly="true">
  Timestamp (in milliseconds) of when the stream object was created.
</ResponseField>

<ResponseField name="parentId" type="string">
  Identifier for the parent stream object.
</ResponseField>

<ResponseField name="streamKey" type="string">
  Key used to form the RTMP ingest URL.
</ResponseField>

<ResponseField name="playbackId" type="string">
  Identifier used to form the playback URL.
</ResponseField>

<ResponseField name="playbackPolicy" type="object">
  Reference to the playback-policy schema.
</ResponseField>

<ResponseField name="profiles" type="array">
  Array of profiles detailing various streaming qualities.
</ResponseField>

<ResponseField name="record" type="boolean">
  Indicates if the stream should be recorded.
</ResponseField>

<ResponseField name="multistream" type="object">
  Details about multistreaming targets and their configurations.
</ResponseField>

<ResponseField name="suspended" type="boolean">
  Indicates if the stream is currently suspended.
</ResponseField>

<ResponseExample>
  ```json Response theme={"theme":{"light":"github-light","dark":"dark-plus"}}
  {
    "id": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
    "name": "test_stream",
    "creatorId": "object",
    "lastSeen": 1587667174725,
    "sourceSegments": 1,
    "transcodedSegments": 2,
    "sourceSegmentsDuration": 1,
    "transcodedSegmentsDuration": 2,
    "sourceBytes": 1,
    "transcodedBytes": 2,
    "ingestRate": 1,
    "outgoingRate": 2,
    "isActive": "boolean",
    "isHealthy": true,
    "issues": ["Buffer underflow", "Network congestion"],
    "createdByTokenName": "staging key",
    "createdAt": 1587667174725,
    "parentId": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
    "streamKey": "hgebdhhigq",
    "playbackId": "eaw4nk06ts2d0mzb",
    "playbackPolicy": {
      "type": "public",
      "webhookId": "3e02c844-d364-4d48-b401-24b2773b5d6c",
      "webhookContext": {
        "foo": "bar"
      }
    },
    "profiles": [
      {
        "name": "720p",
        "width": 1280,
        "height": 720,
        "bitrate": 3000,
        "fps": 30
      }
    ],
    "record": "boolean",
    "multistream": {
      "targets": [
        {
          "id": "PUSH123",
          "profile": "720p"
        }
      ]
    },
    "suspended": "boolean"
  }
  ```
</ResponseExample>