[GET] Task Speakers

Use this request to get information about speakers in a specific task and workspace.

Task Speakers

GET/api/v1.0/external/transcripts/speakers/tasks/{taskId}/{workspaceId}

Path Parameters

Name	Type	Description
taskId	integer	The ID that identifies the task to retrieve data on. This ID is always unique and never changes after it has been created.
workspaceId	integer	The ID that identifies the workspace to retrieve data on. This ID is always unique and never changes after it has been created.

Example Request

curl

curl -X GET 'https://cloud.smartdocumentor.net/api/v1.0/external/transcripts/speakers/tasks/1234/5678' \
  --header 'Authorization: Bearer {your access token here}' \
  --header 'Accept: application/json'

C#

var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://cloud.smartdocumentor.net/api/v1.0/external/transcripts/speakers/tasks/1234/5678");
request.Headers.Add("Authorization", "Bearer {your access token here}");
request.Headers.Add("Accept", "application/json");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();

Console.WriteLine(await response.Content.ReadAsStringAsync());

Python

import requests

url = "https://cloud.smartdocumentor.net/api/v1.0/external/transcripts/speakers/tasks/1234/5678"

headers = {
    'Authorization': 'Bearer {your access token here}',
    'Accept': 'application/json'
}

response = requests.get(url, headers=headers)

print(response.text)

Javascript

const myHeaders = new Headers();
const accessToken = "your access token here";
myHeaders.append("Authorization", `Bearer ${accessToken}`);

const requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};

fetch("https://cloud.smartdocumentor.net/api/v1.0/external/transcripts/speakers/tasks/1234/5678", requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Responses

200 OK

{
  "speakers": [
    {
      "speakerId": "5d4e2394-aa6c-4393-9d91-21ef032fe881",
      "speakerName": "Some Name",
      "speakerPrefix": "Some Prefix",
      "speakerSuffix": "Some Suffix",
      "isDefault": true,
      "source": 10
    }
  ]
}

Response Body ExternalTaskSpeakers

Name	Type	Description
speakers	[ExternalTaskSpeakerViewModel]	The list of speakers.

Response Body ExternalTaskSpeakerViewModel

Name	Type	Description
speakerId	string	The unique identifier of your Speaker.
speakerName	string	The name of your Speaker.
speakerPrefix	string (optional)	Optional prefix for your Speaker.
speakerSuffix	string (optional)	Optional suffix for your Speaker.
isDefault	boolean	Identifies whether the Speaker is the default speaker. Only one per task.
source	SpeakerSource	Source to which the Speaker belongs

500 Internal Server Error

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.6.1",
    "title": "InternalError",
    "status": 500,
    "detail": "An unexpected error occurred while retrieving speakers.",
    "instance": null,
    "extensions": {
        "traceId": "00-a3422c816352397da4f8eba450cc041e-cccf673814f53073-01"
    }
}

Response Body Problem Detail JSON Object