AALIATALK API Gateway (1.3.0)

Download OpenAPI specification:

Unified API for medical interpretation services

Transcription

Transcribe Audio (Base64)

Transcribe audio encoded as a Base64 string.

Requirements:

  • Container: WAV (RIFF Header required)
  • Format: 16kHz, Mono, 16-bit
Request Body schema: application/json
required
audio_base64
required
string

Base64 encoded WAV file

Responses

Request samples

Content type
application/json
{
  • "audio_base64": "string"
}

Response samples

Content type
application/json
{
  • "text": "string",
  • "language": "string",
  • "success": true
}

Transcribe Audio File

Upload and transcribe a WAV audio file directly.

Requirements:

  • Container: WAV (RIFF Header required)
  • Format: 16kHz, Mono, 16-bit
Request Body schema: multipart/form-data
required
file
required
string <binary>

WAV audio file

Responses

Request samples

curl -X POST "https://dev.fr.vokaalia.com/api/v1/transcribe/file" \
  -H "accept: application/json" \
  -F "file=@audio.wav"

Response samples

Content type
application/json
{
  • "text": "string",
  • "language": "string",
  • "success": true
}

Translation

Translate

Translate text from source language to target language.

Use the code field from GET /translation/languages for both source_language and target_language.

Request Body schema: application/json
required
text
required
string (Text) [ 1 .. 5000 ] characters
source_language
required
string (Source Language) [ 1 .. 32 ] characters

Opaque language code as returned by GET /translation/languages

target_language
required
string (Target Language) [ 1 .. 32 ] characters

Opaque language code as returned by GET /translation/languages

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "source_language": "string",
  • "target_language": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "source_language": "string",
  • "target_language": "string",
  • "original_text": "string",
  • "translated_text": "string",
  • "translation_seconds": 0,
  • "timestamp": "2019-08-24T14:15:22Z"
}

Get Supported Languages

Get the list of languages supported by the translation service.

Each entry includes BCP-47, ISO 639-1, ISO 639-3, display name, and an opaque code to use in translate requests.

Responses

Request samples

curl -X GET "https://dev.fr.vokaalia.com/api/v1/translation/languages"

Response samples

Content type
application/json
{
  • "languages": [
    ],
  • "total": 0
}

Synthetize

Text To Speech

Convert text to speech audio.

  • text: The text to synthesize (max 5000 characters)
  • language: Language code (e.g., 'fr', 'en', 'es')
  • gender: Voice gender ('male' or 'female')
  • Returns audio/wav stream
Request Body schema: application/json
required
text
required
string (Text) [ 1 .. 5000 ] characters
language
required
string (Language) ^[a-z]{2}$
gender
required
string (Gender)
Enum: "male" "female"

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "language": "string",
  • "gender": "male"
}

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Get Available Voices

Get list of available voices/languages.

Responses

Request samples

curl -X GET "https://dev.fr.vokaalia.com/api/v1/synthetize/voices"

Response samples

Content type
application/json
{
  • "voices": [
    ]
}

Reformulation

Paraphrase Text

Paraphrase medical text. Returns a context aware paraphrased text based on the input text.

Request Body schema: application/json
required
sentence
required
string (Sentence) [ 1 .. 5000 ] characters
gender
string (Gender)
Default: "male"
Enum: "male" "female"
age_category
string (Age Category)
Default: "adult"
Enum: "adolescent" "senior" "child" "adult"

Responses

Request samples

Content type
application/json
{
  • "sentence": "string",
  • "gender": "male",
  • "age_category": "adolescent"
}

Response samples

Content type
application/json
{
  • "paraphrases": "string"
}

Summarize Text

Summarize text. Creates a concise summary of longer text.

Request Body schema: application/json
required
sentence
required
string (Sentence) [ 1 .. 50000 ] characters

Responses

Request samples

Content type
application/json
{
  • "sentence": "string"
}

Response samples

Content type
application/json
{
  • "summary": "string"
}

Generate Text

Generates medical text from a prompt

Request Body schema: application/json
required
prompt
required
string (Prompt) [ 1 .. 1000 ] characters

Responses

Request samples

Content type
application/json
{
  • "prompt": "string"
}

Response samples

Content type
application/json
{
  • "resultat": "string"
}

Summarize Patient Info

Creates a structured medical summary of patient information

Request Body schema: application/json
required
sentence
required
string (Sentence) non-empty
target_language
required
string (Target Language)

Responses

Request samples

Content type
application/json
{
  • "sentence": "string",
  • "target_language": "fr"
}

Response samples

Content type
application/json
{
  • "summary": "string"
}