Transcribe message

curl --request PUT \
  --url https://services-api.talqui.chat/v1/tenants/{tenantID}/messages/{messageID}/transcribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "language": "<string>"
}
'

import requests

url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/messages/{messageID}/transcribe"

payload = { "language": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({language: '<string>'})
};

fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/messages/{messageID}/transcribe', 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://services-api.talqui.chat/v1/tenants/{tenantID}/messages/{messageID}/transcribe",
  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([
    'language' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://services-api.talqui.chat/v1/tenants/{tenantID}/messages/{messageID}/transcribe"

	payload := strings.NewReader("{\n  \"language\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://services-api.talqui.chat/v1/tenants/{tenantID}/messages/{messageID}/transcribe")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"language\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/messages/{messageID}/transcribe")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"language\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": {
    "campaignModelID": "<string>",
    "contactID": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "messageAutonomous": true,
    "messageChannel": "<string>",
    "messageDirection": "<string>",
    "messageFingerprint": "<string>",
    "messageID": "<string>",
    "messageKey": "<string>",
    "messageMeta": {},
    "messageStatus": 123,
    "messageValue": {},
    "operatorID": "<string>",
    "sessionID": "<string>",
    "tenantID": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "messageExternalID": "<string>"
  }
}

{
  "errors": [
    {
      "error": "MissingTenantIDError",
      "error_code": 1001,
      "message": "tenantID is required.",
      "statusCode": 400
    }
  ]
}

{
  "errors": [
    {
      "error": "UnauthorizedError",
      "error_code": 1003,
      "message": "You are not authorized to perform this request.",
      "statusCode": 401
    }
  ]
}

{
  "errors": [
    {
      "error": "ForbiddenError",
      "error_code": 1004,
      "message": "You do not have access to this resource.",
      "statusCode": 403
    }
  ]
}

{
  "errors": [
    {
      "error": "MessageNotFoundError",
      "error_code": 1068,
      "message": "Message not found.",
      "statusCode": 404
    }
  ]
}

{
  "errors": [
    {
      "error": "MessageNotTranscribableError",
      "error_code": 1820,
      "message": "Only audio messages with a media address can be transcribed.",
      "statusCode": 422
    }
  ]
}

{
  "errors": [
    {
      "error": "MissingConfigurationError",
      "error_code": 5001,
      "message": "Required configuration is missing.",
      "statusCode": 500
    }
  ]
}

{
  "errors": [
    {
      "error": "MessageTranscribeFailedError",
      "error_code": 5015,
      "message": "Failed to transcribe the message audio.",
      "statusCode": 502
    }
  ]
}

Messages

Transcribe message

Transcreve o áudio de uma mensagem (messageKey: 'audio' ou 'voice') e grava o resultado em messageValue.transcription.

Roda de forma síncrona: a resposta já traz a mensagem transcrita. Use o POST no mesmo path quando a transcrição puder ser processada em segundo plano — ele devolve 202 e o resultado chega pelo socket.

Se a mensagem já possui messageValue.transcription, o endpoint devolve a mensagem imediatamente, sem rodar o motor novamente.

O motor é escolhido pela env MESSAGE_TRANSCRIBE_ENGINE (whisper na nossa infra, ou litellm-audio / litellm-chat via LiteLLM).

Em ambos os casos um evento service:transcribe:processed é emitido no socket do tenant.

PUT

tenants

{tenantID}

messages

{messageID}

transcribe

Transcribe message

curl --request PUT \
  --url https://services-api.talqui.chat/v1/tenants/{tenantID}/messages/{messageID}/transcribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "language": "<string>"
}
'

import requests

url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/messages/{messageID}/transcribe"

payload = { "language": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({language: '<string>'})
};

fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/messages/{messageID}/transcribe', 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://services-api.talqui.chat/v1/tenants/{tenantID}/messages/{messageID}/transcribe",
  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([
    'language' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://services-api.talqui.chat/v1/tenants/{tenantID}/messages/{messageID}/transcribe"

	payload := strings.NewReader("{\n  \"language\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://services-api.talqui.chat/v1/tenants/{tenantID}/messages/{messageID}/transcribe")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"language\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/messages/{messageID}/transcribe")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"language\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": {
    "campaignModelID": "<string>",
    "contactID": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "messageAutonomous": true,
    "messageChannel": "<string>",
    "messageDirection": "<string>",
    "messageFingerprint": "<string>",
    "messageID": "<string>",
    "messageKey": "<string>",
    "messageMeta": {},
    "messageStatus": 123,
    "messageValue": {},
    "operatorID": "<string>",
    "sessionID": "<string>",
    "tenantID": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "messageExternalID": "<string>"
  }
}

{
  "errors": [
    {
      "error": "MissingTenantIDError",
      "error_code": 1001,
      "message": "tenantID is required.",
      "statusCode": 400
    }
  ]
}

{
  "errors": [
    {
      "error": "UnauthorizedError",
      "error_code": 1003,
      "message": "You are not authorized to perform this request.",
      "statusCode": 401
    }
  ]
}

{
  "errors": [
    {
      "error": "ForbiddenError",
      "error_code": 1004,
      "message": "You do not have access to this resource.",
      "statusCode": 403
    }
  ]
}

{
  "errors": [
    {
      "error": "MessageNotFoundError",
      "error_code": 1068,
      "message": "Message not found.",
      "statusCode": 404
    }
  ]
}

{
  "errors": [
    {
      "error": "MessageNotTranscribableError",
      "error_code": 1820,
      "message": "Only audio messages with a media address can be transcribed.",
      "statusCode": 422
    }
  ]
}

{
  "errors": [
    {
      "error": "MissingConfigurationError",
      "error_code": 5001,
      "message": "Required configuration is missing.",
      "statusCode": 500
    }
  ]
}

{
  "errors": [
    {
      "error": "MessageTranscribeFailedError",
      "error_code": 5015,
      "message": "Failed to transcribe the message audio.",
      "statusCode": 502
    }
  ]
}

Authorizations

Authorization

string

header

required

Behalf of an Operator (default). A JWT issued by Talqui Core when an operator signs in, scoped to every tenant that operator belongs to. Send as Authorization: Bearer <jwt-token>.

Path Parameters

tenantID

string<uuid>

required

The tenant the message belongs to.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

messageID

string<uuid>

required

The audio message to transcribe.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

language

string

ISO-639-1 language hint for the engine (defaults to pt).

Required string length: 2 - 5

Response

Response for status 200.

message

object

required

The message with messageValue.transcription filled in.

Show child attributes

⌘I

Real Time API

Services API

Helpdesk API

Transcribe message

Authorizations

Path Parameters

Body

Response