<Microsoft> developer portal

Speech to Text API v2.0

Speech to Text API v2.0.

Create Transcription

Creates a new transcription.

Select the testing console in the region where you created your resource:

Australia East Brazil South Canada Central Central India Central US Central US EUAP East Asia East US East US 2 France Central Japan East Japan West Korea Central North Central US North Europe South Central US Southeast Asia Switzerland North UK South West Central US West Europe West US West US 2

Request URL

https://{endpoint}/speechtotext/v2.0/transcriptions

Request headers

Content-Type

string

Media type of the body sent to the API.

Ocp-Apim-Subscription-Key

string

Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

The details of the new transcription.

application/json

Sample
Schema

{
  "recordingsUrl": "https://contoso.com/mystoragelocation",
  "models": [],
  "locale": "en-US",
  "name": "Transcription using locale en-US",
  "description": "An optional description of the transcription.",
  "properties": {
    "AddWordLevelTimestamps": "True",
    "AddDiarization": "True",
    "AddSentiment": "True",
    "ProfanityFilterMode": "Masked",
    "PunctuationMode": "DictatedAndAutomatic"
  }
}

{
  "title": "TranscriptionDefinition",
  "required": [
    "recordingsUrl",
    "locale",
    "name"
  ],
  "type": "object",
  "properties": {
    "recordingsUrl": {
      "type": "string",
      "readOnly": false
    },
    "models": {
      "description": "The models used in this transcription",
      "type": "array",
      "items": {
        "title": "ModelIdentity",
        "required": [
          "id"
        ],
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "description": "The identifier of this entity",
            "type": "string",
            "readOnly": false,
            "example": "00000000-0000-0000-0000-000000000000"
          }
        }
      },
      "readOnly": false
    },
    "locale": {
      "description": "The locale of the contained data",
      "type": "string",
      "readOnly": false
    },
    "name": {
      "description": "The name of the object",
      "type": "string",
      "readOnly": false
    },
    "description": {
      "description": "The description of the object",
      "type": "string",
      "readOnly": false
    },
    "properties": {
      "description": "The custom properties of this entity",
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "readOnly": false
    }
  },
  "example": {
    "recordingsUrl": "https://contoso.com/mystoragelocation",
    "models": [],
    "locale": "en-US",
    "name": "Transcription using locale en-US",
    "description": "An optional description of the transcription.",
    "properties": {
      "AddWordLevelTimestamps": "True",
      "AddDiarization": "True",
      "AddSentiment": "True",
      "ProfanityFilterMode": "Masked",
      "PunctuationMode": "DictatedAndAutomatic"
    }
  }
}

Response 202

The response contains the location of the entity as header.

Response 400

In case the operation cannot be performed successfully.

application/json

{
  "code": "BadRequest",
  "message": "The request has been incorrect."
}

Response 401

In case the user isn't authorized.

application/json

{
  "code": "Unauthorized",
  "message": "Authentication is required to access the resource."
}

Response 403

In case authorized user isn't known or doesn't have the required permissions.

application/json

{
  "code": "Forbidden",
  "message": "No permission to access this resource."
}

Response 429

In case the rate limit has been exceeded.

application/json

{
  "code": "TooManyRequests",
  "message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
}

Code samples

@ECHO OFF

curl -v -X POST "https://northeurope.api.cognitive.microsoft.com/speechtotext/v2.0/transcriptions"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}"

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://northeurope.api.cognitive.microsoft.com/speechtotext/v2.0/transcriptions?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}

// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://northeurope.api.cognitive.microsoft.com/speechtotext/v2.0/transcriptions");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://northeurope.api.cognitive.microsoft.com/speechtotext/v2.0/transcriptions?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://northeurope.api.cognitive.microsoft.com/speechtotext/v2.0/transcriptions";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://northeurope.api.cognitive.microsoft.com/speechtotext/v2.0/transcriptions');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>

########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('northeurope.api.cognitive.microsoft.com')
    conn.request("POST", "/speechtotext/v2.0/transcriptions?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('northeurope.api.cognitive.microsoft.com')
    conn.request("POST", "/speechtotext/v2.0/transcriptions?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

require 'net/http'

uri = URI('https://northeurope.api.cognitive.microsoft.com/speechtotext/v2.0/transcriptions')
uri.query = URI.encode_www_form({
})

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body