falaai-api 1.21.47

data/docs/ParticipantDiagnostic.md

@@ -0,0 +1,26 @@
+# FalaAI::ParticipantDiagnostic
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **interlocutor** | **String** | Exact speaker label from the dialog (e.g. 'Speaker 1') |  |
+| **role** | **String** | Role: agent | client | bot | agent_requester | agent_custodian |  |
+| **name** | **String** | Participant name if mentioned in the dialogue | [optional] |
+| **confidence** | **String** | high | medium | low | [optional] |
+| **evidence** | **String** | Exact verbatim quote supporting the role (no timestamps) | [optional] |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::ParticipantDiagnostic.new(
+  interlocutor: Speaker 1,
+  role: client,
+  name: Antônio,
+  confidence: high,
+  evidence: Tá quarenta reais e setenta e um, Antônio.
+)
+```
+

data/docs/SpeechApi.md

@@ -0,0 +1,85 @@
+# FalaAI::SpeechApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_transcription_v1_audio_transcriptions_post**](SpeechApi.md#create_transcription_v1_audio_transcriptions_post) | **POST** /v1/audio/transcriptions | Transcribe audio to text |
+
+
+## create_transcription_v1_audio_transcriptions_post
+
+> <TranscriptionResponse> create_transcription_v1_audio_transcriptions_post(file, opts)
+
+Transcribe audio to text
+
+Upload an audio file and receive transcription with speaker diarization, audio events, and dialog.  **Supported formats:** .mp3, .mp4, .m4a, .wav, .flac, .ogg, .webm, .aac, .opus  **Limits:** - Maximum audio duration: 3 hours - Maximum file size: 1GB - Cost: 1 credit per second of audio (rounded up), minimum 1 credit  **Supported languages:** pt, en, es, fr, de, it, ja, ko, nl, pl, ru, tr, zh, vi, id, th, ar, hi, cs, da, el, fi, he, hu, ms, no, ro, sk, sv, ta, uk  **Python:** ```python import httpx  response = httpx.post(     'https://api.fala.ai/v1/audio/transcriptions',     headers={'Authorization': 'Bearer fai_xxx'},     files={'file': open('call.mp3', 'rb')},     data={'model': 'falaai-transcribe-1', 'language': 'pt'} ) print(response.json()) ```  **cURL:** ```bash curl https://api.fala.ai/v1/audio/transcriptions \\   -H 'Authorization: Bearer fai_xxx' \\   -F 'file=@call.mp3' \\   -F 'model=falaai-transcribe-1' \\   -F 'language=pt' ```
+
+### Examples
+
+```ruby
+require 'time'
+require 'falaai-api'
+# setup authorization
+FalaAI.configure do |config|
+  # Configure Bearer authorization (fai_xxx): ApiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = FalaAI::SpeechApi.new
+file = File.new('/path/to/some/file') # File | 
+opts = {
+  model: 'model_example', # String | 
+  language: 'language_example', # String | 
+  client_reference_id: 'client_reference_id_example' # String | Optional client-supplied ID echoed verbatim in the response. Use to correlate/sync with your system. Accepted charset: [A-Za-z0-9._:-]. Not idempotency.
+}
+
+begin
+  # Transcribe audio to text
+  result = api_instance.create_transcription_v1_audio_transcriptions_post(file, opts)
+  p result
+rescue FalaAI::ApiError => e
+  puts "Error when calling SpeechApi->create_transcription_v1_audio_transcriptions_post: #{e}"
+end
+```
+
+#### Using the create_transcription_v1_audio_transcriptions_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TranscriptionResponse>, Integer, Hash)> create_transcription_v1_audio_transcriptions_post_with_http_info(file, opts)
+
+```ruby
+begin
+  # Transcribe audio to text
+  data, status_code, headers = api_instance.create_transcription_v1_audio_transcriptions_post_with_http_info(file, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TranscriptionResponse>
+rescue FalaAI::ApiError => e
+  puts "Error when calling SpeechApi->create_transcription_v1_audio_transcriptions_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file** | **File** |  |  |
+| **model** | **String** |  | [optional][default to &#39;falaai-transcribe-1&#39;] |
+| **language** | **String** |  | [optional][default to &#39;pt&#39;] |
+| **client_reference_id** | **String** | Optional client-supplied ID echoed verbatim in the response. Use to correlate/sync with your system. Accepted charset: [A-Za-z0-9._:-]. Not idempotency. | [optional] |
+
+### Return type
+
+[**TranscriptionResponse**](TranscriptionResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+

data/docs/TranscriptionResponse.md

@@ -0,0 +1,49 @@
+# FalaAI::TranscriptionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique transcription identifier. Prefix 'tr-' followed by UUID |  |
+| **object** | **String** | Returned object type. Always 'transcription' |  |
+| **model** | **String** | Model used for transcription. Ex: 'falaai-transcribe-1' |  |
+| **filename** | **String** | Original audio file name uploaded |  |
+| **processed_at** | **String** | Processing datetime in ISO 8601 UTC format |  |
+| **usage** | [**TranscriptionUsage**](TranscriptionUsage.md) | Usage and processing information |  |
+| **language** | **String** | ISO 639-3 language code detected in audio. Ex: 'por' (Portuguese), 'eng' (English), 'spa' (Spanish) |  |
+| **language_confidence** | **Float** | Language detection confidence level (0.0 to 1.0). Higher is more reliable | [optional] |
+| **duration_seconds** | **Float** | Total audio duration in seconds |  |
+| **text** | **String** | Full transcription as plain text, including audio events in brackets |  |
+| **dialog** | **String** | Turn-by-turn formatted transcript with speaker identification and start/end timestamps |  |
+| **audio_events** | [**Array<AudioEvent>**](AudioEvent.md) | List of detected audio events (laughs, sighs, pauses, etc) with timestamps and duration |  |
+| **event_types** | **Array<String>** | Unique audio event types found in transcription, alphabetically sorted |  |
+| **word_count** | **Integer** | Total number of recognized words in transcription |  |
+| **input** | [**AudioInputMeta**](AudioInputMeta.md) | Metadados do arquivo de audio enviado (duracao, formato, codec, sample rate, canais) |  |
+| **client_reference_id** | **String** | Client-supplied ID echoed verbatim (if provided in request) | [optional] |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::TranscriptionResponse.new(
+  id: tr-550e8400-e29b-41d4-a716-446655440000,
+  object: transcription,
+  model: falaai-transcribe-1,
+  filename: chamada.mp3,
+  processed_at: 2026-06-25T01:00:35.399252+00:00,
+  usage: null,
+  language: por,
+  language_confidence: 1.0,
+  duration_seconds: 151.04,
+  text: Oi, Alex. Oi. O, Thais- Oi...,
+  dialog: Speaker 1: [00:00:00.540 - 00:00:01.139] Oi, Alex.
+Speaker 2: [00:00:01.940 - 00:00:02.720] Oi...,
+  audio_events: null,
+  event_types: [[riso], [suspiro]],
+  word_count: 773,
+  input: null,
+  client_reference_id: call-2026-08-30-001
+)
+```
+

data/docs/TranscriptionUsage.md

@@ -0,0 +1,22 @@
+# FalaAI::TranscriptionUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **audio_seconds** | **Float** | Actual audio duration processed in seconds |  |
+| **credits_consumed** | **Integer** | Number of credits consumed in this request |  |
+| **processing_ms** | **Integer** | Total processing time in milliseconds |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::TranscriptionUsage.new(
+  audio_seconds: 151.04,
+  credits_consumed: 65,
+  processing_ms: 15156
+)
+```
+

data/docs/UpdateEmailAlertRequest.md

@@ -0,0 +1,24 @@
+# FalaAI::UpdateEmailAlertRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **events** | [**Array<EmailEvent>**](EmailEvent.md) |  | [optional] |
+| **active** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::UpdateEmailAlertRequest.new(
+  name: null,
+  email: null,
+  events: null,
+  active: null
+)
+```
+

data/docs/UpdateWebhookRequest.md

@@ -0,0 +1,26 @@
+# FalaAI::UpdateWebhookRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Nome identificador | [optional] |
+| **url** | **String** | URL HTTPS destino | [optional] |
+| **events** | [**Array<WebhookEvent>**](WebhookEvent.md) | Eventos subscritos | [optional] |
+| **retry_enabled** | **Boolean** | Habilita retry exponencial | [optional] |
+| **active** | **Boolean** | Ativa/desativa sem deletar | [optional] |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::UpdateWebhookRequest.new(
+  name: Alertas FalaAI,
+  url: https://webhook.site/00000000-0000-0000-0000-000000000000,
+  events: [credits.low],
+  retry_enabled: true,
+  active: true
+)
+```
+

data/docs/UsageApi.md

@@ -0,0 +1,151 @@
+# FalaAI::UsageApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_usage_by_key_v1_usage_by_key_get**](UsageApi.md#get_usage_by_key_v1_usage_by_key_get) | **GET** /v1/usage/by-key | Get Usage By Key |
+| [**get_usage_log_v1_usage_log_get**](UsageApi.md#get_usage_log_v1_usage_log_get) | **GET** /v1/usage/log | Get Usage Log |
+
+
+## get_usage_by_key_v1_usage_by_key_get
+
+> <Array<UsageByKeyItem>> get_usage_by_key_v1_usage_by_key_get(opts)
+
+Get Usage By Key
+
+### Examples
+
+```ruby
+require 'time'
+require 'falaai-api'
+# setup authorization
+FalaAI.configure do |config|
+  # Configure Bearer authorization (fai_xxx): ApiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = FalaAI::UsageApi.new
+opts = {
+  key_id: 'key_id_example' # String | 
+}
+
+begin
+  # Get Usage By Key
+  result = api_instance.get_usage_by_key_v1_usage_by_key_get(opts)
+  p result
+rescue FalaAI::ApiError => e
+  puts "Error when calling UsageApi->get_usage_by_key_v1_usage_by_key_get: #{e}"
+end
+```
+
+#### Using the get_usage_by_key_v1_usage_by_key_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<UsageByKeyItem>>, Integer, Hash)> get_usage_by_key_v1_usage_by_key_get_with_http_info(opts)
+
+```ruby
+begin
+  # Get Usage By Key
+  data, status_code, headers = api_instance.get_usage_by_key_v1_usage_by_key_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<UsageByKeyItem>>
+rescue FalaAI::ApiError => e
+  puts "Error when calling UsageApi->get_usage_by_key_v1_usage_by_key_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key_id** | **String** |  | [optional] |
+
+### Return type
+
+[**Array&lt;UsageByKeyItem&gt;**](UsageByKeyItem.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_usage_log_v1_usage_log_get
+
+> <UsageLogResponse> get_usage_log_v1_usage_log_get(opts)
+
+Get Usage Log
+
+### Examples
+
+```ruby
+require 'time'
+require 'falaai-api'
+# setup authorization
+FalaAI.configure do |config|
+  # Configure Bearer authorization (fai_xxx): ApiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = FalaAI::UsageApi.new
+opts = {
+  page: 56, # Integer | 
+  limit: 56, # Integer | 
+  api_key_id: 'api_key_id_example' # String | 
+}
+
+begin
+  # Get Usage Log
+  result = api_instance.get_usage_log_v1_usage_log_get(opts)
+  p result
+rescue FalaAI::ApiError => e
+  puts "Error when calling UsageApi->get_usage_log_v1_usage_log_get: #{e}"
+end
+```
+
+#### Using the get_usage_log_v1_usage_log_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UsageLogResponse>, Integer, Hash)> get_usage_log_v1_usage_log_get_with_http_info(opts)
+
+```ruby
+begin
+  # Get Usage Log
+  data, status_code, headers = api_instance.get_usage_log_v1_usage_log_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UsageLogResponse>
+rescue FalaAI::ApiError => e
+  puts "Error when calling UsageApi->get_usage_log_v1_usage_log_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** |  | [optional][default to 1] |
+| **limit** | **Integer** |  | [optional][default to 20] |
+| **api_key_id** | **String** |  | [optional] |
+
+### Return type
+
+[**UsageLogResponse**](UsageLogResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/UsageByKeyItem.md

@@ -0,0 +1,26 @@
+# FalaAI::UsageByKeyItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key_id** | **String** | API key id |  |
+| **key_name** | **String** | API key name |  |
+| **total_credits** | **Integer** | Total credits consumed by the key |  |
+| **request_count** | **Integer** | Number of requests |  |
+| **last_used** | **String** | ISO 8601 of last use (null if never) | [optional] |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::UsageByKeyItem.new(
+  key_id: null,
+  key_name: null,
+  total_credits: null,
+  request_count: null,
+  last_used: null
+)
+```
+

data/docs/UsageLogItem.md

@@ -0,0 +1,28 @@
+# FalaAI::UsageLogItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Usage log entry id |  |
+| **endpoint** | **String** | Endpoint called |  |
+| **credits_cost** | **Integer** | Credits consumed |  |
+| **status** | **String** | Result status |  |
+| **errors_count** | **Integer** | Errors count |  |
+| **created_at** | **String** | ISO 8601 timestamp |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::UsageLogItem.new(
+  id: null,
+  endpoint: null,
+  credits_cost: null,
+  status: null,
+  errors_count: null,
+  created_at: null
+)
+```
+

data/docs/UsageLogResponse.md

@@ -0,0 +1,22 @@
+# FalaAI::UsageLogResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<UsageLogItem>**](UsageLogItem.md) |  |  |
+| **page** | **Integer** |  |  |
+| **limit** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::UsageLogResponse.new(
+  data: null,
+  page: null,
+  limit: null
+)
+```
+

data/docs/ValidationError.md

@@ -0,0 +1,26 @@
+# FalaAI::ValidationError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **loc** | [**Array<LocationInner>**](LocationInner.md) |  |  |
+| **msg** | **String** |  |  |
+| **type** | **String** |  |  |
+| **input** | **Object** |  | [optional] |
+| **ctx** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::ValidationError.new(
+  loc: null,
+  msg: null,
+  type: null,
+  input: null,
+  ctx: null
+)
+```
+

data/docs/VersionApi.md

@@ -0,0 +1,72 @@
+# FalaAI::VersionApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_version_api_version_get**](VersionApi.md#get_version_api_version_get) | **GET** /api/version | Get Version |
+
+
+## get_version_api_version_get
+
+> <VersionResponse> get_version_api_version_get
+
+Get Version
+
+### Examples
+
+```ruby
+require 'time'
+require 'falaai-api'
+# setup authorization
+FalaAI.configure do |config|
+  # Configure Bearer authorization (fai_xxx): ApiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = FalaAI::VersionApi.new
+
+begin
+  # Get Version
+  result = api_instance.get_version_api_version_get
+  p result
+rescue FalaAI::ApiError => e
+  puts "Error when calling VersionApi->get_version_api_version_get: #{e}"
+end
+```
+
+#### Using the get_version_api_version_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VersionResponse>, Integer, Hash)> get_version_api_version_get_with_http_info
+
+```ruby
+begin
+  # Get Version
+  data, status_code, headers = api_instance.get_version_api_version_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VersionResponse>
+rescue FalaAI::ApiError => e
+  puts "Error when calling VersionApi->get_version_api_version_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**VersionResponse**](VersionResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/VersionResponse.md

@@ -0,0 +1,22 @@
+# FalaAI::VersionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **service** | **String** | Service name |  |
+| **version** | **String** | Current API version |  |
+| **deploy_date** | **String** | Deploy timestamp |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::VersionResponse.new(
+  service: FalaAI API,
+  version: api_v1.21.45,
+  deploy_date: 2026-09-22 20260922_023910
+)
+```
+

data/docs/WebhookEvent.md

@@ -0,0 +1,15 @@
+# FalaAI::WebhookEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WebhookEvent.new()
+```
+

data/docs/WebhookItem.md

@@ -0,0 +1,42 @@
+# FalaAI::WebhookItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Webhook id |  |
+| **user_id** | **String** | Owner user id |  |
+| **name** | **String** | Webhook name |  |
+| **url** | **String** | Destination URL |  |
+| **secret** | **String** | HMAC signing secret |  |
+| **events** | **Array<String>** | Subscribed events |  |
+| **active** | **Boolean** | Is active |  |
+| **retry_enabled** | **Boolean** | Retry enabled |  |
+| **last_delivery_at** | **String** | ISO 8601 of last delivery | [optional] |
+| **last_status** | **Integer** | Last HTTP status delivered | [optional] |
+| **failure_count** | **Integer** | Consecutive failures | [optional][default to 0] |
+| **created_at** | **String** | ISO 8601 created |  |
+| **updated_at** | **String** | ISO 8601 updated |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WebhookItem.new(
+  id: null,
+  user_id: null,
+  name: null,
+  url: null,
+  secret: null,
+  events: null,
+  active: null,
+  retry_enabled: null,
+  last_delivery_at: null,
+  last_status: null,
+  failure_count: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/WebhookListResponse.md

@@ -0,0 +1,22 @@
+# FalaAI::WebhookListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<WebhookItem>**](WebhookItem.md) |  |  |
+| **page** | **Integer** |  |  |
+| **limit** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'falaai-api'
+
+instance = FalaAI::WebhookListResponse.new(
+  data: null,
+  page: null,
+  limit: null
+)
+```
+