{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["partial"]},"type":"markdown"},"seo":{"title":"Get Started","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-started","__idx":0},"children":["Get Started"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This short tutorial will teach you the basics of making requests to the Rev AI APIs. This tutorial uses the Asynchronous Speech to Text API to produce a transcript of an audio file submitted by you."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"assumptions","__idx":1},"children":["Assumptions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This tutorial assumes that you have a Rev AI account. If not, ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.rev.ai/auth/signup"},"children":["sign up for a free account"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-get-your-access-token","__idx":2},"children":["Step 1: Get your access token"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The first step is to generate an access token, which will enable access to the Rev AI APIs. Follow these steps:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.rev.ai/auth/login"},"children":["Log in"]}," to Rev AI."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Navigate to the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.rev.ai/access-token"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access Token"]}," page"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Generate New Access Token"]}," link. Confirm the operation in the pop-up dialog box."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/images/create-token.png","alt":"Creating an access token"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The new access token will be generated and displayed on the screen."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Save your access tokens somewhere safe; you will only be able to see them once. You are allowed a maximum of 2 access tokens at a time."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-submit-a-file-for-transcription","__idx":3},"children":["Step 2: Submit a file for transcription"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit an audio file for transcription to Rev AI using the command below. Replace the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<REVAI_ACCESS_TOKEN>"]}," placeholder with the access token obtained in Step 1, and replace the sample file URL shown below with the URL to your own audio file if required."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \"https://api.rev.ai/speechtotext/v1/jobs\" \\\n     -H \"Authorization: Bearer <REVAI_ACCESS_TOKEN>\" \\\n     -H \"Content-Type: application/json\" \\\n     -d '{\"source_config\": {\"url\": \"https://www.rev.ai/FTC_Sample_1.mp3\"},\"metadata\":\"This is a test\"}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You'll receive a response like this:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"Umx5c6F7pH7r\",\n  \"created_on\": \"2021-09-15T05:14:38.13\",\n  \"name\": \"FTC_Sample_1.mp3\",\n  \"metadata\": \"This is a test\",\n  \"status\": \"in_progress\",\n  \"type\": \"async\",\n  \"language\": \"en\"\n}\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," (in this case ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Umx5c6F7pH7r"]},") will enable you to retrieve your transcript."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-retrieve-the-transcript","__idx":4},"children":["Step 3: Retrieve the transcript"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You now need to wait for the job to complete. Wait for approximately 1 minute and then check the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," of your job by querying the API as shown below:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET https://api.rev.ai/speechtotext/v1/jobs/<ID> \\\n     -H \"Authorization: Bearer <REVAI_ACCESS_TOKEN>\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Polling the API periodically for job status is NOT recommended in a production server. Rather, use ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/asynchronous/webhooks"},"children":["webhooks"]}," to asynchronously receive notifications once the transcription job completes."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once a transcription job's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," changes to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transcribed"]},", you can retrieve the transcript in JSON format by running the command below. As before, replace the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<REVAI_ACCESS_TOKEN>"]}," placeholder with the access token obtained in Step 1. You must also replace the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<ID>"]}," placeholder with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," obtained in Step 2."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.rev.ai/speechtotext/v1/jobs/<ID>/transcript\" \\\n     -H \"Authorization: Bearer <REVAI_ACCESS_TOKEN>\" \\\n     -H \"Accept: application/vnd.rev.transcript.v1.0+json\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Here is an example of the output:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n  \"monologues\": [\n    {\n      \"speaker\": 1,\n      \"elements\": [\n        {\n          \"type\": \"text\",\n          \"value\": \"Hi\",\n          \"ts\": 0.27,\n          \"end_ts\": 0.32,\n          \"confidence\": 1\n        },\n        {\n          \"type\": \"punct\",\n          \"value\": \",\"\n        },\n        {\n          \"type\": \"punct\",\n          \"value\": \" \"\n        },        \n        {\n          \"type\": \"text\",\n          \"value\": \"my\",\n          \"ts\": 0.35,\n          \"end_ts\": 0.46,\n          \"confidence\": 1\n        },\n        {\n          \"type\": \"punct\",\n          \"value\": \" \"\n        },\n        {\n          \"type\": \"text\",\n          \"value\": \"name's\",\n          \"ts\": 0.47,\n          \"end_ts\": 0.59,\n          \"confidence\": 1\n        },\n        {\n          ...\n        }\n      ]\n    },\n    {\n      ...\n    }\n  ]\n}\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Alternatively, you can get the plaintext version by running the command below:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.rev.ai/speechtotext/v1/jobs/<ID>/transcript\" \\\n     -H \"Authorization: Bearer <REVAI_ACCESS_TOKEN>\" \\\n     -H \"Accept: text/plain\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":5},"children":["Next steps"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You should now have a basic idea of how to use the Rev AI APIs. To learn more, read ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api"},"children":["the API documentation"]}," for complete details on the different APIs available and their features. You can also find ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk"},"children":["code samples and SDK documentation"]}," that will help you connect your application with the APIs."]}]},"headings":[{"value":"Get Started","id":"get-started","depth":1},{"value":"Assumptions","id":"assumptions","depth":2},{"value":"Step 1: Get your access token","id":"step-1-get-your-access-token","depth":2},{"value":"Step 2: Submit a file for transcription","id":"step-2-submit-a-file-for-transcription","depth":2},{"value":"Step 3: Retrieve the transcript","id":"step-3-retrieve-the-transcript","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"title":"Get Started","toc":{"enable":true},"seo":{"title":"Get Started"}},"lastModified":"2026-02-24T14:47:49.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/get-started","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}