Update Images
POST Thumbnail
Overview
The following table contains important information about the POST method for uploading a video thumbnail.
| Method | POST |
|---|---|
| URL | /api/projects/{projectId}/videos/thumbnail/{videoId} |
| Headers | Authorization |
Parameters
| Name | In | Description | Required | Type |
|---|---|---|---|---|
| projectId | path | Unique ID of the project | Yes | string |
| videoId | path | Unique ID of the video | Yes | string |
| api-version | query | API version (optional) | No | string |
Request Body
The request body should be sent as multipart/form-data and contain the following fields.
Upload thumbnail
| Field Name | Type | Description |
|---|---|---|
| File | binary | The thumbnail image file (binary) |
Select thumbnail
| Field Name | Type | Description |
|---|---|---|
| ThumbnailSecond | number | The second at which the thumbnail should be taken (double) |
Responses
| HTTP Status Code | Description | Content Type | Schema |
|---|---|---|---|
| 200 | Success | text/plain, application/json, text/json | FileUploadResponseModel |
| 401 | Unauthorized | - | - |
| 403 | Forbidden | - | - |
| 404 | Result Not Found | - | - |
| 500 | Internal Server Error | - | - |
| 503 | Backend Fetch Failed | - | - |
Security
The POST Thumbnail endpoint requires the following security mechanisms:
- OAuth2 with the scope
vp_api - API key with the value
vp_api_key
FileUploadResponseModel
The FileUploadResponseModel represents the response model for a successful file upload. It has the following attributes:
| Field Name | Type | Description |
|---|---|---|
| success | boolean | Indicates if the upload was successful (true/false). |
| errors | array of strings | An array of error messages, if any. |
| messages | array of strings | An array of response messages from the backend. |
| result | object | The response object containing uploaded file information. |
| result.id | integer (int32) | The ID of the uploaded file. |
| result.name | string | The name of the uploaded file. |
| result.flagTypeId | integer (int32) | The ID of the flag type. |
| result.flagTypeName | string | The name of the flag type. |
| result.value | string | The value of the flag. |
| result.active | boolean | Indicates whether the flag is active. |
| result.description | string | The description of the flag. |
| result.systemInfo | string | The system information of the flag. |
| resultInfo | string | Extra information about the result. |
| statusCode | integer (int32) | The HTTP status code of the response. |
Errors
The POST Thumbnail endpoint may return the following common HTTP status codes:
- 400 Bad Request: The request is malformed or missing required data.
- 401 Unauthorized: The request lacks proper authentication or authorization.
- 403 Forbidden: The request is not permitted.
- 404 Result Not Found: The requested resource was not found.
- 500 Internal Server Error: An internal server error occurred.
- 503 Backend Fetch Failed: There was an issue with the backend server.
This structured documentation provides clear information about the endpoint, its parameters, request body, responses, security requirements, and potential errors, following common documentation practices.