--- title: Edit video details --- [Skip to content](#%5Ftop) [API Reference](https://developers.cloudflare.com/api/typescript) [Stream](https://developers.cloudflare.com/api/typescript/resources/stream) Copy Markdown Open in **Claude** Open in **ChatGPT** Open in **Cursor** --- **Copy Markdown** **View as Markdown** # Edit video details client.stream.edit(stringidentifier, StreamEditParams { account\_id, allowedOrigins, creator, 8 more } params, RequestOptionsoptions?): [Video](https://developers.cloudflare.com/api/typescript/resources/stream#%28resource%29%20stream%20%3E%20%28model%29%20video%20%3E%20%28schema%29) { allowedOrigins, clippedFrom, created, 23 more } POST/accounts/{account\_id}/stream/{identifier} Edit details for a single video. ##### Security API Token The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). **Example:**`Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY` API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**`X-Auth-Email: user@example.com` The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**`X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194` ##### ParametersExpand Collapse identifier: string A Cloudflare-generated unique identifier for a media item. maxLength32 params: StreamEditParams { account\_id, allowedOrigins, creator, 8 more } account\_id: string Path param: The account identifier tag. maxLength32 allowedOrigins?: Array<[AllowedOrigins](https://developers.cloudflare.com/api/typescript/resources/stream#%28resource%29%20stream%20%3E%20%28model%29%20allowed%5Forigins%20%3E%20%28schema%29)\> Body param: Lists the origins allowed to display the video. Enter allowed origin domains in an array and use `*` for wildcard subdomains. Empty arrays allow the video to be viewed on any origin. creator?: string Body param: A user-defined identifier for the media creator. maxLength64 maxDurationSeconds?: number Body param: The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of `-1` means the value is unknown. maximum36000 minimum1 meta?: unknown Body param: A user modifiable key-value store used to reference other systems of record for managing videos. publicDetails?: [PublicDetails](https://developers.cloudflare.com/api/typescript/resources/stream/methods/edit#%28resource%29%20stream%20%3E%20%28method%29%20edit%20%3E%20%28params%29%20default%20%3E%20%28param%29%20publicDetails%20%3E%20%28schema%29) Body param: Public details for the video including title, share link, channel link, and logo. channel\_link?: string | null logo?: string | null share\_link?: string | null title?: string | null requireSignedURLs?: boolean Body param: Indicates whether the video can be a accessed using the UID. When set to `true`, a signed token must be generated with a signing key to view the video. scheduledDeletion?: string Body param: Indicates the date and time at which the video will be deleted. Omit the field to indicate no change, or include with a `null` value to remove an existing scheduled deletion. If specified, must be at least 30 days from upload time. formatdate-time thumbnailTimestampPct?: number Body param: The timestamp for a thumbnail image calculated as a percentage value of the video’s duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video. maximum1 minimum0 uid?: string Body param: The unique identifier for the video. Can be used to verify the video being updated. uploadExpiry?: string Body param: The date and time when the video upload URL is no longer valid for direct user uploads. formatdate-time ##### ReturnsExpand Collapse Video { allowedOrigins, clippedFrom, created, 23 more } allowedOrigins?: Array<[AllowedOrigins](https://developers.cloudflare.com/api/typescript/resources/stream#%28resource%29%20stream%20%3E%20%28model%29%20allowed%5Forigins%20%3E%20%28schema%29)\> Lists the origins allowed to display the video. Enter allowed origin domains in an array and use `*` for wildcard subdomains. Empty arrays allow the video to be viewed on any origin. clippedFrom?: string The unique identifier of the source video this video was clipped from. created?: string The date and time the media item was created. formatdate-time creator?: string A user-defined identifier for the media creator. maxLength64 duration?: number The duration of the video in seconds. A value of `-1` means the duration is unknown. The duration becomes available after the upload and before the video is ready. input?: Input { height, width } height?: number The video height in pixels. A value of `-1` means the height is unknown. The value becomes available after the upload and before the video is ready. width?: number The video width in pixels. A value of `-1` means the width is unknown. The value becomes available after the upload and before the video is ready. liveInput?: string The live input ID used to upload a video with Stream Live. maxLength32 maxDurationSeconds?: number The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of `-1` means the value is unknown. maximum36000 minimum1 maxSizeBytes?: number The maximum size in bytes for the video upload. formatint64 meta?: unknown A user modifiable key-value store used to reference other systems of record for managing videos. modified?: string The date and time the media item was last modified. formatdate-time playback?: Playback { dash, hls } dash?: string DASH Media Presentation Description for the video. hls?: string The HLS manifest for the video. preview?: string The video’s preview page URI. This field is omitted until encoding is complete. formaturi publicDetails?: PublicDetails { channel\_link, logo, media\_id, 2 more } Public details for the video including title, share link, channel link, and logo. channel\_link?: string | null logo?: string | null media\_id?: number share\_link?: string | null title?: string | null readyToStream?: boolean Indicates whether the video is playable. The field is empty if the video is not ready for viewing or the live stream is still in progress. readyToStreamAt?: string Indicates the time at which the video became playable. The field is empty if the video is not ready for viewing or the live stream is still in progress. formatdate-time requireSignedURLs?: boolean Indicates whether the video can be a accessed using the UID. When set to `true`, a signed token must be generated with a signing key to view the video. scheduledDeletion?: string Indicates the date and time at which the video will be deleted. Omit the field to indicate no change, or include with a `null` value to remove an existing scheduled deletion. If specified, must be at least 30 days from upload time. formatdate-time size?: number The size of the media item in bytes. status?: Status { errorReasonCode, errorReasonText, pctComplete, state } Specifies a detailed status for a video. If the `state` is `inprogress` or `error`, the `step` field returns `encoding` or `manifest`. If the `state` is `inprogress`, `pctComplete` returns a number between 0 and 100 to indicate the approximate percent of completion. If the `state` is `error`, `errorReasonCode` and `errorReasonText` provide additional details. errorReasonCode?: string Specifies why the video failed to encode. This field is empty if the video is not in an `error` state. Preferred for programmatic use. errorReasonText?: string Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an `error` state. pctComplete?: string Indicates the progress as a percentage between 0 and 100. state?: "pendingupload" | "downloading" | "queued" | 4 more Specifies the processing status for all quality levels for a video. One of the following: "pendingupload" "downloading" "queued" "inprogress" "ready" "error" "live-inprogress" thumbnail?: string The media item’s thumbnail URI. This field is omitted until encoding is complete. formaturi thumbnailTimestampPct?: number The timestamp for a thumbnail image calculated as a percentage value of the video’s duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video. maximum1 minimum0 uid?: string A Cloudflare-generated unique identifier for a media item. maxLength32 uploaded?: string The date and time the media item was uploaded. formatdate-time uploadExpiry?: string The date and time when the video upload URL is no longer valid for direct user uploads. formatdate-time watermark?: [Watermark](https://developers.cloudflare.com/api/typescript/resources/stream#%28resource%29%20stream.watermarks%20%3E%20%28model%29%20watermark%20%3E%20%28schema%29) { created, downloadedFrom, height, 8 more } created?: string The date and a time a watermark profile was created. formatdate-time downloadedFrom?: string The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null. height?: number The height of the image in pixels. name?: string A short description of the watermark profile. opacity?: number The translucency of the image. A value of `0.0` makes the image completely transparent, and `1.0` makes the image completely opaque. Note that if the image is already semi-transparent, setting this to `1.0` will not make the image completely opaque. maximum1 minimum0 padding?: number The whitespace between the adjacent edges (determined by position) of the video and the image. `0.0` indicates no padding, and `1.0` indicates a fully padded video width or length, as determined by the algorithm. maximum1 minimum0 position?: string The location of the image. Valid positions are: `upperRight`, `upperLeft`, `lowerLeft`, `lowerRight`, and `center`. Note that `center` ignores the `padding` parameter. scale?: number The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. `0.0` indicates no scaling (use the size of the image as-is), and `1.0 `fills the entire video. maximum1 minimum0 size?: number The size of the image in bytes. uid?: string The unique identifier for a watermark profile. maxLength32 width?: number The width of the image in pixels. ### Edit video details TypeScript HTTPHTTP TypeScriptTypeScript PythonPython GoGo TerraformTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const video = await client.stream.edit('ea95132c15732412d22c1476fa83f27a', { account_id: '023e105f4ecef8ad9ca31a8372d0c353', }); console.log(video.uid); ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "allowedOrigins": [ "example.com" ], "clippedFrom": "ea95132c15732412d22c1476fa83f27a", "created": "2014-01-02T02:20:00Z", "creator": "creator-id_abcde12345", "duration": 0, "input": { "height": 0, "width": 0 }, "liveInput": "fc0a8dc887b16759bfd9ad922230a014", "maxDurationSeconds": 1, "maxSizeBytes": 0, "meta": { "name": "video12345.mp4" }, "modified": "2014-01-02T02:20:00Z", "playback": { "dash": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd", "hls": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8" }, "preview": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/watch", "publicDetails": { "channel_link": "channel_link", "logo": "logo", "media_id": 0, "share_link": "share_link", "title": "title" }, "readyToStream": true, "readyToStreamAt": "2014-01-02T02:20:00Z", "requireSignedURLs": true, "scheduledDeletion": "2014-01-02T02:20:00Z", "size": 4190963, "status": { "errorReasonCode": "ERR_NON_VIDEO", "errorReasonText": "The file was not recognized as a valid video file.", "pctComplete": "45", "state": "inprogress" }, "thumbnail": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg", "thumbnailTimestampPct": 0.529241, "uid": "ea95132c15732412d22c1476fa83f27a", "uploaded": "2014-01-02T02:20:00Z", "uploadExpiry": "2014-01-02T02:20:00Z", "watermark": { "created": "2014-01-02T02:20:00Z", "downloadedFrom": "https://company.com/logo.png", "height": 0, "name": "Marketing Videos", "opacity": 0.75, "padding": 0.1, "position": "center", "scale": 0.1, "size": 29472, "uid": "ea95132c15732412d22c1476fa83f27a", "width": 0 } } } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "allowedOrigins": [ "example.com" ], "clippedFrom": "ea95132c15732412d22c1476fa83f27a", "created": "2014-01-02T02:20:00Z", "creator": "creator-id_abcde12345", "duration": 0, "input": { "height": 0, "width": 0 }, "liveInput": "fc0a8dc887b16759bfd9ad922230a014", "maxDurationSeconds": 1, "maxSizeBytes": 0, "meta": { "name": "video12345.mp4" }, "modified": "2014-01-02T02:20:00Z", "playback": { "dash": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd", "hls": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8" }, "preview": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/watch", "publicDetails": { "channel_link": "channel_link", "logo": "logo", "media_id": 0, "share_link": "share_link", "title": "title" }, "readyToStream": true, "readyToStreamAt": "2014-01-02T02:20:00Z", "requireSignedURLs": true, "scheduledDeletion": "2014-01-02T02:20:00Z", "size": 4190963, "status": { "errorReasonCode": "ERR_NON_VIDEO", "errorReasonText": "The file was not recognized as a valid video file.", "pctComplete": "45", "state": "inprogress" }, "thumbnail": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg", "thumbnailTimestampPct": 0.529241, "uid": "ea95132c15732412d22c1476fa83f27a", "uploaded": "2014-01-02T02:20:00Z", "uploadExpiry": "2014-01-02T02:20:00Z", "watermark": { "created": "2014-01-02T02:20:00Z", "downloadedFrom": "https://company.com/logo.png", "height": 0, "name": "Marketing Videos", "opacity": 0.75, "padding": 0.1, "position": "center", "scale": 0.1, "size": 29472, "uid": "ea95132c15732412d22c1476fa83f27a", "width": 0 } } } ```