ApiResponse<AccessToken> |
AuthenticationApi.authenticateWithHttpInfo(AuthenticatePayload authenticatePayload) |
Advanced - Authenticate (1/2)
To get started, submit your API key in the body of your request.
|
ApiResponse<UploadToken> |
UploadTokensApi.createTokenWithHttpInfo(TokenCreationPayload tokenCreationPayload) |
Generate an upload token
Use this endpoint to generate an upload token.
|
ApiResponse<LiveStream> |
LiveStreamsApi.createWithHttpInfo(LiveStreamCreationPayload liveStreamCreationPayload) |
Create live stream
A live stream will give you the 'connection point' to RTMP your video stream to api.video.
|
ApiResponse<PlayerTheme> |
PlayerThemesApi.createWithHttpInfo(PlayerThemeCreationPayload playerThemeCreationPayload) |
Create a player
Create a player for your video, and customise it.
|
ApiResponse<Video> |
VideosApi.createWithHttpInfo(VideoCreationPayload videoCreationPayload) |
Create a video
We have tutorials on: * [Creating and uploading videos](https://api.video/blog/tutorials/video-upload-tutorial) *
[Uploading large videos](https://api.video/blog/tutorials/video-upload-tutorial-large-videos) * [Using tags with
videos](https://api.video/blog/tutorials/video-tagging-best-practices) * [Private
videos](https://api.video/blog/tutorials/tutorial-private-videos) * [Using Dynamic
Metadata](https://api.video/blog/tutorials/dynamic-metadata) * Full list of
[tutorials](https://api.video/blog/endpoints/video-create) that demonstrate this endpoint.
|
ApiResponse<Webhook> |
WebhooksApi.createWithHttpInfo(WebhooksCreationPayload webhooksCreationPayload) |
Create Webhook
Webhooks can push notifications to your server, rather than polling api.video for changes.
|
ApiResponse<Void> |
PlayerThemesApi.deleteLogoWithHttpInfo(String playerId) |
Delete logo
Delete the logo associated to a player.
|
ApiResponse<LiveStream> |
LiveStreamsApi.deleteThumbnailWithHttpInfo(String liveStreamId) |
Delete a thumbnail
Send the unique identifier for a live stream to delete its thumbnail.
|
ApiResponse<Void> |
UploadTokensApi.deleteTokenWithHttpInfo(String uploadToken) |
Delete an upload token
Delete an existing upload token.
|
ApiResponse<Void> |
CaptionsApi.deleteWithHttpInfo(String videoId,
String language) |
Delete a caption
Delete a caption in a specific language by providing the video ID for the video you want to delete the caption
from and the language the caption is in.
|
ApiResponse<Void> |
ChaptersApi.deleteWithHttpInfo(String videoId,
String language) |
Delete a chapter
Delete a chapter in a specific language by providing the video ID for the video you want to delete the chapter
from and the language the chapter is in.
|
ApiResponse<Void> |
LiveStreamsApi.deleteWithHttpInfo(String liveStreamId) |
Delete a live stream
If you do not need a live stream any longer, you can send a request to delete it.
|
ApiResponse<Void> |
PlayerThemesApi.deleteWithHttpInfo(String playerId) |
Delete a player
Delete a player if you no longer need it.
|
ApiResponse<Void> |
VideosApi.deleteWithHttpInfo(String videoId) |
Delete a video
If you do not need a video any longer, you can send a request to delete it.
|
ApiResponse<Void> |
WatermarksApi.deleteWithHttpInfo(String watermarkId) |
Delete a watermark
Delete a watermark.
|
ApiResponse<Void> |
WebhooksApi.deleteWithHttpInfo(String webhookId) |
Delete a Webhook
This method will delete the indicated webhook.
|
ApiResponse<CaptionsListResponse> |
CaptionsApi.APIlistRequest.executeWithHttpInfo() |
Execute list request with HTTP info returned
|
ApiResponse<ChaptersListResponse> |
ChaptersApi.APIlistRequest.executeWithHttpInfo() |
Execute list request with HTTP info returned
|
ApiResponse<LiveStreamListResponse> |
LiveStreamsApi.APIlistRequest.executeWithHttpInfo() |
Execute list request with HTTP info returned
|
ApiResponse<PlayerThemesListResponse> |
PlayerThemesApi.APIlistRequest.executeWithHttpInfo() |
Execute list request with HTTP info returned
|
ApiResponse<RawStatisticsListLiveStreamAnalyticsResponse> |
RawStatisticsApi.APIlistLiveStreamSessionsRequest.executeWithHttpInfo() |
Execute listLiveStreamSessions request with HTTP info returned
|
ApiResponse<RawStatisticsListPlayerSessionEventsResponse> |
RawStatisticsApi.APIlistSessionEventsRequest.executeWithHttpInfo() |
Execute listSessionEvents request with HTTP info returned
|
ApiResponse<RawStatisticsListSessionsResponse> |
RawStatisticsApi.APIlistVideoSessionsRequest.executeWithHttpInfo() |
Execute listVideoSessions request with HTTP info returned
|
ApiResponse<TokenListResponse> |
UploadTokensApi.APIlistRequest.executeWithHttpInfo() |
Execute list request with HTTP info returned
|
ApiResponse<VideosListResponse> |
VideosApi.APIlistRequest.executeWithHttpInfo() |
Execute list request with HTTP info returned
|
ApiResponse<WatermarksListResponse> |
WatermarksApi.APIlistRequest.executeWithHttpInfo() |
Execute list request with HTTP info returned
|
ApiResponse<WebhooksListResponse> |
WebhooksApi.APIlistRequest.executeWithHttpInfo() |
Execute list request with HTTP info returned
|
ApiResponse<VideoStatus> |
VideosApi.getStatusWithHttpInfo(String videoId) |
Retrieve video status
This method provides upload status & encoding status to determine when the video is uploaded or ready to
playback.
|
ApiResponse<UploadToken> |
UploadTokensApi.getTokenWithHttpInfo(String uploadToken) |
Retrieve upload token
You can retrieve details about a specific upload token if you have the unique identifier for the upload token.
|
ApiResponse<Caption> |
CaptionsApi.getWithHttpInfo(String videoId,
String language) |
Retrieve a caption
Retrieve a caption for a video in a specific language.
|
ApiResponse<Chapter> |
ChaptersApi.getWithHttpInfo(String videoId,
String language) |
Retrieve a chapter
Retrieve a chapter for a video in a specific language.
|
ApiResponse<LiveStream> |
LiveStreamsApi.getWithHttpInfo(String liveStreamId) |
Retrieve live stream
Supply a liveStreamId, and you'll get all the details for streaming into, and watching the livestream.
|
ApiResponse<PlayerTheme> |
PlayerThemesApi.getWithHttpInfo(String playerId) |
Retrieve a player
Use a player ID to retrieve details about the player and display it for viewers.
|
ApiResponse<Video> |
VideosApi.getWithHttpInfo(String videoId) |
Retrieve a video
This call provides the same information provided on video creation.
|
ApiResponse<Webhook> |
WebhooksApi.getWithHttpInfo(String webhookId) |
Retrieve Webhook details
This call provides the same JSON information provided on Webhook creation.
|
ApiResponse<Video> |
VideosApi.pickThumbnailWithHttpInfo(String videoId,
VideoThumbnailPickPayload videoThumbnailPickPayload) |
Pick a thumbnail
Pick a thumbnail from the given time code.
|
ApiResponse<AccessToken> |
AuthenticationApi.refreshWithHttpInfo(RefreshTokenPayload refreshTokenPayload) |
Advanced - Refresh token (2/2)
Use the refresh endpoint with the refresh token you received when you first authenticated using the api-key
endpoint.
|
ApiResponse<Caption> |
CaptionsApi.updateWithHttpInfo(String videoId,
String language,
CaptionsUpdatePayload captionsUpdatePayload) |
Update a caption
To have the captions on automatically, use this method to set default: true.
|
ApiResponse<LiveStream> |
LiveStreamsApi.updateWithHttpInfo(String liveStreamId,
LiveStreamUpdatePayload liveStreamUpdatePayload) |
Update a live stream
Use this endpoint to update the player, or to turn recording on/off (saving a copy of the livestream).
|
ApiResponse<PlayerTheme> |
PlayerThemesApi.updateWithHttpInfo(String playerId,
PlayerThemeUpdatePayload playerThemeUpdatePayload) |
Update a player
Use a player ID to update specific details for a player.
|
ApiResponse<Video> |
VideosApi.updateWithHttpInfo(String videoId,
VideoUpdatePayload videoUpdatePayload) |
Update a video
Updates the parameters associated with your video.
|
ApiResponse<PlayerTheme> |
PlayerThemesApi.uploadLogoWithHttpInfo(String playerId,
File file,
String link) |
Upload a logo
The uploaded image maximum size should be 200x100 and its weight should be 100KB.
|
ApiResponse<Video> |
VideosApi.uploadPartWithHttpInfo(String videoId,
File file,
Integer part,
boolean isLast,
UploadPartProgressListener uploadProgressListener) |
|
ApiResponse<LiveStream> |
LiveStreamsApi.uploadThumbnailWithHttpInfo(String liveStreamId,
File file) |
Upload a thumbnail
Upload an image to use as a backdrop for your livestream.
|
ApiResponse<Video> |
VideosApi.uploadThumbnailWithHttpInfo(String videoId,
File file) |
Upload a thumbnail
The thumbnail is the poster that appears in the player window before video playback begins.
|
ApiResponse<Caption> |
CaptionsApi.uploadWithHttpInfo(String videoId,
String language,
File file) |
Upload a caption
Upload a VTT file to add captions to your video.
|
ApiResponse<Chapter> |
ChaptersApi.uploadWithHttpInfo(String videoId,
String language,
File file) |
Upload a chapter
Upload a VTT file to add chapters to your video.
|
ApiResponse<Video> |
VideosApi.uploadWithHttpInfo(String videoId,
File file) |
Upload a video
To upload a video to the videoId you created.
|
ApiResponse<Video> |
VideosApi.uploadWithHttpInfo(String videoId,
File file,
UploadProgressListener uploadProgressListener) |
Upload a video
To upload a video to the videoId you created.
|
ApiResponse<Watermark> |
WatermarksApi.uploadWithHttpInfo(File file) |
Upload a watermark
Create a new watermark by uploading a `JPG` or a `PNG` image.
|
ApiResponse<Video> |
VideosApi.uploadWithUploadTokenPartWithHttpInfo(String token,
File file,
String videoId,
Integer part,
boolean isLast,
UploadPartProgressListener uploadProgressListener) |
|
ApiResponse<Video> |
VideosApi.uploadWithUploadTokenWithHttpInfo(String token,
File file) |
Upload with an upload token
This method allows you to send a video using an upload token.
|
ApiResponse<Video> |
VideosApi.uploadWithUploadTokenWithHttpInfo(String token,
File file,
UploadProgressListener uploadProgressListener) |
Upload with an upload token
This method allows you to send a video using an upload token.
|