Video API, REST: StreamLine.Create

Written by

Updated at April 24, 2025

HTTP request
Body parameters
RTMPPullParams
Response
CreateStreamLineMetadata
Status
StreamLine
RTMPPushInput
RTMPPullInput
AutoLine

Create stream line.

HTTP request

POST https://video.api.cloud.yandex.net/video/v1/streamLines

Body parameters

{
  "channelId": "string",
  "title": "string",
  "thumbnailId": "string",
  "labels": "object",
  // Includes only one of the fields `rtmpPush`, `rtmpPull`
  "rtmpPush": "object",
  "rtmpPull": {
    "url": "string"
  },
  // end of the list of possible fields
  // Includes only one of the fields `manualLine`, `autoLine`
  "manualLine": "object",
  "autoLine": "object"
  // end of the list of possible fields
}

Field	Description
channelId	string Required field. ID of the channel.
title	string Required field. Line title.
thumbnailId	string ID of the thumbnail.
labels	object (map<string, string>) Custom labels as `key:value` pairs. Maximum 64 per resource.
rtmpPush	object RTMP push input type. Includes only one of the fields `rtmpPush`, `rtmpPull`. Video signal settings.
rtmpPull	RTMPPullParams RTMP pull input type. Includes only one of the fields `rtmpPush`, `rtmpPull`. Video signal settings.
manualLine	object Manual control of stream. Includes only one of the fields `manualLine`, `autoLine`. Line type.
autoLine	object Automatic control of stream. Includes only one of the fields `manualLine`, `autoLine`. Line type.

RTMPPullParams

Field

Description

url

string

Required field. URL of a RTMP streaming server.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "streamLineId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "channelId": "string",
    "title": "string",
    "thumbnailId": "string",
    // Includes only one of the fields `rtmpPush`, `rtmpPull`
    "rtmpPush": {
      "url": "string"
    },
    "rtmpPull": {
      "url": "string"
    },
    // end of the list of possible fields
    // Includes only one of the fields `manualLine`, `autoLine`
    "manualLine": "object",
    "autoLine": {
      "status": "string"
    },
    // end of the list of possible fields
    "createdAt": "string",
    "updatedAt": "string",
    "labels": "object"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
done	boolean If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	CreateStreamLineMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	StreamLine The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

CreateStreamLineMetadata

Field

Description

streamLineId

string

ID of the line.

Status

The error result of the operation in case of failure or cancellation.

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

StreamLine

Entity that is responsible for the incoming video signal settings.

Field	Description
id	string ID of the line.
channelId	string ID of the channel to which this stream line belongs.
title	string Title of the stream line.
thumbnailId	string ID of the thumbnail image associated with the stream line..
rtmpPush	RTMPPushInput Real-Time Messaging Protocol (RTMP) push input settings. Includes only one of the fields `rtmpPush`, `rtmpPull`. Specifies the input type and settings for the video signal source.
rtmpPull	RTMPPullInput Real-Time Messaging Protocol (RTMP) pull input type. Includes only one of the fields `rtmpPush`, `rtmpPull`. Specifies the input type and settings for the video signal source.
manualLine	object Manual control of stream. Includes only one of the fields `manualLine`, `autoLine`. Specifies the control type of the stream line.
autoLine	AutoLine Automatic control of stream. Includes only one of the fields `manualLine`, `autoLine`. Specifies the control type of the stream line.
createdAt	string (date-time) Time when the stream line was created. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
updatedAt	string (date-time) Time when the stream line was last updated. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
labels	object (map<string, string>) Custom labels as `key:value` pairs. Maximum 64 per resource.

RTMPPushInput

Settings for an RTMP (Real-Time Messaging Protocol) push input.
Used when the video stream is pushed to an RTMP server.
@see https://en.wikipedia.org/wiki/Real-Time_Messaging_Protocol

Field

Description

url

string

RTMP server url.

RTMPPullInput

Settings for an RTMP pull input.
Used when the service pulls the video stream from an RTMP source.
@see https://en.wikipedia.org/wiki/Real-Time_Messaging_Protocol

Field

Description

url

string

RTMP url for receiving video signal.

AutoLine

Represents an automatic line type where the stream control is handled automatically.

Field

Description

status

enum (AutoLineStatus)

The status of the automatic line.

AUTO_LINE_STATUS_UNSPECIFIED: Auto line status unspecified.
DEACTIVATED: The automatic line is deactivated and not currently active.
ACTIVE: The automatic line is active and operational.

Video API, REST: StreamLine.Create

HTTP requestHTTP request

Body parametersBody parameters

RTMPPullParamsRTMPPullParams

ResponseResponse

CreateStreamLineMetadataCreateStreamLineMetadata

StatusStatus

StreamLineStreamLine

RTMPPushInputRTMPPushInput

RTMPPullInputRTMPPullInput

AutoLineAutoLine

Was the article helpful?

HTTP request

Body parameters

RTMPPullParams

Response

CreateStreamLineMetadata

Status

StreamLine

RTMPPushInput

RTMPPullInput

AutoLine