Create Stream

Full create stream request.

Request

Property	Value
Method	`POST`
URL	`https://api.stormstreaming.com/api/request/stream`
Authentication	`x-api-key`

Request

bash

curl -X POST "https://api.stormstreaming.com/api/request/stream" \
  -H "x-api-key: YOUR_API_KEY"

Request Body

Field	Default	Required	Validation	Description
`name`	-	Yes	String 1-255 chars	Stream name
`description`	-	No	String 1-2000 chars	Stream description
`regionId`	-	Yes	Int (see regions table)	Region closest to stream source
`countdown`	0	No	Int 0/1	Display countdown before stream
`countdownStartDate`	-	If countdown=1	d.m.Y H:i:s	Planned publish date
`countdownTimezone`	-	If countdown=1	See Get Possible Values	Timezone for countdown
`isPublished`	1	No	Int 0/1	0=not published, 1=published
`sourceType`	PUSH	No	String PUSH/PULL	PUSH for encoders, PULL for external servers
`sourceId`	-	If sourceType=PULL	Int	Source ID from stream-sources
`encoderMode`	PASSTHROUGH	No	String PASSTHROUGH/ABR	PASSTHROUGH or Adaptive Bitrate
`themeId`	-	No	Int	Custom theme ID
`thumbnailFile`	-	No	jpeg,png,jpg,gif,webp max 8192KB	Thumbnail image
`splashscreenFile`	-	No	jpeg,png,jpg,gif,webp max 8192KB	Countdown background image

Available Regions:

regionId	Region
1	North America (East Coast)
2	North America (West Coast)
3	South America
4	Europe
5	Asia Pacific (China)
6	Asia Pacific (South Korea)
7	Asia Pacific (Japan)
8	Australia
9	Africa

Request Body

json

{
  "name": "My stream",
  "description": "Stream description",
  "regionId": 1,
  "countdown": 0,
  "isPublished": 1,
  "sourceType": "PUSH",
  "encoderMode": "PASSTHROUGH"
}

Response

Parameter	Type	Description
`message`	string	Response status message
`stream.streamKey`	string	Unique stream key identifier
`stream.name`	string	Name of the stream
`stream.description`	string	Stream description (nullable)
`stream.regionId`	integer	Region ID
`stream.isPublished`	boolean	Whether the stream is published
`stream.countdown`	object	Countdown configuration
`stream.sourceType`	string	Source type (PUSH/PULL)
`stream.encoderMode`	string	Encoder mode (PASSTHROUGH/ABR)
`stream.credentials`	object	RTMP authentication credentials
`stream.credentials.username`	string	Username for authorization
`stream.credentials.password`	string	Password for authorization
`stream.theme`	object	Player theme configuration
`stream.isCreated`	boolean	Stream creation status
`stream.createdAt`	string	Creation timestamp (ISO 8601)

Successful Response (200)

json

{
  "message": "Stream has been created",
  "stream": {
    "streamKey": "9ed8b119f8ed9425a428a47846e55c6b761afc6c",
    "name": "My stream",
    "description": null,
    "regionId": 1,
    "isPublished": true,
    "countdown": {
      "isCountdown": false,
      "startDate": null,
      "timezone": null
    },
    "sourceType": "PUSH",
    "encoderMode": "PASSTHROUGH",
    "credentials": {
      "username": "902aee51",
      "password": "f9aef6eac1d977d"
    },
    "thumbnail": null,
    "splashscreen": null,
    "source": null,
    "targets": [],
    "themeId": 54,
    "theme": {
      "id": 54,
      "name": "test",
      "isDefault": 1
    },
    "isCreated": true,
    "createdAt": "2024-01-25T11:10:53.000000Z"
  }
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.