Skip to content
This repository has been archived by the owner on Jan 18, 2021. It is now read-only.

Latest commit

 

History

History
76 lines (49 loc) · 1.51 KB

index.rst

File metadata and controls

76 lines (49 loc) · 1.51 KB

Welcome to the Rev.ai Documentation

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

Rev.ai 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. This API need only be generated once and never expires.

Python SDK

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

You can install it using

pip install rev_ai
.. toctree::
    :maxdepth: 2
    :caption: Get Started:

    quickstart

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

    endpoints/jobs
    endpoints/transcript
    endpoints/account

.. toctree::
    :maxdepth: 2
    :caption: Callbacks:

    models/webhooks

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

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

Errors:

All errors returned in endpoints follow standard RFC7807 spec