java.lang.Object
- ai.rev.speechtotext.ApiClient

```
public class ApiClient
extends Object
```
The ApiClient object provides methods to send and retrieve information from all the Rev.AI API endpoints using the Retrofit HTTP client.

Field Summary

Fields
Modifier and Type Field Description

ApiInterface apiInterface
Interface that ApiClient methods use to make requests

Constructor Summary

Constructors
Constructor Description

ApiClient(String accessToken)
Constructs the API client used to send HTTP requests to Rev.ai.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`closeConnection()`	Manually closes the connection when the code is running in a JVM
`void`	`deleteJob(String id)`	This method sends a DELETE request to the /jobs/{id} endpoint.
`RevAiAccount`	`getAccount()`	This method sends a GET request to the /account endpoint and returns an `RevAiAccount` object.
`InputStream`	`getCaptions(String id)`	An overload of `getCaptions(String, RevAiCaptionType, Integer)` without the optional caption type and channel ID.
`InputStream`	`getCaptions(String id, RevAiCaptionType captionType)`	An overload of `getCaptions(String, RevAiCaptionType, Integer)` without the optional channel ID.
`InputStream`	`getCaptions(String id, RevAiCaptionType captionType, Integer channelId)`	The method sends a GET request to the /jobs/{id}/captions endpoint and returns captions for the provided job ID in the form of an InputStream.
`InputStream`	`getCaptions(String id, Integer channelId)`	An overload of `getCaptions(String, RevAiCaptionType, Integer)` without the optional caption type.
`RevAiJob`	`getJobDetails(String id)`	This method sends a GET request to the /jobs/{id} endpoint and returns a `RevAiJob` object.
`List<RevAiJob>`	`getListOfJobs()`	Overload of `getListOfJobs(Integer, String)` without the optional limit and startingAfter parameter.
`List<RevAiJob>`	`getListOfJobs(Integer limit)`	Overload of `getListOfJobs(Integer, String)` without the optional startingAfter parameter.
`List<RevAiJob>`	`getListOfJobs(Integer limit, String startingAfter)`	This method sends a GET request to the /jobs endpoint and returns a list of `RevAiJob` objects.
`List<RevAiJob>`	`getListOfJobs(String startingAfter)`	Overload of `getListOfJobs(Integer, String)` without the optional limit parameter.
`RevAiTranscript`	`getTranscriptObject(String id)`	The method sends a GET request to the /jobs/{id}/transcript endpoint and returns a `RevAiTranscript` object.
`String`	`getTranscriptText(String id)`	The method sends a GET request to the /jobs/{id}/transcript endpoint and returns the transcript as a String.
`RevAiJob`	`submitJobLocalFile(InputStream inputStream)`	An overload of `submitJobLocalFile(InputStream, String, RevAiJobOptions)` without the optional filename and transcription options.
`RevAiJob`	`submitJobLocalFile(InputStream inputStream, RevAiJobOptions options)`	An overload of `submitJobLocalFile(InputStream, String, RevAiJobOptions)` without the optional filename.
`RevAiJob`	`submitJobLocalFile(InputStream inputStream, String fileName)`	An overload of `submitJobLocalFile(InputStream, String, RevAiJobOptions)` without the additional transcription options.
`RevAiJob`	`submitJobLocalFile(InputStream inputStream, String fileName, RevAiJobOptions options)`	The method sends a POST request to the /jobs endpoint, starts an asynchronous job to transcribe the media file provided by InputStream and returns a `RevAiJob` object.
`RevAiJob`	`submitJobLocalFile(String filePath)`	An overload of `submitJobLocalFile(String, RevAiJobOptions)` without the additional transcription options.
`RevAiJob`	`submitJobLocalFile(String filePath, RevAiJobOptions options)`	The method sends multipart/form request to the /jobs endpoint, starts an asynchronous job to transcribe the local media file provided and returns a `RevAiJob` object.
`RevAiJob`	`submitJobUrl(String mediaUrl)`	An overload of `submitJobUrl(String, RevAiJobOptions)` without the additional transcription options.
`RevAiJob`	`submitJobUrl(String mediaUrl, RevAiJobOptions options)`	The method sends a POST request to the /jobs endpoint, starts an asynchronous job to transcribe the media file located at the url provided and returns a `RevAiJob` object.

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

- Field Detail
  - apiInterface
```
public ApiInterface apiInterface
```
    Interface that ApiClient methods use to make requests
- Constructor Detail
  - ApiClient
```
public ApiClient(String accessToken)
```
    Constructs the API client used to send HTTP requests to Rev.ai. The user access token can be generated on the website at https://www.rev.ai/access_token.
    
    Parameters:
    
    accessToken - Rev.ai authorization token associate with the account.
    
    Throws:
    
    IllegalArgumentException - If the access token is null.
- Method Detail
  - closeConnection
```
public void closeConnection()
```
    Manually closes the connection when the code is running in a JVM
  - getAccount
```
public RevAiAccount getAccount()
                        throws IOException
```
    This method sends a GET request to the /account endpoint and returns an RevAiAccount object.
    
    Returns:
    
    RevAiAccount The object containing basic Rev.ai account information
    
    Throws:
    
    IOException - If the response has a status code > 399.
    
    See Also:
    
    RevAiAccount
  - getListOfJobs
```
public List<RevAiJob> getListOfJobs(Integer limit,
                                    String startingAfter)
                             throws IOException
```
    This method sends a GET request to the /jobs endpoint and returns a list of RevAiJob objects.
    
    Parameters:
    
    limit - The maximum number of jobs to return. The default is 100, max is 1000.
    
    startingAfter - The job ID at which the list begins.
    
    Returns:
    
    A list of RevAiJob objects.
    
    Throws:
    
    IOException - If the response has a status code > 399.
    
    See Also:
    
    RevAiJob, https://www.rev.ai/docs#operation/GetListOfJobs
  - getListOfJobs
```
public List<RevAiJob> getListOfJobs(Integer limit)
                             throws IOException
```
    Overload of getListOfJobs(Integer, String) without the optional startingAfter parameter.
    
    Parameters:
    
    limit - The maximum number of jobs to return. The default is 100, max is 1000.
    
    Returns:
    
    A list of RevAiJob objects.
    
    Throws:
    
    IOException - If the response has a status code > 399.
  - getListOfJobs
```
public List<RevAiJob> getListOfJobs(String startingAfter)
                             throws IOException
```
    Overload of getListOfJobs(Integer, String) without the optional limit parameter.
    
    Parameters:
    
    startingAfter - The job ID at which the list begins.
    
    Returns:
    
    A list of RevAiJob objects.
    
    Throws:
    
    IOException - If the response has a status code > 399.
  - getListOfJobs
```
public List<RevAiJob> getListOfJobs()
                             throws IOException
```
    Overload of getListOfJobs(Integer, String) without the optional limit and startingAfter parameter.
    
    Returns:
    
    A list of RevAiJob objects.
    
    Throws:
    
    IOException - If the response has a status code > 399.
  - getJobDetails
```
public RevAiJob getJobDetails(String id)
                       throws IOException
```
    This method sends a GET request to the /jobs/{id} endpoint and returns a RevAiJob object.
    
    Parameters:
    
    id - The ID of the job to return an object for.
    
    Returns:
    
    A RevAiJob object.
    
    Throws:
    
    IOException - If the response has a status code > 399.
    
    IllegalArgumentException - If the job ID is null.
  - deleteJob
```
public void deleteJob(String id)
               throws IOException
```
    This method sends a DELETE request to the /jobs/{id} endpoint.
    
    Parameters:
    
    id - The ID of the job to be deleted.
    
    Throws:
    
    IOException - If the response has a status code > 399.
    
    IllegalArgumentException - If the job ID is null.
    
    See Also:
    
    https://www.rev.ai/docs#operation/DeleteJobById
  - getTranscriptObject
```
public RevAiTranscript getTranscriptObject(String id)
                                    throws IOException
```
    The method sends a GET request to the /jobs/{id}/transcript endpoint and returns a RevAiTranscript object.
    
    Parameters:
    
    id - The ID of the job to return a transcript for.
    
    Returns:
    
    RevAiTranscript The transcript object.
    
    Throws:
    
    IOException - If the response has a status code > 399.
    
    See Also:
    
    RevAiTranscript
  - getTranscriptText
```
public String getTranscriptText(String id)
                         throws IOException
```
    The method sends a GET request to the /jobs/{id}/transcript endpoint and returns the transcript as a String.
    
    Parameters:
    
    id - The ID of the job to return a transcript for.
    
    Returns:
    
    The transcript as a String in text format.
    
    Throws:
    
    IOException - If the response has a status code > 399.
  - submitJobUrl
```
public RevAiJob submitJobUrl(String mediaUrl,
                             RevAiJobOptions options)
                      throws IOException
```
    The method sends a POST request to the /jobs endpoint, starts an asynchronous job to transcribe the media file located at the url provided and returns a RevAiJob object.
    
    Parameters:
    
    mediaUrl - A direct download link to the media.
    
    options - The transcription options associated with this job.
    
    Returns:
    
    RevAiJob A representation of the transcription job.
    
    Throws:
    
    IOException - If the response has a status code > 399.
    
    IllegalArgumentException - if the media url is null.
    
    See Also:
    
    RevAiJob, https://www.rev.ai/docs#operation/SubmitTranscriptionJob
  - submitJobUrl
```
public RevAiJob submitJobUrl(String mediaUrl)
                      throws IOException
```
    An overload of submitJobUrl(String, RevAiJobOptions) without the additional transcription options.
    
    Parameters:
    
    mediaUrl - A direct download link to the media.
    
    Returns:
    
    RevAiJob A representation of the transcription job.
    
    Throws:
    
    IOException - If the response has a status code > 399.
    
    See Also:
    
    RevAiJob, submitJobUrl(String, RevAiJobOptions)
  - submitJobLocalFile
```
public RevAiJob submitJobLocalFile(String filePath,
                                   RevAiJobOptions options)
                            throws IOException
```
    The method sends multipart/form request to the /jobs endpoint, starts an asynchronous job to transcribe the local media file provided and returns a RevAiJob object.
    
    Parameters:
    
    filePath - A local path to the file on the computer.
    
    options - The transcription options associated with this job.
    
    Returns:
    
    RevAiJob A representation of the transcription job.
    
    Throws:
    
    IOException - If the response has a status code > 399.
    
    IllegalArgumentException - If the file path is null.
    
    See Also:
    
    RevAiJob, https://www.rev.ai/docs#operation/SubmitTranscriptionJob
  - submitJobLocalFile
```
public RevAiJob submitJobLocalFile(String filePath)
                            throws IOException
```
    An overload of submitJobLocalFile(String, RevAiJobOptions) without the additional transcription options.
    
    Parameters:
    
    filePath - A local path to the file on the computer.
    
    Returns:
    
    RevAiJob A representation of the transcription job.
    
    Throws:
    
    IOException - If the response has a status code > 399.
    
    See Also:
    
    RevAiJob, submitJobLocalFile(String, RevAiJobOptions)
  - submitJobLocalFile
```
public RevAiJob submitJobLocalFile(InputStream inputStream,
                                   String fileName,
                                   RevAiJobOptions options)
                            throws IOException
```
    The method sends a POST request to the /jobs endpoint, starts an asynchronous job to transcribe the media file provided by InputStream and returns a RevAiJob object.
    
    Parameters:
    
    inputStream - An InputStream of the media file.
    
    fileName - The name of the file being streamed.
    
    options - The transcription options associated with this job.
    
    Returns:
    
    RevAiJob A representation of the transcription job.
    
    Throws:
    
    IOException - If the response has a status code > 399.
    
    IllegalArgumentException - If the InputStream provided is null.
    
    See Also:
    
    RevAiJob, https://www.rev.ai/docs#operation/SubmitTranscriptionJob
  - submitJobLocalFile
```
public RevAiJob submitJobLocalFile(InputStream inputStream)
                            throws IOException
```
    An overload of submitJobLocalFile(InputStream, String, RevAiJobOptions) without the optional filename and transcription options.
    
    Parameters:
    
    inputStream - An InputStream of the media file.
    
    Returns:
    
    RevAiJob A representation of the transcription job.
    
    Throws:
    
    IOException - If the response has a status code > 399.
    
    See Also:
    
    RevAiJob, https://www.rev.ai/docs#operation/SubmitTranscriptionJob
  - submitJobLocalFile
```
public RevAiJob submitJobLocalFile(InputStream inputStream,
                                   String fileName)
                            throws IOException
```
    An overload of submitJobLocalFile(InputStream, String, RevAiJobOptions) without the additional transcription options.
    
    Parameters:
    
    inputStream - An InputStream of the media file.
    
    fileName - The name of the file being streamed.
    
    Returns:
    
    RevAiJob A representation of the transcription job.
    
    Throws:
    
    IOException - If the response has a status code > 399.
    
    See Also:
    
    RevAiJob, https://www.rev.ai/docs#operation/SubmitTranscriptionJob
  - submitJobLocalFile
```
public RevAiJob submitJobLocalFile(InputStream inputStream,
                                   RevAiJobOptions options)
                            throws IOException
```
    An overload of submitJobLocalFile(InputStream, String, RevAiJobOptions) without the optional filename.
    
    Parameters:
    
    inputStream - An InputStream of the media file.
    
    options - The transcription options associated with this job.
    
    Returns:
    
    RevAiJob A representation of the transcription job.
    
    Throws:
    
    IOException - If the response has a status code > 399.
    
    See Also:
    
    RevAiJob, https://www.rev.ai/docs#operation/SubmitTranscriptionJob
  - getCaptions
```
public InputStream getCaptions(String id,
                               RevAiCaptionType captionType,
                               Integer channelId)
                        throws IOException
```
    The method sends a GET request to the /jobs/{id}/captions endpoint and returns captions for the provided job ID in the form of an InputStream.
    
    Parameters:
    
    id - The ID of the job to return captions for.
    
    captionType - An enumeration of the desired caption type. Default is SRT.
    
    channelId - Identifies the audio channel of the file to output captions for. Default is null.
    
    Returns:
    
    InputStream A stream of bytes that represents the caption output.
    
    Throws:
    
    IOException - If the response has a status code > 399.
    
    IllegalArgumentException - If the job ID provided is null.
    
    See Also:
    
    https://www.rev.ai/docs#operation/GetCaptions
  - getCaptions
```
public InputStream getCaptions(String id,
                               RevAiCaptionType captionType)
                        throws IOException
```
    An overload of getCaptions(String, RevAiCaptionType, Integer) without the optional channel ID.
    
    Parameters:
    
    id - The ID of the job to return captions for.
    
    captionType - An enumeration of the desired caption type. Default is SRT
    
    Returns:
    
    InputStream A stream of bytes that represents the caption output.
    
    Throws:
    
    IOException - If the response has a status code > 399.
    
    IllegalArgumentException - If the job ID provided is null.
    
    See Also:
    
    https://www.rev.ai/docs#operation/GetCaptions
  - getCaptions
```
public InputStream getCaptions(String id,
                               Integer channelId)
                        throws IOException
```
    An overload of getCaptions(String, RevAiCaptionType, Integer) without the optional caption type.
    
    Parameters:
    
    id - The ID of the job to return captions for.
    
    channelId - Identifies the audio channel of the file to output captions for.
    
    Returns:
    
    InputStream A stream of bytes that represents the caption output.
    
    Throws:
    
    IOException - If the response has a status code > 399.
    
    IllegalArgumentException - If the job ID provided is null.
    
    See Also:
    
    https://www.rev.ai/docs#operation/GetCaptions
  - getCaptions
```
public InputStream getCaptions(String id)
                        throws IOException
```
    An overload of getCaptions(String, RevAiCaptionType, Integer) without the optional caption type and channel ID.
    
    Parameters:
    
    id - The ID of the job to return captions for.
    
    Returns:
    
    InputStream A stream of bytes that represents the caption output.
    
    Throws:
    
    IOException - If the response has a status code > 399.
    
    IllegalArgumentException - If the job ID provided is null.
    
    See Also:
    
    https://www.rev.ai/docs#operation/GetCaptions

Class ApiClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

apiInterface

Constructor Detail

ApiClient

Method Detail

closeConnection

getAccount

getListOfJobs

getListOfJobs

getListOfJobs

getListOfJobs

getJobDetails

deleteJob

getTranscriptObject

getTranscriptText

submitJobUrl

submitJobUrl

submitJobLocalFile

submitJobLocalFile

submitJobLocalFile

submitJobLocalFile

submitJobLocalFile

submitJobLocalFile

getCaptions

getCaptions

getCaptions

getCaptions