AccessToken |
AuthenticationApi.authenticate(AuthenticatePayload authenticatePayload) |
Authenticate To get started, submit your API key in the body of your request.
|
ApiResponse<AccessToken> |
AuthenticationApi.authenticateWithHttpInfo(AuthenticatePayload authenticatePayload) |
Authenticate To get started, submit your API key in the body of your request.
|
okhttp3.Call |
CaptionsApi.APIlistRequest.buildCall(ApiCallback _callback) |
Build call for list
|
okhttp3.Call |
ChaptersApi.APIlistRequest.buildCall(ApiCallback _callback) |
Build call for list
|
okhttp3.Call |
LiveStreamsApi.APIlistRequest.buildCall(ApiCallback _callback) |
Build call for list
|
okhttp3.Call |
PlayerThemesApi.APIlistRequest.buildCall(ApiCallback _callback) |
Build call for list
|
okhttp3.Call |
RawStatisticsApi.APIlistLiveStreamSessionsRequest.buildCall(ApiCallback _callback) |
Build call for listLiveStreamSessions
|
okhttp3.Call |
RawStatisticsApi.APIlistSessionEventsRequest.buildCall(ApiCallback _callback) |
Build call for listSessionEvents
|
okhttp3.Call |
RawStatisticsApi.APIlistVideoSessionsRequest.buildCall(ApiCallback _callback) |
Build call for listVideoSessions
|
okhttp3.Call |
UploadTokensApi.APIlistRequest.buildCall(ApiCallback _callback) |
Build call for list
|
okhttp3.Call |
VideosApi.APIlistRequest.buildCall(ApiCallback _callback) |
Build call for list
|
okhttp3.Call |
WebhooksApi.APIlistRequest.buildCall(ApiCallback _callback) |
Build call for list
|
LiveStream |
LiveStreamsApi.create(LiveStreamCreationPayload liveStreamCreationPayload) |
Create live stream A live stream will give you the 'connection point' to RTMP your video stream to
api.video.
|
PlayerTheme |
PlayerThemesApi.create(PlayerThemeCreationPayload playerThemeCreationPayload) |
Create a player Create a player for your video, and customise it.
|
Video |
VideosApi.create(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.
|
Webhook |
WebhooksApi.create(WebhooksCreationPayload webhooksCreationPayload) |
Create Webhook Webhooks can push notifications to your server, rather than polling api.video for changes.
|
UploadToken |
UploadTokensApi.createToken(TokenCreationPayload tokenCreationPayload) |
Generate an upload token Use this endpoint to generate an upload token.
|
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.
|
void |
CaptionsApi.delete(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.
|
void |
ChaptersApi.delete(String videoId,
String language) |
Delete a chapter
|
void |
LiveStreamsApi.delete(String liveStreamId) |
Delete a live stream
|
void |
PlayerThemesApi.delete(String playerId) |
Delete a player Delete a player if you no longer need it.
|
void |
VideosApi.delete(String videoId) |
Delete a video If you do not need a video any longer, you can send a request to delete it.
|
void |
WebhooksApi.delete(String webhookId) |
Delete a Webhook This endpoint will delete the indicated webhook.
|
void |
PlayerThemesApi.deleteLogo(String playerId) |
Delete logo
|
ApiResponse<Void> |
PlayerThemesApi.deleteLogoWithHttpInfo(String playerId) |
Delete logo
|
LiveStream |
LiveStreamsApi.deleteThumbnail(String liveStreamId) |
Delete a thumbnail Send the unique identifier for a live stream to delete it from the system.
|
ApiResponse<LiveStream> |
LiveStreamsApi.deleteThumbnailWithHttpInfo(String liveStreamId) |
Delete a thumbnail Send the unique identifier for a live stream to delete it from the system.
|
void |
UploadTokensApi.deleteToken(String uploadToken) |
Delete an upload token Delete an existing upload token.
|
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
|
ApiResponse<Void> |
LiveStreamsApi.deleteWithHttpInfo(String liveStreamId) |
Delete a live stream
|
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> |
WebhooksApi.deleteWithHttpInfo(String webhookId) |
Delete a Webhook This endpoint will delete the indicated webhook.
|
Page<Caption> |
CaptionsApi.APIlistRequest.execute() |
Execute list request
|
Page<Chapter> |
ChaptersApi.APIlistRequest.execute() |
Execute list request
|
Page<LiveStream> |
LiveStreamsApi.APIlistRequest.execute() |
Execute list request
|
Page<PlayerTheme> |
PlayerThemesApi.APIlistRequest.execute() |
Execute list request
|
Page<LiveStreamSession> |
RawStatisticsApi.APIlistLiveStreamSessionsRequest.execute() |
Execute listLiveStreamSessions request
|
Page<PlayerSessionEvent> |
RawStatisticsApi.APIlistSessionEventsRequest.execute() |
Execute listSessionEvents request
|
Page<VideoSession> |
RawStatisticsApi.APIlistVideoSessionsRequest.execute() |
Execute listVideoSessions request
|
Page<UploadToken> |
UploadTokensApi.APIlistRequest.execute() |
Execute list request
|
Page<Video> |
VideosApi.APIlistRequest.execute() |
Execute list request
|
Page<Webhook> |
WebhooksApi.APIlistRequest.execute() |
Execute list request
|
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<WebhooksListResponse> |
WebhooksApi.APIlistRequest.executeWithHttpInfo() |
Execute list request with HTTP info returned
|
Caption |
CaptionsApi.get(String videoId,
String language) |
Show a caption Display a caption for a video in a specific language.
|
Chapter |
ChaptersApi.get(String videoId,
String language) |
Show a chapter Chapters help your viewers find the sections of the video they are most interested in viewing.
|
LiveStream |
LiveStreamsApi.get(String liveStreamId) |
Show live stream Supply a LivestreamId, and you'll get all the details for streaming into, and watching the
livestream.
|
PlayerTheme |
PlayerThemesApi.get(String playerId) |
Show a player Use a player ID to retrieve details about the player and display it for viewers.
|
Video |
VideosApi.get(String videoId) |
Show a video This call provides the same JSON information provided on video creation.
|
Webhook |
WebhooksApi.get(String webhookId) |
Show Webhook details This call provides the same JSON information provided on Webjhook creation.
|
VideoStatus |
VideosApi.getStatus(String videoId) |
Show video status This API provides upload status & encoding status to determine when the video is uploaded
or ready to playback.
|
ApiResponse<VideoStatus> |
VideosApi.getStatusWithHttpInfo(String videoId) |
Show video status This API provides upload status & encoding status to determine when the video is uploaded
or ready to playback.
|
UploadToken |
UploadTokensApi.getToken(String uploadToken) |
Show upload token You can retrieve details about a specific upload token if you have the unique identifier for
the upload token.
|
ApiResponse<UploadToken> |
UploadTokensApi.getTokenWithHttpInfo(String uploadToken) |
Show 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) |
Show a caption Display a caption for a video in a specific language.
|
ApiResponse<Chapter> |
ChaptersApi.getWithHttpInfo(String videoId,
String language) |
Show a chapter Chapters help your viewers find the sections of the video they are most interested in viewing.
|
ApiResponse<LiveStream> |
LiveStreamsApi.getWithHttpInfo(String liveStreamId) |
Show 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) |
Show a player Use a player ID to retrieve details about the player and display it for viewers.
|
ApiResponse<Video> |
VideosApi.getWithHttpInfo(String videoId) |
Show a video This call provides the same JSON information provided on video creation.
|
ApiResponse<Webhook> |
WebhooksApi.getWithHttpInfo(String webhookId) |
Show Webhook details This call provides the same JSON information provided on Webjhook creation.
|
Video |
VideosApi.pickThumbnail(String videoId,
VideoThumbnailPickPayload videoThumbnailPickPayload) |
Pick a thumbnail Pick a thumbnail from the given time code.
|
ApiResponse<Video> |
VideosApi.pickThumbnailWithHttpInfo(String videoId,
VideoThumbnailPickPayload videoThumbnailPickPayload) |
Pick a thumbnail Pick a thumbnail from the given time code.
|
AccessToken |
AuthenticationApi.refresh(RefreshTokenPayload refreshTokenPayload) |
Refresh token Use the refresh endpoint with the refresh token you received when you first authenticated using the
api-key endpoint.
|
ApiResponse<AccessToken> |
AuthenticationApi.refreshWithHttpInfo(RefreshTokenPayload refreshTokenPayload) |
Refresh token Use the refresh endpoint with the refresh token you received when you first authenticated using the
api-key endpoint.
|
Caption |
CaptionsApi.update(String videoId,
String language,
CaptionsUpdatePayload captionsUpdatePayload) |
Update caption To have the captions on automatically, use this PATCH to set default: true.
|
LiveStream |
LiveStreamsApi.update(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).
|
PlayerTheme |
PlayerThemesApi.update(String playerId,
PlayerThemeUpdatePayload playerThemeUpdatePayload) |
Update a player Use a player ID to update specific details for a player.
|
Video |
VideosApi.update(String videoId,
VideoUpdatePayload videoUpdatePayload) |
Update a video Use this endpoint to update the parameters associated with your video.
|
ApiResponse<Caption> |
CaptionsApi.updateWithHttpInfo(String videoId,
String language,
CaptionsUpdatePayload captionsUpdatePayload) |
Update caption To have the captions on automatically, use this PATCH 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 Use this endpoint to update the parameters associated with your video.
|
Caption |
CaptionsApi.upload(String videoId,
String language,
File file) |
Upload a caption Upload a VTT file to add captions to your video.
|
Chapter |
ChaptersApi.upload(String videoId,
String language,
File file) |
Upload a chapter Chapters help break the video into sections.
|
Video |
VideosApi.upload(String videoId,
File file) |
Upload a video To upload a video to the videoId you created.
|
Video |
VideosApi.upload(String videoId,
File file,
UploadProgressListener uploadProgressListener) |
Upload a video To upload a video to the videoId you created.
|
Video |
VideosApi.UploadProgressiveSession.uploadLastPart(File part) |
|
Video |
VideosApi.UploadProgressiveSession.uploadLastPart(File part,
UploadPartProgressListener uploadProgressListener) |
|
Video |
VideosApi.UploadWithUploadTokenProgressiveSession.uploadLastPart(File part) |
|
Video |
VideosApi.UploadWithUploadTokenProgressiveSession.uploadLastPart(File part,
UploadPartProgressListener uploadProgressListener) |
|
PlayerTheme |
PlayerThemesApi.uploadLogo(String playerId,
File file,
String link) |
Upload a logo The uploaded image maximum size should be 200x100 and its weight should be 200KB.
|
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 200KB.
|
Video |
VideosApi.UploadProgressiveSession.uploadPart(File part) |
|
Video |
VideosApi.UploadProgressiveSession.uploadPart(File part,
boolean isLastPart,
UploadPartProgressListener uploadProgressListener) |
|
Video |
VideosApi.UploadProgressiveSession.uploadPart(File part,
UploadPartProgressListener uploadProgressListener) |
|
Video |
VideosApi.UploadWithUploadTokenProgressiveSession.uploadPart(File part) |
|
Video |
VideosApi.UploadWithUploadTokenProgressiveSession.uploadPart(File part,
boolean isLastPart,
UploadPartProgressListener uploadProgressListener) |
|
Video |
VideosApi.UploadWithUploadTokenProgressiveSession.uploadPart(File part,
UploadPartProgressListener uploadProgressListener) |
|
ApiResponse<Video> |
VideosApi.uploadPartWithHttpInfo(String videoId,
File file,
Integer part,
boolean isLast,
UploadPartProgressListener uploadProgressListener) |
|
LiveStream |
LiveStreamsApi.uploadThumbnail(String liveStreamId,
File file) |
Upload a thumbnail Upload an image to use as a backdrop for your livestream.
|
Video |
VideosApi.uploadThumbnail(String videoId,
File file) |
Upload a thumbnail The thumbnail is the poster that appears in the player window before video playback begins.
|
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 Chapters help break the video into sections.
|
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.
|
Video |
VideosApi.uploadWithUploadToken(String token,
File file) |
Upload with an upload token When given a token, anyone can upload a file to the URI
`https://ws.api.video/upload?token=<tokenId>`.
|
Video |
VideosApi.uploadWithUploadToken(String token,
File file,
UploadProgressListener uploadProgressListener) |
Upload with an upload token When given a token, anyone can upload a file to the URI
`https://ws.api.video/upload?token=<tokenId>`.
|
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 When given a token, anyone can upload a file to the URI
`https://ws.api.video/upload?token=<tokenId>`.
|
ApiResponse<Video> |
VideosApi.uploadWithUploadTokenWithHttpInfo(String token,
File file,
UploadProgressListener uploadProgressListener) |
Upload with an upload token When given a token, anyone can upload a file to the URI
`https://ws.api.video/upload?token=<tokenId>`.
|