GET/video/{video_id}
This method retrieves a video's metadata and content given a specified video ID. The method returns the title, size, classification, description, video ID, playList, status, status message (if any), expiration date, and thumbnail image of the retrieved video.
The video’s title, size, classification, and description are set using the createVideo method.
The video's playList contains two URLs that link to instances of the streaming video based on the supported protocol.
The status field contains the current status of the video. After a video upload is successfully completed, the video's status will show as PROCESSING until the video reaches one of the terminal states of LIVE, BLOCKED or PROCESSING_FAILED.
If a video's processing fails, it could be because the file is corrupted, is too large, or its size doesn’t match what was provided in the metadata. Refer to the error messages to determine the cause of the video’s failure to upload.
The status message will indicate why a video was blocked from uploading.
The video’s expiration date is automatically set to 30 days after the video’s initial creation.
The video's thumbnail image is automatically generated when the video is created.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the apim.ebay.com root URI with apim.sandbox.ebay.com
URI parameters
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
OAuth scope
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/sell.inventory
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| classification | array of Classification | The intended use for this video content. Currently, videos can only be added and associated with eBay listings, so the only supported value is Occurrence: Always |
| description | string | The description of the video. The video description is an optional field that can be set using the createVideo method. Occurrence: Conditional |
| expirationDate | string | The expiration date of the video in Coordinated Universal Time (UTC). The video’s expiration date is automatically set to 30 days after the video’s initial upload. Occurrence: Conditional |
| moderation | Moderation | The video moderation information that is returned if a video is blocked by moderators. Occurrence: Conditional |
| moderation.rejectReasons | array of RejectReasonEnum | The reason(s) why the specified video was blocked by moderators. Occurrence: Conditional |
| playLists | array of Play | The playlist created for the uploaded video, which provides the streaming video URLs to play the video. The supported streaming video protocols are DASH (Dynamic Adaptive Streaming over HTTP) and HLS (HTTP Live Streaming). The playlist will only be generated if a video is successfully uploaded with a status of Occurrence: Conditional |
| playLists.playUrl | string | The playable URL for this video. Occurrence: Conditional |
| playLists.protocol | ProtocolEnum | The protocol for the video playlist. Supported protocols are DASH (Dynamic Adaptive Streaming over HTTP) and HLS (HTTP Live Streaming). Occurrence: Conditional |
| size | integer | The size, in bytes, of the video content. Occurrence: Always |
| status | VideoStatusEnum | The status of the current video resource. Occurrence: Conditional |
| statusMessage | string | The statusMessage field contains additional information on the status. For example, information on why processing might have failed or if the video was blocked. Occurrence: Conditional |
| thumbnail | Image | The URL of the thumbnail image of the video. The thumbnail image's URL must be an eBayPictureURL (EPS URL). Occurrence: Conditional |
| thumbnail.imageUrl | string | The URL to access this image. Occurrence: Conditional |
| title | string | The title of the video. Occurrence: Always |
| videoId | string | The unique ID of the video. Occurrence: Conditional |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 200 | OK |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 190000 | API_MEDIA | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 190001 | API_MEDIA | REQUEST | The specified video_Id does not exist. |
| 190013 | API_MEDIA | REQUEST | Unauthorized access. |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Get Video Details
This sample retrieves the details of a video, including the title, size, classification, description, video ID, playList, status, status message (if any), expiration date, and thumbnail image.
Input
The input is video_id. There is no payload with this request.
GEThttps://apim.ebay.com/commerce/media/v1_beta/video/f******************************a
Output
If the call is successful, details of the video will be retrieved.