SmartDocumentor
  • Overview
    • SmartDocumentor
  • GETTING STARTED
    • About SmartDocumentor
    • How SmartDocumentor Works
    • Main concepts
      • Workspaces
      • Organization
    • Quickstart 101
    • Licenses
      • How to Buy?
      • Support
    • Privacy
    • Security
  • Technical
    • Initial Setup
    • Mappings
    • API Reference
      • [POST] Client Credentials Access Token
      • [GET] Task Status
      • [GET] Task Status List
      • [GET] Task Status List Paginated
      • [GET] Get Workspaces
      • [PATCH] Reprocess Task
      • [POST] Create Task
      • [POST] Create Batch
      • [GET] Get Batch
      • [GET] Get Batch Paginated
      • Transcripts
        • Speakers
          • Workspaces
            • [GET] Workspace Speakers
            • [PUT] Workspace Speakers
          • Tasks
            • [GET] Task Speakers
            • [POST] Task Speaker
            • [PUT] Task Speaker
            • [DELETE] Task Speaker
      • Invite Users
        • [GET] List Available Roles
        • Tenants
          • [GET] List All Tenant Users
          • [POST] Invite Users
        • Workspaces
          • [GET] List All Workspace Users
          • [POST] Invite Users
    • Folder Worker
    • Export
      • Webhooks
        • Webhook (Text Documents)
        • Webhook (Transcripts)
        • Webhook Url To File (Transcripts)
        • Webhook Url to File (Anonymization)
    • Changelog
  • FAQs
    • FAQs
Powered by GitBook
On this page
  • Task Speaker
  • Path Parameters
  • Example Request
  • Responses
  1. Technical
  2. API Reference
  3. Transcripts
  4. Speakers
  5. Tasks

[DELETE] Task Speaker

Previous[PUT] Task SpeakerNextInvite Users

Last updated 4 months ago

Use this request to delete a speaker in a specific task and workspace.

Task Speaker

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

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.

speakerId

string

The unique identifier of your Speaker.

Example Request

curl -X 'DELETE' \
'https://cloud.smartdocumentor.net/api/v1.0/external/transcripts/speakers/tasks/1234/5678/90edf137-ea2a-4b59-bf51-45446299d47e' \
  --header 'Authorization: Bearer {your access token here}' \
  --header 'accept: application/json' \
  --header 'Content-Type: application/json'
var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Delete, "https://cloud.smartdocumentor.net/api/v1.0/external/transcripts/speakers/tasks/1234/5678/90edf137-ea2a-4b59-bf51-45446299d47e");
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());
import requests

url = "https://cloud.smartdocumentor.net/api/v1.0/external/transcripts/speakers/tasks/1234/5678/90edf137-ea2a-4b59-bf51-45446299d47e"

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

response = requests.request("DELETE", url, headers=headers)

print(response.text)
var myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer {your access token here}");
myHeaders.append("Accept", "application/json");

var requestOptions = {
  method: 'DELETE',
  headers: myHeaders
};

fetch("https://cloud.smartdocumentor.net/api/v1.0/external/transcripts/speakers/tasks/1234/5678/90edf137-ea2a-4b59-bf51-45446299d47e", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

Responses

{
    "speakerId": "90edf137-ea2a-4b59-bf51-45446299d47e",
    "speakerName": "Some Name",
    "speakerPrefix": "",
    "speakerSuffix": "",
    "isDefault": false
}

Response Body ExternalTaskSpeakerModel

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

Defines whether the Speaker is the default

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "SpeakerIdRequired",
    "status": 400,
    "detail": "All speakers must have a valid ID.",
    "instance": null,
    "extensions": {
        "traceId": "00-de637cdee9a55d62de690f00efeb27ee-a498fdae355af2be-01"
    }
}

Response Body

{
    "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-e1ce801f984167f0dd6fff048dae36f1-aecdff59f7c6abf9-01"
    }
}

Response Body

Problem Detail JSON Object
Problem Detail JSON Object