Replace note settings
curl --request PUT \
--url https://{deployment}/api/v1/tiro/notes/{note_id} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"title": "<string>",
"transcribe_locale": "<string>",
"translate_locale": "<string>",
"summary_locale": "<string>",
"enable_audio_replay": true,
"enable_realtime_translation": true,
"enable_enhanced_transcription": true
}
'import requests
url = "https://{deployment}/api/v1/tiro/notes/{note_id}"
payload = {
"title": "<string>",
"transcribe_locale": "<string>",
"translate_locale": "<string>",
"summary_locale": "<string>",
"enable_audio_replay": True,
"enable_realtime_translation": True,
"enable_enhanced_transcription": True
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
transcribe_locale: '<string>',
translate_locale: '<string>',
summary_locale: '<string>',
enable_audio_replay: true,
enable_realtime_translation: true,
enable_enhanced_transcription: true
})
};
fetch('https://{deployment}/api/v1/tiro/notes/{note_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{deployment}/api/v1/tiro/notes/{note_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'transcribe_locale' => '<string>',
'translate_locale' => '<string>',
'summary_locale' => '<string>',
'enable_audio_replay' => true,
'enable_realtime_translation' => true,
'enable_enhanced_transcription' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{deployment}/api/v1/tiro/notes/{note_id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"transcribe_locale\": \"<string>\",\n \"translate_locale\": \"<string>\",\n \"summary_locale\": \"<string>\",\n \"enable_audio_replay\": true,\n \"enable_realtime_translation\": true,\n \"enable_enhanced_transcription\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://{deployment}/api/v1/tiro/notes/{note_id}")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"transcribe_locale\": \"<string>\",\n \"translate_locale\": \"<string>\",\n \"summary_locale\": \"<string>\",\n \"enable_audio_replay\": true,\n \"enable_realtime_translation\": true,\n \"enable_enhanced_transcription\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{deployment}/api/v1/tiro/notes/{note_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"transcribe_locale\": \"<string>\",\n \"translate_locale\": \"<string>\",\n \"summary_locale\": \"<string>\",\n \"enable_audio_replay\": true,\n \"enable_realtime_translation\": true,\n \"enable_enhanced_transcription\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"note_id": 123,
"note_guid": "<string>",
"title": "<string>",
"note_url": "<string>",
"message": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}Notes
Replace note settings
Full replace of a note’s settings (title, locales, feature toggles). Pro license required.
PUT
/
tiro
/
notes
/
{note_id}
Replace note settings
curl --request PUT \
--url https://{deployment}/api/v1/tiro/notes/{note_id} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"title": "<string>",
"transcribe_locale": "<string>",
"translate_locale": "<string>",
"summary_locale": "<string>",
"enable_audio_replay": true,
"enable_realtime_translation": true,
"enable_enhanced_transcription": true
}
'import requests
url = "https://{deployment}/api/v1/tiro/notes/{note_id}"
payload = {
"title": "<string>",
"transcribe_locale": "<string>",
"translate_locale": "<string>",
"summary_locale": "<string>",
"enable_audio_replay": True,
"enable_realtime_translation": True,
"enable_enhanced_transcription": True
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
transcribe_locale: '<string>',
translate_locale: '<string>',
summary_locale: '<string>',
enable_audio_replay: true,
enable_realtime_translation: true,
enable_enhanced_transcription: true
})
};
fetch('https://{deployment}/api/v1/tiro/notes/{note_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{deployment}/api/v1/tiro/notes/{note_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'transcribe_locale' => '<string>',
'translate_locale' => '<string>',
'summary_locale' => '<string>',
'enable_audio_replay' => true,
'enable_realtime_translation' => true,
'enable_enhanced_transcription' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{deployment}/api/v1/tiro/notes/{note_id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"transcribe_locale\": \"<string>\",\n \"translate_locale\": \"<string>\",\n \"summary_locale\": \"<string>\",\n \"enable_audio_replay\": true,\n \"enable_realtime_translation\": true,\n \"enable_enhanced_transcription\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://{deployment}/api/v1/tiro/notes/{note_id}")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"transcribe_locale\": \"<string>\",\n \"translate_locale\": \"<string>\",\n \"summary_locale\": \"<string>\",\n \"enable_audio_replay\": true,\n \"enable_realtime_translation\": true,\n \"enable_enhanced_transcription\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{deployment}/api/v1/tiro/notes/{note_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"transcribe_locale\": \"<string>\",\n \"translate_locale\": \"<string>\",\n \"summary_locale\": \"<string>\",\n \"enable_audio_replay\": true,\n \"enable_realtime_translation\": true,\n \"enable_enhanced_transcription\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"note_id": 123,
"note_guid": "<string>",
"title": "<string>",
"note_url": "<string>",
"message": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}Authorizations
Your deployment's API key (MMK_API_KEY).
Path Parameters
Numeric Tiro note ID (not the note GUID — the handler parses it as an integer).
Body
application/json
Was this page helpful?
⌘I

