java.lang.Object
- video.api.client.api.clients.ChaptersApi

```
public class ChaptersApi
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class ChaptersApi.APIlistRequest

Constructor Summary

Constructors
Constructor	Description
`ChaptersApi()`	Constructor for ChaptersApi production environment where API key is not required.
`ChaptersApi(String basePath)`	Constructor for ChaptersApi with custom API base path where API key is not required.
`ChaptersApi(String apiKey, String basePath)`	Constructor for ChaptersApi with custom API base path
`ChaptersApi(String apiKey, Environment environment)`	Constructor for ChaptersApi with custom API base path
`ChaptersApi(ApiClient apiClient)`
`ChaptersApi(Environment environment)`	Constructor for ChaptersApi with custom API base path where API key is not required.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`delete(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.
`okhttp3.Call`	`deleteAsync(String videoId, String language, ApiCallback<Void> _callback)`	Delete a chapter (asynchronously) 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>`	`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.
`Chapter`	`get(String videoId, String language)`	Retrieve a chapter Retrieve a chapter for by video id in a specific language.
`ApiClient`	`getApiClient()`
`okhttp3.Call`	`getAsync(String videoId, String language, ApiCallback<Chapter> _callback)`	Retrieve a chapter (asynchronously) Retrieve a chapter for by video id in a specific language.
`ApiResponse<Chapter>`	`getWithHttpInfo(String videoId, String language)`	Retrieve a chapter Retrieve a chapter for by video id in a specific language.
`ChaptersApi.APIlistRequest`	`list(String videoId)`	List video chapters Retrieve a list of all chapters for by video id.
`void`	`setApiClient(ApiClient apiClient)`
`Chapter`	`upload(String videoId, String language, File file)`	Upload a chapter Upload a VTT file to add chapters to your video.
`okhttp3.Call`	`uploadAsync(String videoId, String language, File file, ApiCallback<Chapter> _callback)`	Upload a chapter (asynchronously) Upload a VTT file to add chapters to your video.
`ApiResponse<Chapter>`	`uploadWithHttpInfo(String videoId, String language, File file)`	Upload a chapter Upload a VTT file to add chapters to your video.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ChaptersApi
```
public ChaptersApi(ApiClient apiClient)
```
- ChaptersApi
```
public ChaptersApi()
```
  Constructor for ChaptersApi production environment where API key is not required.
- ChaptersApi
```
public ChaptersApi(String basePath)
```
  Constructor for ChaptersApi with custom API base path where API key is not required.
  
  Parameters:
  
  basePath - the api base path. Expected Environment.PRODUCTION.basePath (default) or Environment.SANDBOX.basePath.
- ChaptersApi
```
public ChaptersApi(Environment environment)
```
  Constructor for ChaptersApi with custom API base path where API key is not required.
  
  Parameters:
  
  environment - the target environment. Expected Environment.PRODUCTION (default) or Environment.SANDBOX.
- ChaptersApi
```
public ChaptersApi(String apiKey,
                   String basePath)
```
  Constructor for ChaptersApi with custom API base path
  
  Parameters:
  
  apiKey - the api key to use to authenticate to the API
  
  basePath - the api base path. Expected Environment.PRODUCTION.basePath (default) or Environment.SANDBOX.basePath.
- ChaptersApi
```
public ChaptersApi(String apiKey,
                   Environment environment)
```
  Constructor for ChaptersApi with custom API base path
  
  Parameters:
  
  apiKey - the api key to use to authenticate to the API
  
  environment - the target environment. Expected Environment.PRODUCTION (default) or Environment.SANDBOX.

Method Detail

getApiClient
```
public ApiClient getApiClient()
```

setApiClient

public void setApiClient(ApiClient apiClient)

upload

public Chapter upload(String videoId,
                      String language,
                      File file)
               throws ApiException

Upload a chapter Upload a VTT file to add chapters to your video. Chapters help break the video into sections. Read our [tutorial](https://api.video/blog/tutorials/adding-chapters-to-your-videos/) for more details.

Parameters:

videoId - The unique identifier for the video you want to upload a chapter for. (required)

language - A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. (required)

file - The VTT file describing the chapters you want to upload. (required)

Returns:

Chapter

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad Request	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

uploadWithHttpInfo

public ApiResponse<Chapter> uploadWithHttpInfo(String videoId,
                                               String language,
                                               File file)
                                        throws ApiException

Upload a chapter Upload a VTT file to add chapters to your video. Chapters help break the video into sections. Read our [tutorial](https://api.video/blog/tutorials/adding-chapters-to-your-videos/) for more details.

Parameters:

videoId - The unique identifier for the video you want to upload a chapter for. (required)

language - A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. (required)

file - The VTT file describing the chapters you want to upload. (required)

Returns:

ApiResponse<Chapter>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad Request	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

uploadAsync

public okhttp3.Call uploadAsync(String videoId,
                                String language,
                                File file,
                                ApiCallback<Chapter> _callback)
                         throws ApiException

Upload a chapter (asynchronously) Upload a VTT file to add chapters to your video. Chapters help break the video into sections. Read our [tutorial](https://api.video/blog/tutorials/adding-chapters-to-your-videos/) for more details.

Parameters:

videoId - The unique identifier for the video you want to upload a chapter for. (required)

language - A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. (required)

file - The VTT file describing the chapters you want to upload. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad Request	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

get

public Chapter get(String videoId,
                   String language)
            throws ApiException

Retrieve a chapter Retrieve a chapter for by video id in a specific language.

Parameters:

videoId - The unique identifier for the video you want to show a chapter for. (required)

language - A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. (required)

Returns:

Chapter

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

getWithHttpInfo

public ApiResponse<Chapter> getWithHttpInfo(String videoId,
                                            String language)
                                     throws ApiException

Retrieve a chapter Retrieve a chapter for by video id in a specific language.

Parameters:

videoId - The unique identifier for the video you want to show a chapter for. (required)

language - A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. (required)

Returns:

ApiResponse<Chapter>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

getAsync

public okhttp3.Call getAsync(String videoId,
                             String language,
                             ApiCallback<Chapter> _callback)
                      throws ApiException

Retrieve a chapter (asynchronously) Retrieve a chapter for by video id in a specific language.

Parameters:

videoId - The unique identifier for the video you want to show a chapter for. (required)

language - A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

delete

public void delete(String videoId,
                   String language)
            throws ApiException

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.

Parameters:

videoId - The unique identifier for the video you want to delete a chapter from. (required)

language - A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	No Content	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

deleteWithHttpInfo

public ApiResponse<Void> deleteWithHttpInfo(String videoId,
                                            String language)
                                     throws ApiException

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.

Parameters:

videoId - The unique identifier for the video you want to delete a chapter from. (required)

language - A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	No Content	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

deleteAsync

public okhttp3.Call deleteAsync(String videoId,
                                String language,
                                ApiCallback<Void> _callback)
                         throws ApiException

Delete a chapter (asynchronously) 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.

Parameters:

videoId - The unique identifier for the video you want to delete a chapter from. (required)

language - A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
204	No Content	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

list

public ChaptersApi.APIlistRequest list(String videoId)

List video chapters Retrieve a list of all chapters for by video id.

Parameters:

videoId - The unique identifier for the video you want to retrieve a list of chapters for. (required)

Returns:

APIlistRequest

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404	Not Found	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

Class ChaptersApi

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChaptersApi

ChaptersApi

ChaptersApi

ChaptersApi

ChaptersApi

ChaptersApi

Method Detail

getApiClient

setApiClient

upload

uploadWithHttpInfo

uploadAsync

get

getWithHttpInfo

getAsync

delete

deleteWithHttpInfo

deleteAsync

list