Create a Live

POST /v1/lives

Create a Live

application/json

Body Required

title string Required

The title of the Live
description string

Description of the Live (in Markdown)
spotMemberHostId string Required

The Spot member host of the Live
startDate integer Required

Start date of the Live (Unix timestamp format)
endDate integer Required

End date of the Live (Unix timestamp format)
solution string Required

Solution of the Live

Values are Youtube, Vimeo, BuiltIn, or NoSolution.
builtInType string | null

BuiltIn type of the Live (if solution is BuiltIn)

Values are Workshop or Conference.
videoUrl object | null

Video URL of the Live (if solution is Youtube or Vimeo)
chatVisibility string

The chat visibility on the Live

Values are Display or Hidden.
participantsVisibility string

The participant list visibility on the Live

Values are Display or Hidden.
visibility string

The Live visibility

Values are AnyOne, OnlySpotMembers, or InvitedMembersOnly.
participation string

Who kind of members can participate to the Live

Values are AnySpotMembers or InvitedMembersOnly.
record boolean

Active the record on the Live
enableBreakoutRooms boolean

Enable breakout rooms on the Live (only for BuiltIn Workshop lives)

Responses

201 application/json

Live has been successfully created
Hide response attributes Show response attributes object
- id string Required
  
  The id of the Live.
- title string Required
  
  The title of the Live.
- startDate string(date-time) Required
  
  The startDate of the Live.
- endDate string(date-time) Required
  
  The endDate of the Live.
- metrics object Required
  
  The metrics of the Live.
  
  Hide metrics attributes Show metrics attributes object
  
  averageViewTime integer | null Required
  
  The average view time on the Live.
  
  noShow integer | null Required
  
  The counter of no show of the Live.
  
  totalReplayView integer | null Required
  
  The counter of total replay viewed on the Live.
  
  registrant integer | null Required
  
  The counter of registrant on the Live.
  
  attendee integer | null Required
  
  The counter of attendee on the Live.
  
  attendanceRate integer | null Required
  
  The attendance rate on the Live.
  
  invited integer | null Required
  
  The counter of invited on the Live.
- description array[object] Required
  
  The description of the Live.
- status string Required
  
  The status of the Live.
  
  Values are Ended, Planned, or Live.
- computedStatus string Required
  
  The computed status of the Live.
  
  Values are Ended, Planned, or Live.
- solution string Required
  
  The solution of the Live.
  
  Values are Youtube, Vimeo, BuiltIn, or NoSolution.
- privacy object Required
  
  The privacy of the Live.
  
  Hide privacy attributes Show privacy attributes object
  
  visibility string Required
  
  The visibility of the Live
  
  Values are AnyOne, OnlySpotMembers, or InvitedMembersOnly.
  
  participation string Required
  
  What kind of members can participate to the Live
  
  Values are AnySpotMembers or InvitedMembersOnly.
- config object Required
  
  The configuration of the Live.
  
  Hide config attributes Show config attributes object
  
  chatVisibility string Required
  
  The chat visibility on the Live
  
  Values are Display or Hidden.
  
  participantsVisibility string Required
  
  The participants visibility on the Live.
  
  Values are Ended, Planned, or Live.
- builtInType string | null Required
  
  The builtIn type of the Live.
  
  Values are Workshop or Conference.
- videoUrl object | null Required
  
  The video URL of the Live.
- createdAt string(date-time) Required
  
  The creation date of the Live.
- spotId string Required
  
  The spot ID of the Live.
- builtInConfig object | null Required
  
  The builtIn configuration of the Live.
  
  Hide builtInConfig attributes Show builtInConfig attributes object | null
  
  isRecorded boolean Required
  
  Indicates if the Live is recorded
  
  recordAvailable boolean Required
  
  If Live is recorded, indicates if the record is available
  
  enableBreakoutRooms boolean Required
  
  Indicates if the Live has breakout rooms enabled
  
  enableRaiseHand boolean Required
  
  Indicates if the Live has raise hand enabled
  
  enablePictureInPicture boolean Required
  
  Indicates if the Live has picture-in-picture enabled
  
  videos object Required
  
  Videos of the replay in multiple formats
  
  Hide videos attributes Show videos attributes object
  
  url string Required
  
  URL to the video
  
  quality string Required
  
  Quality of the video
  
  encoding string Required
  
  Encoding of the video
  
  Values are hls or mp4.
  
  createdAt string(date-time) | null Required
  
  Creation date of the video
  
  replayVideo object | null Required
  
  URL to video replay
400

Malformed payload

POST /v1/lives

curl \
 --request POST 'https://openapi.meltingspot.io/v1/lives' \
 --header "Content-Type: application/json" \
 --data '{"title":"string","description":"string","spotMemberHostId":"string","startDate":42,"endDate":42,"solution":"Youtube","builtInType":"Workshop","videoUrl":{},"chatVisibility":"Display","participantsVisibility":"Display","visibility":"AnyOne","participation":"AnySpotMembers","record":true,"enableBreakoutRooms":true}'

Request examples

{
  "title": "string",
  "description": "string",
  "spotMemberHostId": "string",
  "startDate": 42,
  "endDate": 42,
  "solution": "Youtube",
  "builtInType": "Workshop",
  "videoUrl": {},
  "chatVisibility": "Display",
  "participantsVisibility": "Display",
  "visibility": "AnyOne",
  "participation": "AnySpotMembers",
  "record": true,
  "enableBreakoutRooms": true
}

Response examples (201)

{
  "id": "string",
  "title": "string",
  "startDate": "2025-05-04T09:42:00Z",
  "endDate": "2025-05-04T09:42:00Z",
  "metrics": {
    "averageViewTime": 42,
    "noShow": 42,
    "totalReplayView": 42,
    "registrant": 42,
    "attendee": 42,
    "attendanceRate": 42,
    "invited": 42
  },
  "description": [
    {
      "type": "p",
      "children": [
        {
          "text": "My new live"
        }
      ]
    }
  ],
  "status": "Ended",
  "computedStatus": "Ended",
  "solution": "Youtube",
  "privacy": {
    "visibility": "AnyOne",
    "participation": "AnySpotMembers"
  },
  "config": {
    "chatVisibility": "Display",
    "participantsVisibility": "Ended"
  },
  "builtInType": "Workshop",
  "videoUrl": {},
  "createdAt": "2025-05-04T09:42:00Z",
  "spotId": "string",
  "builtInConfig": {
    "isRecorded": true,
    "recordAvailable": true,
    "enableBreakoutRooms": true,
    "enableRaiseHand": true,
    "enablePictureInPicture": true,
    "videos": {
      "url": "string",
      "quality": "string",
      "encoding": "hls",
      "createdAt": "2025-05-04T09:42:00Z"
    },
    "replayVideo": {}
  }
}