1. Live
api.video
  • Account
    • Show account
      GET
  • Analytics
    • List live stream player sessions
      GET
    • List player session events
      GET
    • List video player sessions
      GET
  • Authentication
    • Authenticate
      POST
    • Refresh token
      POST
  • Live
    • List all live streams
      GET
    • Create live stream
      POST
    • Delete a live stream
      DELETE
    • Show live stream
      GET
    • Update a live stream
      PATCH
    • Delete a thumbnail
      DELETE
    • Upload a thumbnail
      POST
  • Players
    • List all players
      GET
    • Create a player
      POST
    • Delete a player
      DELETE
    • Show a player
      GET
    • Update a player
      PATCH
    • Delete logo
      DELETE
    • Upload a logo
      POST
  • Videos - Delegated upload
    • Upload with an upload token
      POST
    • List all active upload tokens.
      GET
    • Generate an upload token
      POST
    • Delete an upload token
      DELETE
    • Show upload token
      GET
  • Videos
    • List all videos
    • Create a video
    • Delete a video
    • Show a video
    • Update a video
    • Upload a video
    • Show video status
    • Pick a thumbnail
    • Upload a thumbnail
  • Captions
    • List video captions
    • Delete a caption
    • Show a caption
    • Update caption
    • Upload a caption
  • Chapters
    • List video chapters
    • Delete a chapter
    • Show a chapter
    • Upload a chapter
  • Webhooks
    • List all webhooks
    • Create Webhook
    • Delete a Webhook
    • Show Webhook details
  • Schemas
    • Schemas
      • AccessToken
      • AccessToken
      • Account
      • Account
      • apiKey
      • apiKey
      • BadRequest
      • BadRequest
      • bytes_range
      • VideoCaptions
      • VideoCaptions
      • UpdateCaptionPayload
      • UpdateCaptionPayload
      • captions-upload-payload
      • Chapter
      • Chapter
      • VideoChapters
      • VideoChapters
      • UpdateChapterPayload
      • UpdateChapterPayload
      • link
      • LiveStream
      • LiveStream
      • liveStreamCreationPayload
      • liveStreamCreationPayload
      • LiveStreams
      • LiveStreams
      • Live Stream Session
      • Live Stream Session
      • live-stream-thumbnail-upload-payload
      • LiveStreamUpdatePayload
      • LiveStreamUpdatePayload
      • live_stream_assets
      • live_stream_session_client
      • live_stream_session_device
      • live_stream_session_location
      • live_stream_session_referrer
      • live_stream_session_session
      • metadata
      • NotFound
      • NotFound
      • Pagination
      • Pagination
      • PaginationLink
      • PaginationLink
      • Player
      • Player
      • Player Session Event
      • Player Session Event
      • playerCreationPayload
      • playerUpdatePayload
      • PlayerInput
      • PlayerInput
      • Players
      • Players
      • players-upload-logo-payload
      • quality
      • LiveStreamSessions
      • LiveStreamSessions
      • PlayerSessionEvents
      • PlayerSessionEvents
      • VideoSessions
      • VideoSessions
      • refreshToken
      • refreshToken
      • Subtitle
      • Subtitle
      • tokenCreationPayload
      • tokenCreationPayload
      • uploadTokens
      • uploadTokens
      • token-upload-payload
      • UploadToken
      • UploadToken
      • video
      • videoCreationPayload
      • videoCreationPayload
      • Video Session
      • Video Session
      • pickThumbnailPayload
      • pickThumbnailPayload
      • video-thumbnail-upload-payload
      • videoUpdatePayload
      • videoUpdatePayload
      • video-upload-payload
      • videoAssets
      • videoSource
      • video_session_client
      • video_session_device
      • video_session_location
      • video_session_os
      • video_session_referrer
      • video_session_session
      • video_source_live_stream
      • video_source_live_stream_link
      • Videos
      • Videos
      • VideoStatus
      • VideoStatus
      • videostatus_encoding
      • videostatus_encoding_metadata
      • videostatus_ingest
      • Webhook
      • Webhook
      • webhooks-create-payload
      • Webhooks
      • Webhooks
  1. Live

Upload a thumbnail

POST
/live-streams/{liveStreamId}/thumbnail
Upload an image to use as a backdrop for your livestream. Tutorials that update live stream thumbnails.

Request

Path Params

Body Params multipart/form-data

Responses

🟢201Created
application/json
Body

🟠400Bad Request
🟠404Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://ws.api.video/live-streams/vi4k0jvEUuaTdRAEjQ4Jfrgz/thumbnail' \
--form 'file=@""'
Response Response Example
201 - Example 1
{
    "assets": {
        "hls": "https://live.api.video/li4pqNqGUkhKfWcBGpZVLRY5.m3u8",
        "iframe": "<iframe src=\\\"https://embed.api.video/live/li4pqNqGUkhKfWcBGpZVLRY5\\\" width=\\\"100%\\\" height=\\\"100%\\\" frameborder=\\\"0\\\" scrolling=\\\"no\\\" allowfullscreen=\\\"\\\"></iframe>",
        "player": "https://embed.api.video/live/li400mYKSgQ6xs7taUeSaEKr",
        "thumbnail": "https://cdn.api.video/live/li400mYKSgQ6xs7taUeSaEKr/thumbnail.jpg"
    },
    "broadcasting": true,
    "liveStreamId": "li400mYKSgQ6xs7taUeSaEKr",
    "name": "My Live Stream",
    "playerId": "pl45d5vFFGrfdsdsd156dGhh",
    "public": true,
    "record": true,
    "streamKey": "cc1b4df0-d1c5-4064-a8f9-9f0368385135"
}
Modified at 2023-08-15 05:52:15
Previous
Delete a thumbnail
Next
List all players
Built with