Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
98 lines (58 sloc) 2.58 KB

Welcome to the RevSpeech API Documentation

Go to Rev.ai Home: https://www.rev.ai

This RevSpeech API aims to deliver quality speech-text recognition via an API. All public methods and objects are documented here for developer reference.

This documentation is a work in progress and subject to change

Base Endpoint

The base url for this version of the API is

https://api.rev.ai/revspeech/v1beta

All endpoints described in this documentation are relative to this base url

API Key

All API requests must be authorized with an "Authorization: Bearer" header

-H "Authorization: Bearer <api_key>"

Developers can obtain their API Key from their settings page.

Python SDK

Check out our Python SDK here: https://pypi.org/project/rev-ai/

You can install it using

pip install rev_ai

Getting Started

Use your API Key generated above to make calls to our API.

To transcribe an audio file to RevSpeech:

curl -X POST "https://api.rev.ai/revspeech/v1beta/jobs" -H "Authorization: Bearer <api_key>" -H "Content-Type: application/json" -d "{\"media_url\":\"https://support.rev.com/hc/en-us/article_attachments/200043975/FTC_Sample_1_-_Single.mp3\",\"metadata\":\"This is a sample submit jobs option\"}"

You’ll receive a response like this:

{"id":"2028247","created_on":"2018-09-15T05:14:38.13","name":"sample.mp3","metadata":"This is a sample submit jobs option for multipart","status":"in_progress"}

This id (in this case 2028247) will allow you to retrieve your transcript. To retrieve your transcript from RevSpeech run:

curl -X GET "https://api.rev.ai/revspeech/v1beta/jobs/{id}/transcript" -H "Authorization: Bearer <api_key>" -H "Accept: application/vnd.rev.transcript.v1.0+json"

Alternatively you can get plain text by running:

curl -X GET "https://api.rev.ai/revspeech/v1beta/jobs/{id}/transcript" -H "Authorization: Bearer <api_key>" -H "Accept: text/plain"

If you have any further questions, contact us at support@rev.ai

.. toctree::
    :maxdepth: 2
    :caption: Endpoints:

    endpoints/jobs
    endpoints/transcript
    endpoints/account

.. toctree::
    :maxdepth: 2
    :caption: Models:

    models/job
    models/options
    models/transcript
    models/account
    models/webhooks

Errors:

All errors returned in endpoints follow standard RFC7807 spec