falaai-api 1.21.49 → 1.21.51
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +36 -38
- data/docs/RiskAuditRequest.md +1 -1
- data/docs/WhatsappApi.md +93 -0
- data/docs/WhatsappConversation.md +32 -0
- data/docs/WhatsappConversationsResponse.md +28 -0
- data/docs/WhatsappMeta.md +48 -0
- data/docs/WhatsappSpeaker.md +20 -0
- data/docs/WhatsappUsage.md +24 -0
- data/docs/index.html +32 -29
- data/docs/llms.txt +18 -0
- data/docs/robots.txt +4 -0
- data/docs/sitemap.xml +8 -0
- data/lib/falaai-api/api/analysis_api.rb +1 -1
- data/lib/falaai-api/api/email_alerts_api.rb +1 -1
- data/lib/falaai-api/api/health_api.rb +1 -1
- data/lib/falaai-api/api/speech_api.rb +1 -1
- data/lib/falaai-api/api/usage_api.rb +1 -1
- data/lib/falaai-api/api/version_api.rb +1 -1
- data/lib/falaai-api/api/webhooks_api.rb +1 -1
- data/lib/falaai-api/api/whatsapp_api.rb +129 -0
- data/lib/falaai-api/api_client.rb +1 -1
- data/lib/falaai-api/api_error.rb +1 -1
- data/lib/falaai-api/api_model_base.rb +1 -1
- data/lib/falaai-api/configuration.rb +1 -1
- data/lib/falaai-api/models/audio_event.rb +1 -1
- data/lib/falaai-api/models/audio_input_meta.rb +1 -1
- data/lib/falaai-api/models/create_email_alert_request.rb +1 -1
- data/lib/falaai-api/models/create_webhook_request.rb +1 -1
- data/lib/falaai-api/models/diagnostic_analysis_map.rb +1 -1
- data/lib/falaai-api/models/diagnostic_audio_event.rb +1 -1
- data/lib/falaai-api/models/diagnostic_categorical_analysis.rb +1 -1
- data/lib/falaai-api/models/diagnostic_participant.rb +1 -1
- data/lib/falaai-api/models/diagnostic_request.rb +1 -1
- data/lib/falaai-api/models/diagnostic_response.rb +1 -1
- data/lib/falaai-api/models/diagnostic_text_analysis.rb +1 -1
- data/lib/falaai-api/models/diagnostic_usage.rb +1 -1
- data/lib/falaai-api/models/email_alert_item.rb +1 -1
- data/lib/falaai-api/models/email_alert_list_response.rb +1 -1
- data/lib/falaai-api/models/email_alert_message_response.rb +1 -1
- data/lib/falaai-api/models/email_event.rb +1 -1
- data/lib/falaai-api/models/health_response.rb +1 -1
- data/lib/falaai-api/models/http_validation_error.rb +1 -1
- data/lib/falaai-api/models/location_inner.rb +1 -1
- data/lib/falaai-api/models/message_response.rb +1 -1
- data/lib/falaai-api/models/participant.rb +1 -1
- data/lib/falaai-api/models/participant_diagnostic.rb +1 -1
- data/lib/falaai-api/models/risk_audit_analysis_v2.rb +1 -1
- data/lib/falaai-api/models/risk_audit_applied_action_v2.rb +1 -1
- data/lib/falaai-api/models/risk_audit_audio_event_model_v2.rb +1 -1
- data/lib/falaai-api/models/risk_audit_audit_decisions_v2.rb +1 -1
- data/lib/falaai-api/models/risk_audit_conversation_scores_v2.rb +1 -1
- data/lib/falaai-api/models/risk_audit_detection_item_v2.rb +1 -1
- data/lib/falaai-api/models/risk_audit_detections_v2.rb +1 -1
- data/lib/falaai-api/models/risk_audit_indexer_v2.rb +1 -1
- data/lib/falaai-api/models/risk_audit_meta_v2.rb +1 -1
- data/lib/falaai-api/models/risk_audit_participant_v2.rb +1 -1
- data/lib/falaai-api/models/risk_audit_participants_v2.rb +1 -1
- data/lib/falaai-api/models/risk_audit_request.rb +9 -18
- data/lib/falaai-api/models/risk_audit_scores_v2.rb +1 -1
- data/lib/falaai-api/models/risk_audit_scoring_explanation_v2.rb +1 -1
- data/lib/falaai-api/models/risk_audit_summary_v2.rb +1 -1
- data/lib/falaai-api/models/risk_audit_timeline_v2.rb +1 -1
- data/lib/falaai-api/models/risk_audit_usage_v2.rb +1 -1
- data/lib/falaai-api/models/risk_audit_v2.rb +1 -1
- data/lib/falaai-api/models/risk_audit_v2_response.rb +1 -1
- data/lib/falaai-api/models/risk_audit_verdict_v2.rb +1 -1
- data/lib/falaai-api/models/transcription_response.rb +1 -1
- data/lib/falaai-api/models/transcription_usage.rb +1 -1
- data/lib/falaai-api/models/update_email_alert_request.rb +1 -1
- data/lib/falaai-api/models/update_webhook_request.rb +1 -1
- data/lib/falaai-api/models/usage_by_key_item.rb +1 -1
- data/lib/falaai-api/models/usage_log_item.rb +1 -1
- data/lib/falaai-api/models/usage_log_response.rb +1 -1
- data/lib/falaai-api/models/validation_error.rb +1 -1
- data/lib/falaai-api/models/version_response.rb +1 -1
- data/lib/falaai-api/models/webhook_event.rb +1 -1
- data/lib/falaai-api/models/webhook_item.rb +1 -1
- data/lib/falaai-api/models/webhook_list_response.rb +1 -1
- data/lib/falaai-api/models/whatsapp_conversation.rb +356 -0
- data/lib/falaai-api/models/whatsapp_conversations_response.rb +285 -0
- data/lib/falaai-api/models/whatsapp_meta.rb +570 -0
- data/lib/falaai-api/models/whatsapp_speaker.rb +192 -0
- data/lib/falaai-api/models/whatsapp_usage.rb +246 -0
- data/lib/falaai-api/version.rb +2 -2
- data/lib/falaai-api.rb +7 -1
- metadata +17 -2
data/docs/index.html
CHANGED
|
@@ -266,9 +266,6 @@ data-styled.g61[id="sc-iNyHtD"]{content:"kUjPnZ,"}/*!sc*/
|
|
|
266
266
|
data-styled.g62[id="sc-jePOid"]{content:"ehlihR,"}/*!sc*/
|
|
267
267
|
.dHYagA{color:#d41f1c;font-size:0.9em;font-weight:normal;margin-left:20px;line-height:1;}/*!sc*/
|
|
268
268
|
data-styled.g63[id="sc-eIYgEQ"]{content:"dHYagA,"}/*!sc*/
|
|
269
|
-
.grmBkm{color:#0e7c86;font-family:Courier,monospace;font-size:12px;}/*!sc*/
|
|
270
|
-
.grmBkm::before,.grmBkm::after{content:' ';}/*!sc*/
|
|
271
|
-
data-styled.g66[id="sc-eibAPZ"]{content:"grmBkm,"}/*!sc*/
|
|
272
269
|
.OXDYs{border-radius:2px;word-break:break-word;background-color:rgba(51,51,51,0.05);color:rgba(51,51,51,0.9);padding:0 5px;border:1px solid rgba(51,51,51,0.1);font-family:Courier,monospace;}/*!sc*/
|
|
273
270
|
.sc-lbFCLI+.sc-lbFCLI{margin-left:0;}/*!sc*/
|
|
274
271
|
data-styled.g67[id="sc-lbFCLI"]{content:"OXDYs,"}/*!sc*/
|
|
@@ -405,7 +402,7 @@ data-styled.g139[id="sc-iIvZUO"]{content:"kAmnlO,"}/*!sc*/
|
|
|
405
402
|
|
|
406
403
|
<body>
|
|
407
404
|
|
|
408
|
-
<div id="redoc"><div class="sc-dwkskT jetsmW redoc-wrap"><div class="sc-eVYbGh cczbHe menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-kijJqc uMSfb"><svg class="sc-iIvZUO kAmnlO search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input placeholder="Search..." aria-label="Search" type="text" class="sc-cLhBAz fTcICO search-input" value=""/></div><div class="sc-kLEbxe iOXjCz scrollbar-container undefined"><ul role="menu" class="sc-ilnrqe dqIuaF"><li tabindex="0" depth="1" data-item-id="tag/speech" role="menuitem" aria-label="speech" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY buxoPL -depth1"><span width="calc(100% - 38px)" title="speech" class="sc-eHoOIp ehBKwY">speech</span><svg class="sc-dYjPD kdgFPv" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul role="menu" class="sc-ilnrqe gTfiRs"><li tabindex="0" depth="2" data-item-id="tag/speech/operation/create_transcription_v1_audio_transcriptions_post" role="menuitem" aria-label="Transcribe audio to text" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="post" class="sc-XpSrr jjsIAS operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Transcribe audio to text</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/analysis" role="menuitem" aria-label="analysis" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY buxoPL -depth1"><span width="calc(100% - 38px)" title="analysis" class="sc-eHoOIp ehBKwY">analysis</span><svg class="sc-dYjPD kdgFPv" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul role="menu" class="sc-ilnrqe gTfiRs"><li tabindex="0" depth="2" data-item-id="tag/analysis/operation/create_diagnostic_v1_analyze_diagnostic_post" role="menuitem" aria-label="Analyze a call transcript — 5 parallel analyses" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="post" class="sc-XpSrr jjsIAS operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Analyze a call transcript — 5 parallel analyses</span></label></li><li tabindex="0" depth="2" data-item-id="tag/analysis/operation/create_risk_audit_v1_analyze_riskAudit_post" role="menuitem" aria-label="Compliance Risk Audit — conversation compliance analysis" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="post" class="sc-XpSrr jjsIAS operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Compliance Risk Audit — conversation compliance analysis</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/usage" role="menuitem" aria-label="usage" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY buxoPL -depth1"><span width="calc(100% - 38px)" title="usage" class="sc-eHoOIp ehBKwY">usage</span><svg class="sc-dYjPD kdgFPv" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul role="menu" class="sc-ilnrqe gTfiRs"><li tabindex="0" depth="2" data-item-id="tag/usage/operation/get_usage_log_v1_usage_log_get" role="menuitem" aria-label="Get Usage Log" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="get" class="sc-XpSrr jjsIAS operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Get Usage Log</span></label></li><li tabindex="0" depth="2" data-item-id="tag/usage/operation/get_usage_by_key_v1_usage_by_key_get" role="menuitem" aria-label="Get Usage By Key" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="get" class="sc-XpSrr jjsIAS operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Get Usage By Key</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/webhooks" role="menuitem" aria-label="webhooks" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY buxoPL -depth1"><span width="calc(100% - 38px)" title="webhooks" class="sc-eHoOIp ehBKwY">webhooks</span><svg class="sc-dYjPD kdgFPv" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul role="menu" class="sc-ilnrqe gTfiRs"><li tabindex="0" depth="2" data-item-id="tag/webhooks/operation/list_webhooks_v1_webhooks_get" role="menuitem" aria-label="List webhooks" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="get" class="sc-XpSrr jjsIAS operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">List webhooks</span></label></li><li tabindex="0" depth="2" data-item-id="tag/webhooks/operation/create_webhook_v1_webhooks_post" role="menuitem" aria-label="Create webhook" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="post" class="sc-XpSrr jjsIAS operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Create webhook</span></label></li><li tabindex="0" depth="2" data-item-id="tag/webhooks/operation/update_webhook_v1_webhooks__webhook_id__put" role="menuitem" aria-label="Update webhook" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="put" class="sc-XpSrr jjsIAS operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Update webhook</span></label></li><li tabindex="0" depth="2" data-item-id="tag/webhooks/operation/delete_webhook_v1_webhooks__webhook_id__delete" role="menuitem" aria-label="Delete webhook" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="delete" class="sc-XpSrr jjsIAS operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Delete webhook</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/email-alerts" role="menuitem" aria-label="email-alerts" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY buxoPL -depth1"><span width="calc(100% - 38px)" title="email-alerts" class="sc-eHoOIp ehBKwY">email-alerts</span><svg class="sc-dYjPD kdgFPv" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul role="menu" class="sc-ilnrqe gTfiRs"><li tabindex="0" depth="2" data-item-id="tag/email-alerts/operation/list_email_alerts_v1_email_alerts_get" role="menuitem" aria-label="List email alerts" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="get" class="sc-XpSrr jjsIAS operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">List email alerts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/email-alerts/operation/create_email_alert_v1_email_alerts_post" role="menuitem" aria-label="Create email alert" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="post" class="sc-XpSrr jjsIAS operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Create email alert</span></label></li><li tabindex="0" depth="2" data-item-id="tag/email-alerts/operation/update_email_alert_v1_email_alerts__alert_id__put" role="menuitem" aria-label="Update email alert" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="put" class="sc-XpSrr jjsIAS operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Update email alert</span></label></li><li tabindex="0" depth="2" data-item-id="tag/email-alerts/operation/delete_email_alert_v1_email_alerts__alert_id__delete" role="menuitem" aria-label="Delete email alert" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="delete" class="sc-XpSrr jjsIAS operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Delete email alert</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/version" role="menuitem" aria-label="version" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY buxoPL -depth1"><span width="calc(100% - 38px)" title="version" class="sc-eHoOIp ehBKwY">version</span><svg class="sc-dYjPD kdgFPv" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul role="menu" class="sc-ilnrqe gTfiRs"><li tabindex="0" depth="2" data-item-id="tag/version/operation/get_version_api_version_get" role="menuitem" aria-label="Get Version" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="get" class="sc-XpSrr jjsIAS operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Get Version</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/health" role="menuitem" aria-label="health" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY buxoPL -depth1"><span width="calc(100% - 38px)" title="health" class="sc-eHoOIp ehBKwY">health</span><svg class="sc-dYjPD kdgFPv" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul role="menu" class="sc-ilnrqe gTfiRs"><li tabindex="0" depth="2" data-item-id="tag/health/operation/health_check" role="menuitem" aria-label="Health Check" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="get" class="sc-XpSrr jjsIAS operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Health Check</span></label></li><li tabindex="0" depth="2" data-item-id="tag/health/operation/health_check_head" role="menuitem" aria-label="Health Check" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="head" class="sc-XpSrr jjsIAS operation-type head">head</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Health Check</span></label></li></ul></li></ul><div class="sc-hAkAFK gtBLyN"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-kTmAaw ddPveE"><div class="sc-iruNHB kjuNaM"><svg class="" style="transform:translate(2px, -4px) rotate(180deg);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
|
|
405
|
+
<div id="redoc"><div class="sc-dwkskT jetsmW redoc-wrap"><div class="sc-eVYbGh cczbHe menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-kijJqc uMSfb"><svg class="sc-iIvZUO kAmnlO search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input placeholder="Search..." aria-label="Search" type="text" class="sc-cLhBAz fTcICO search-input" value=""/></div><div class="sc-kLEbxe iOXjCz scrollbar-container undefined"><ul role="menu" class="sc-ilnrqe dqIuaF"><li tabindex="0" depth="1" data-item-id="tag/speech" role="menuitem" aria-label="speech" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY buxoPL -depth1"><span width="calc(100% - 38px)" title="speech" class="sc-eHoOIp ehBKwY">speech</span><svg class="sc-dYjPD kdgFPv" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul role="menu" class="sc-ilnrqe gTfiRs"><li tabindex="0" depth="2" data-item-id="tag/speech/operation/create_transcription_v1_audio_transcriptions_post" role="menuitem" aria-label="Transcribe audio to text" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="post" class="sc-XpSrr jjsIAS operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Transcribe audio to text</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/analysis" role="menuitem" aria-label="analysis" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY buxoPL -depth1"><span width="calc(100% - 38px)" title="analysis" class="sc-eHoOIp ehBKwY">analysis</span><svg class="sc-dYjPD kdgFPv" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul role="menu" class="sc-ilnrqe gTfiRs"><li tabindex="0" depth="2" data-item-id="tag/analysis/operation/create_diagnostic_v1_analyze_diagnostic_post" role="menuitem" aria-label="Analyze a call transcript — 5 parallel analyses" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="post" class="sc-XpSrr jjsIAS operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Analyze a call transcript — 5 parallel analyses</span></label></li><li tabindex="0" depth="2" data-item-id="tag/analysis/operation/create_risk_audit_v1_analyze_riskAudit_post" role="menuitem" aria-label="Compliance Risk Audit — conversation compliance analysis" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="post" class="sc-XpSrr jjsIAS operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Compliance Risk Audit — conversation compliance analysis</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/usage" role="menuitem" aria-label="usage" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY buxoPL -depth1"><span width="calc(100% - 38px)" title="usage" class="sc-eHoOIp ehBKwY">usage</span><svg class="sc-dYjPD kdgFPv" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul role="menu" class="sc-ilnrqe gTfiRs"><li tabindex="0" depth="2" data-item-id="tag/usage/operation/get_usage_log_v1_usage_log_get" role="menuitem" aria-label="Get Usage Log" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="get" class="sc-XpSrr jjsIAS operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Get Usage Log</span></label></li><li tabindex="0" depth="2" data-item-id="tag/usage/operation/get_usage_by_key_v1_usage_by_key_get" role="menuitem" aria-label="Get Usage By Key" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="get" class="sc-XpSrr jjsIAS operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Get Usage By Key</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/webhooks" role="menuitem" aria-label="webhooks" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY buxoPL -depth1"><span width="calc(100% - 38px)" title="webhooks" class="sc-eHoOIp ehBKwY">webhooks</span><svg class="sc-dYjPD kdgFPv" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul role="menu" class="sc-ilnrqe gTfiRs"><li tabindex="0" depth="2" data-item-id="tag/webhooks/operation/list_webhooks_v1_webhooks_get" role="menuitem" aria-label="List webhooks" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="get" class="sc-XpSrr jjsIAS operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">List webhooks</span></label></li><li tabindex="0" depth="2" data-item-id="tag/webhooks/operation/create_webhook_v1_webhooks_post" role="menuitem" aria-label="Create webhook" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="post" class="sc-XpSrr jjsIAS operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Create webhook</span></label></li><li tabindex="0" depth="2" data-item-id="tag/webhooks/operation/update_webhook_v1_webhooks__webhook_id__put" role="menuitem" aria-label="Update webhook" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="put" class="sc-XpSrr jjsIAS operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Update webhook</span></label></li><li tabindex="0" depth="2" data-item-id="tag/webhooks/operation/delete_webhook_v1_webhooks__webhook_id__delete" role="menuitem" aria-label="Delete webhook" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="delete" class="sc-XpSrr jjsIAS operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Delete webhook</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/email-alerts" role="menuitem" aria-label="email-alerts" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY buxoPL -depth1"><span width="calc(100% - 38px)" title="email-alerts" class="sc-eHoOIp ehBKwY">email-alerts</span><svg class="sc-dYjPD kdgFPv" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul role="menu" class="sc-ilnrqe gTfiRs"><li tabindex="0" depth="2" data-item-id="tag/email-alerts/operation/list_email_alerts_v1_email_alerts_get" role="menuitem" aria-label="List email alerts" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="get" class="sc-XpSrr jjsIAS operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">List email alerts</span></label></li><li tabindex="0" depth="2" data-item-id="tag/email-alerts/operation/create_email_alert_v1_email_alerts_post" role="menuitem" aria-label="Create email alert" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="post" class="sc-XpSrr jjsIAS operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Create email alert</span></label></li><li tabindex="0" depth="2" data-item-id="tag/email-alerts/operation/update_email_alert_v1_email_alerts__alert_id__put" role="menuitem" aria-label="Update email alert" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="put" class="sc-XpSrr jjsIAS operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Update email alert</span></label></li><li tabindex="0" depth="2" data-item-id="tag/email-alerts/operation/delete_email_alert_v1_email_alerts__alert_id__delete" role="menuitem" aria-label="Delete email alert" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="delete" class="sc-XpSrr jjsIAS operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Delete email alert</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/whatsapp" role="menuitem" aria-label="whatsapp" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY buxoPL -depth1"><span width="calc(100% - 38px)" title="whatsapp" class="sc-eHoOIp ehBKwY">whatsapp</span><svg class="sc-dYjPD kdgFPv" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul role="menu" class="sc-ilnrqe gTfiRs"><li tabindex="0" depth="2" data-item-id="tag/whatsapp/operation/extract_conversations_v1_whatsapp_extractConversations_post" role="menuitem" aria-label="Extract and segment WhatsApp conversations from an export" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="post" class="sc-XpSrr jjsIAS operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Extract and segment WhatsApp conversations from an export</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/version" role="menuitem" aria-label="version" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY buxoPL -depth1"><span width="calc(100% - 38px)" title="version" class="sc-eHoOIp ehBKwY">version</span><svg class="sc-dYjPD kdgFPv" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul role="menu" class="sc-ilnrqe gTfiRs"><li tabindex="0" depth="2" data-item-id="tag/version/operation/get_version_api_version_get" role="menuitem" aria-label="Get Version" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="get" class="sc-XpSrr jjsIAS operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Get Version</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/health" role="menuitem" aria-label="health" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY buxoPL -depth1"><span width="calc(100% - 38px)" title="health" class="sc-eHoOIp ehBKwY">health</span><svg class="sc-dYjPD kdgFPv" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul role="menu" class="sc-ilnrqe gTfiRs"><li tabindex="0" depth="2" data-item-id="tag/health/operation/health_check" role="menuitem" aria-label="Health Check" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="get" class="sc-XpSrr jjsIAS operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Health Check</span></label></li><li tabindex="0" depth="2" data-item-id="tag/health/operation/health_check_head" role="menuitem" aria-label="Health Check" aria-expanded="false" class="sc-uMZhz cQETmj"><label class="sc-bitxrY cGOuox -depth2"><span type="head" class="sc-XpSrr jjsIAS operation-type head">head</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eHoOIp ehBKwY">Health Check</span></label></li></ul></li></ul><div class="sc-hAkAFK gtBLyN"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-kTmAaw ddPveE"><div class="sc-iruNHB kjuNaM"><svg class="" style="transform:translate(2px, -4px) rotate(180deg);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
|
|
409
406
|
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
|
|
410
407
|
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
|
|
411
408
|
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
|
|
@@ -423,7 +420,7 @@ data-styled.g139[id="sc-iIvZUO"]{content:"kAmnlO,"}/*!sc*/
|
|
|
423
420
|
55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
|
|
424
421
|
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
|
|
425
422
|
-104.0616 -231.873,-231.248 z
|
|
426
|
-
" fill="currentColor"></path></g></svg></div></div><div class="sc-jtyQFi ldXCvc api-content"><div class="sc-eCQgVK jleRXN"><div class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN api-info"><h1 class="sc-fuztkK sc-ctiVdb eRMVDe cBgvIi">FalaAI API<!-- --> <span>(<!-- -->1.21.
|
|
423
|
+
" fill="currentColor"></path></g></svg></div></div><div class="sc-jtyQFi ldXCvc api-content"><div class="sc-eCQgVK jleRXN"><div class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN api-info"><h1 class="sc-fuztkK sc-ctiVdb eRMVDe cBgvIi">FalaAI API<!-- --> <span>(<!-- -->1.21.51<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-iJSMbW sc-cBEgGa fiNpIH htbHfQ"></div><div data-role="redoc-summary" html="" class="sc-iJSMbW sc-cBEgGa fiNpIH htbHfQ"></div><div data-role="redoc-description" html="" class="sc-iJSMbW sc-cBEgGa fiNpIH htbHfQ"></div></div></div></div><div id="tag/speech" data-section-id="tag/speech" class="sc-eCQgVK jleRXN"><div class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/speech" aria-label="tag/speech"></a>speech</h2></div></div></div><div id="tag/speech/operation/create_transcription_v1_audio_transcriptions_post" data-section-id="tag/speech/operation/create_transcription_v1_audio_transcriptions_post" class="sc-eCQgVK grDwca"><div data-section-id="operation/create_transcription_v1_audio_transcriptions_post" id="operation/create_transcription_v1_audio_transcriptions_post" class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/speech/operation/create_transcription_v1_audio_transcriptions_post" aria-label="tag/speech/operation/create_transcription_v1_audio_transcriptions_post"></a>Transcribe audio to text<!-- --> </h2><div class="sc-fuYIqi kGZLat"><div class="sc-dalEhJ jdqJPb"><h5 class="sc-iqkkDd sc-jQQpTv jprlAr kEkHzF">Authorizations:</h5><svg class="sc-dYjPD bEEWJa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jTPGds cVAkzL"><span class="sc-dtnsVa hFacFb"><span class="sc-hPfayn hAYuWG"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqkkDd jprlAr">Request Body schema: <span class="sc-gXvOjn kxMqOs">multipart/form-data</span><div class="sc-gSILEF sc-eIYgEQ sc-dTCDEk jMRTsl dHYagA bxWqzP">required</div></h5><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH htbHfQ"></div><table class="sc-hHopjF bsjUmE"><tbody><tr class=""><td kind="field" title="file" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">file</span><div class="sc-gSILEF sc-eIYgEQ jMRTsl dHYagA">required</div></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->File<!-- -->) </span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr><tr class=""><td kind="field" title="model" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">model</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Model<!-- -->) </span></div><div><span class="sc-gSILEF jMRTsl"> <!-- -->Default:<!-- --> </span> <span class="sc-gSILEF sc-lbFCLI jMRTsl OXDYs">"falaai-transcribe-1"</span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr><tr class=""><td kind="field" title="language" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">language</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Language<!-- -->) </span></div><div><span class="sc-gSILEF jMRTsl"> <!-- -->Default:<!-- --> </span> <span class="sc-gSILEF sc-lbFCLI jMRTsl OXDYs">"pt"</span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr><tr class="last "><td kind="field" title="client_reference_id" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">client_reference_id</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Client Reference Id<!-- -->) </span></div> <div><div html="<p>Optional client-supplied ID echoed verbatim in the response. Use to correlate/sync with your system. Accepted charset: [A-Za-z0-9._:-]. Not idempotency.</p>
|
|
427
424
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>Optional client-supplied ID echoed verbatim in the response. Use to correlate/sync with your system. Accepted charset: [A-Za-z0-9._:-]. Not idempotency.</p>
|
|
428
425
|
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fINhYD hgNHCh">Responses</h3><div><button class="sc-cbuLjy iSTZHA"><svg class="sc-dYjPD gngmNp" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fXmTIC cqDULz">200<!-- --> </strong><div html="<p>Successful Response</p>
|
|
429
426
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Successful Response</p>
|
|
@@ -431,7 +428,7 @@ data-styled.g139[id="sc-iIvZUO"]{content:"kAmnlO,"}/*!sc*/
|
|
|
431
428
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Validation Error</p>
|
|
432
429
|
</div></button></div></div></div><div class="sc-jSppWd sc-gKkgUA fpMlmc bdQQyo"><div class="sc-fXwuWv fYxpnv"><button class="sc-jWMFtl jzaJhV"><span type="post" class="sc-eEFuoE hOENFc http-verb post">post</span><span class="sc-FpjRO dsIRaZ">/v1/audio/transcriptions</span><svg class="sc-dYjPD bQKUih" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-fmtEmb tUxhh"><div class="sc-ljIcGq bAnPPh"><div html="<p>FalaAI API - producao</p>
|
|
433
430
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>FalaAI API - producao</p>
|
|
434
|
-
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/audio/transcriptions</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="
|
|
431
|
+
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/audio/transcriptions</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab_R_ijgq_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_ijgq_0" tabindex="0" data-rttab="true">Transcrever audio (SDK)</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_ijgq_0" aria-labelledby="tab_R_ijgq_0"><div class="sc-ezjgic hsxFzL"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button></div><pre class="sc-iJSMbW sc-bYgEKt fiNpIH kBZzKJ"><span class="token comment"># frozen_string_literal: true</span>
|
|
435
432
|
<span class="token keyword">require</span> <span class="token string-literal"><span class="token string">'falaai-api'</span></span>
|
|
436
433
|
|
|
437
434
|
config <span class="token operator">=</span> FalaAI<span class="token double-colon punctuation">::</span><span class="token class-name">Configuration</span><span class="token punctuation">.</span><span class="token keyword">new</span>
|
|
@@ -450,7 +447,7 @@ transcription<span class="token punctuation">,</span> _status <span class="token
|
|
|
450
447
|
<span class="token symbol">language</span><span class="token operator">:</span> <span class="token string-literal"><span class="token string">"pt"</span></span><span class="token punctuation">,</span>
|
|
451
448
|
<span class="token symbol">client_reference_id</span><span class="token operator">:</span> <span class="token string-literal"><span class="token string">"call_202609271408"</span></span>
|
|
452
449
|
<span class="token punctuation">)</span>
|
|
453
|
-
puts <span class="token constant">JSON</span><span class="token punctuation">.</span>pretty_generate<span class="token punctuation">(</span>transcription<span class="token punctuation">.</span>to_hash<span class="token punctuation">)</span></pre></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_9poq_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_9poq_0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab_R_9poq_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_9poq_1" data-rttab="true">422</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_9poq_0" aria-labelledby="tab_R_9poq_0"><div><div class="sc-cNSlRw bMFMGt"><span class="sc-bBzIOb BuCyN">Content type</span><div class="sc-dPqFhK kgKexQ">application/json</div></div><div class="sc-hUheUT jUCYlq"><div class="sc-cTZdpT hHzuQA"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-iJSMbW fiNpIH sc-jNDflC jgTAJz"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filename"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"processed_at"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"audio_seconds"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"credits_consumed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"processing_ms"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"language"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"language_confidence"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"duration_seconds"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"text"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dialog"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"audio_events"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"event"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start_s"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"end_s"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"duration_s"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"formatted_timestamp"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"event_types"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"word_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"input"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"duration_s"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"original_format"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"codec"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sample_rate"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channels"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"client_reference_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel_R_9poq_1" aria-labelledby="tab_R_9poq_1"></div></div></div></div></div></div><div id="tag/analysis" data-section-id="tag/analysis" class="sc-eCQgVK jleRXN"><div class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/analysis" aria-label="tag/analysis"></a>analysis</h2></div></div></div><div id="tag/analysis/operation/create_diagnostic_v1_analyze_diagnostic_post" data-section-id="tag/analysis/operation/create_diagnostic_v1_analyze_diagnostic_post" class="sc-eCQgVK grDwca"><div data-section-id="operation/create_diagnostic_v1_analyze_diagnostic_post" id="operation/create_diagnostic_v1_analyze_diagnostic_post" class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/analysis/operation/create_diagnostic_v1_analyze_diagnostic_post" aria-label="tag/analysis/operation/create_diagnostic_v1_analyze_diagnostic_post"></a>Analyze a call transcript — 5 parallel analyses<!-- --> </h2><div class="sc-fuYIqi kGZLat"><div class="sc-dalEhJ jdqJPb"><h5 class="sc-iqkkDd sc-jQQpTv jprlAr kEkHzF">Authorizations:</h5><svg class="sc-dYjPD bEEWJa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jTPGds cVAkzL"><span class="sc-dtnsVa hFacFb"><span class="sc-hPfayn hAYuWG"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqkkDd jprlAr">Request Body schema: <span class="sc-gXvOjn kxMqOs">application/json</span><div class="sc-gSILEF sc-eIYgEQ sc-dTCDEk jMRTsl dHYagA bxWqzP">required</div></h5><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH htbHfQ"></div><table class="sc-hHopjF bsjUmE"><tbody><tr class=""><td kind="field" title="model" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">model</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Model<!-- -->) </span></div><div><span class="sc-gSILEF jMRTsl"> <!-- -->Default:<!-- --> </span> <span class="sc-gSILEF sc-lbFCLI jMRTsl OXDYs">"falaai-diagnostic-1"</span></div> <div><div html="<p>Analysis model. Always &#39;falaai-diagnostic-1&#39;</p>
|
|
450
|
+
puts <span class="token constant">JSON</span><span class="token punctuation">.</span>pretty_generate<span class="token punctuation">(</span>transcription<span class="token punctuation">.</span>to_hash<span class="token punctuation">)</span></pre></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_jjgq_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_jjgq_0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab_R_jjgq_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_jjgq_1" data-rttab="true">422</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_jjgq_0" aria-labelledby="tab_R_jjgq_0"><div><div class="sc-cNSlRw bMFMGt"><span class="sc-bBzIOb BuCyN">Content type</span><div class="sc-dPqFhK kgKexQ">application/json</div></div><div class="sc-hUheUT jUCYlq"><div class="sc-cTZdpT hHzuQA"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-iJSMbW fiNpIH sc-jNDflC jgTAJz"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"model"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"filename"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"processed_at"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"audio_seconds"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"credits_consumed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"processing_ms"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"language"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"language_confidence"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"duration_seconds"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"text"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"dialog"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"audio_events"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"event"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start_s"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"end_s"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"duration_s"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"formatted_timestamp"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"event_types"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"word_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"input"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"duration_s"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"original_format"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"codec"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sample_rate"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"channels"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"client_reference_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel_R_jjgq_1" aria-labelledby="tab_R_jjgq_1"></div></div></div></div></div></div><div id="tag/analysis" data-section-id="tag/analysis" class="sc-eCQgVK jleRXN"><div class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/analysis" aria-label="tag/analysis"></a>analysis</h2></div></div></div><div id="tag/analysis/operation/create_diagnostic_v1_analyze_diagnostic_post" data-section-id="tag/analysis/operation/create_diagnostic_v1_analyze_diagnostic_post" class="sc-eCQgVK grDwca"><div data-section-id="operation/create_diagnostic_v1_analyze_diagnostic_post" id="operation/create_diagnostic_v1_analyze_diagnostic_post" class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/analysis/operation/create_diagnostic_v1_analyze_diagnostic_post" aria-label="tag/analysis/operation/create_diagnostic_v1_analyze_diagnostic_post"></a>Analyze a call transcript — 5 parallel analyses<!-- --> </h2><div class="sc-fuYIqi kGZLat"><div class="sc-dalEhJ jdqJPb"><h5 class="sc-iqkkDd sc-jQQpTv jprlAr kEkHzF">Authorizations:</h5><svg class="sc-dYjPD bEEWJa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jTPGds cVAkzL"><span class="sc-dtnsVa hFacFb"><span class="sc-hPfayn hAYuWG"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqkkDd jprlAr">Request Body schema: <span class="sc-gXvOjn kxMqOs">application/json</span><div class="sc-gSILEF sc-eIYgEQ sc-dTCDEk jMRTsl dHYagA bxWqzP">required</div></h5><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH htbHfQ"></div><table class="sc-hHopjF bsjUmE"><tbody><tr class=""><td kind="field" title="model" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">model</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Model<!-- -->) </span></div><div><span class="sc-gSILEF jMRTsl"> <!-- -->Default:<!-- --> </span> <span class="sc-gSILEF sc-lbFCLI jMRTsl OXDYs">"falaai-diagnostic-1"</span></div> <div><div html="<p>Analysis model. Always &#39;falaai-diagnostic-1&#39;</p>
|
|
454
451
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>Analysis model. Always 'falaai-diagnostic-1'</p>
|
|
455
452
|
</div></div></div></td></tr><tr class=""><td kind="field" title="text" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">text</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Text<!-- -->) </span><span> <span class="sc-gSILEF sc-cljLBy jMRTsl enoyBT"> <!-- --><= 300000 characters<!-- --> </span></span></div><div><span class="sc-gSILEF jMRTsl"> <!-- -->Default:<!-- --> </span> <span class="sc-gSILEF sc-lbFCLI jMRTsl OXDYs">""</span></div> <div><div html="<p>Plain transcript (fallback if dialog is empty). At least one of &#39;dialog&#39; or &#39;text&#39; required. Max 300,000 characters</p>
|
|
456
453
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>Plain transcript (fallback if dialog is empty). At least one of 'dialog' or 'text' required. Max 300,000 characters</p>
|
|
@@ -476,7 +473,7 @@ puts <span class="token constant">JSON</span><span class="token punctuation">.</
|
|
|
476
473
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Validation Error</p>
|
|
477
474
|
</div></button></div></div></div><div class="sc-jSppWd sc-gKkgUA fpMlmc bdQQyo"><div class="sc-fXwuWv fYxpnv"><button class="sc-jWMFtl jzaJhV"><span type="post" class="sc-eEFuoE hOENFc http-verb post">post</span><span class="sc-FpjRO dsIRaZ">/v1/analyze/diagnostic</span><svg class="sc-dYjPD bQKUih" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-fmtEmb tUxhh"><div class="sc-ljIcGq bAnPPh"><div html="<p>FalaAI API - producao</p>
|
|
478
475
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>FalaAI API - producao</p>
|
|
479
|
-
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/analyze/diagnostic</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="
|
|
476
|
+
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/analyze/diagnostic</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab_R_155ha_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_155ha_0" tabindex="0" data-rttab="true">Diagnostico da conversa (SDK)</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_155ha_0" aria-labelledby="tab_R_155ha_0"><div class="sc-ezjgic hsxFzL"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button></div><pre class="sc-iJSMbW sc-bYgEKt fiNpIH kBZzKJ"><span class="token comment"># frozen_string_literal: true</span>
|
|
480
477
|
<span class="token keyword">require</span> <span class="token string-literal"><span class="token string">'falaai-api'</span></span>
|
|
481
478
|
|
|
482
479
|
config <span class="token operator">=</span> FalaAI<span class="token double-colon punctuation">::</span><span class="token class-name">Configuration</span><span class="token punctuation">.</span><span class="token keyword">new</span>
|
|
@@ -530,7 +527,7 @@ diagnostic<span class="token punctuation">,</span> _status <span class="token op
|
|
|
530
527
|
<span class="token symbol">client_reference_id</span><span class="token operator">:</span> <span class="token string-literal"><span class="token string">"call-202609271311"</span></span>
|
|
531
528
|
<span class="token punctuation">)</span>
|
|
532
529
|
<span class="token punctuation">)</span>
|
|
533
|
-
puts <span class="token constant">JSON</span><span class="token punctuation">.</span>pretty_generate<span class="token punctuation">(</span>diagnostic<span class="token punctuation">.</span>to_hash<span class="token punctuation">)</span></pre></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="
|
|
530
|
+
puts <span class="token constant">JSON</span><span class="token punctuation">.</span>pretty_generate<span class="token punctuation">(</span>diagnostic<span class="token punctuation">.</span>to_hash<span class="token punctuation">)</span></pre></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_175ha_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_175ha_0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab_R_175ha_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_175ha_1" data-rttab="true">422</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_175ha_0" aria-labelledby="tab_R_175ha_0"><div><div class="sc-cNSlRw bMFMGt"><span class="sc-bBzIOb BuCyN">Content type</span><div class="sc-dPqFhK kgKexQ">application/json</div></div><div class="sc-hUheUT jUCYlq"><div class="sc-cTZdpT hHzuQA"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-iJSMbW fiNpIH sc-jNDflC jgTAJz"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"response_language"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"analysis"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"dialogue_summary"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"explanation"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"contact_reason"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"explanation"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"identified_action"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"list_choice"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"justification"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"evidence_phrases"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"identified_label"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"list_choice"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"justification"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"evidence_phrases"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sentiment"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"list_choice"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"justification"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"evidence_phrases"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"participants_identified"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"characters"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"credits_consumed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"processing_ms"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"client_reference_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel_R_175ha_1" aria-labelledby="tab_R_175ha_1"></div></div></div></div></div></div><div id="tag/analysis/operation/create_risk_audit_v1_analyze_riskAudit_post" data-section-id="tag/analysis/operation/create_risk_audit_v1_analyze_riskAudit_post" class="sc-eCQgVK grDwca"><div data-section-id="operation/create_risk_audit_v1_analyze_riskAudit_post" id="operation/create_risk_audit_v1_analyze_riskAudit_post" class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/analysis/operation/create_risk_audit_v1_analyze_riskAudit_post" aria-label="tag/analysis/operation/create_risk_audit_v1_analyze_riskAudit_post"></a>Compliance Risk Audit — conversation compliance analysis<!-- --> </h2><div class="sc-fuYIqi kGZLat"><div class="sc-dalEhJ jdqJPb"><h5 class="sc-iqkkDd sc-jQQpTv jprlAr kEkHzF">Authorizations:</h5><svg class="sc-dYjPD bEEWJa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jTPGds cVAkzL"><span class="sc-dtnsVa hFacFb"><span class="sc-hPfayn hAYuWG"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqkkDd jprlAr">Request Body schema: <span class="sc-gXvOjn kxMqOs">application/json</span><div class="sc-gSILEF sc-eIYgEQ sc-dTCDEk jMRTsl dHYagA bxWqzP">required</div></h5><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH htbHfQ"></div><table class="sc-hHopjF bsjUmE"><tbody><tr class=""><td kind="field" title="model" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">model</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Model<!-- -->) </span></div><div><span class="sc-gSILEF jMRTsl"> <!-- -->Default:<!-- --> </span> <span class="sc-gSILEF sc-lbFCLI jMRTsl OXDYs">"falaai-risk-audit-1"</span></div> <div><div html="<p>Analysis model. Always &#39;falaai-risk-audit-1&#39;</p>
|
|
534
531
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>Analysis model. Always 'falaai-risk-audit-1'</p>
|
|
535
532
|
</div></div></div></td></tr><tr class=""><td kind="field" title="text" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">text</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Text<!-- -->) </span><span> <span class="sc-gSILEF sc-cljLBy jMRTsl enoyBT"> <!-- --><= 300000 characters<!-- --> </span></span></div><div><span class="sc-gSILEF jMRTsl"> <!-- -->Default:<!-- --> </span> <span class="sc-gSILEF sc-lbFCLI jMRTsl OXDYs">""</span></div> <div><div html="<p>Plain transcript (fallback if dialog is empty). At least one of &#39;dialog&#39; or &#39;text&#39; required. Max 300,000 characters</p>
|
|
536
533
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>Plain transcript (fallback if dialog is empty). At least one of 'dialog' or 'text' required. Max 300,000 characters</p>
|
|
@@ -548,8 +545,8 @@ puts <span class="token constant">JSON</span><span class="token punctuation">.</
|
|
|
548
545
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>Who originated the call. inbound=client called, outbound=company called. If omitted, LLM infers from context.</p>
|
|
549
546
|
</div></div></div></td></tr><tr class=""><td class="sc-hCcPtG sc-fFCZOx sc-jgzHYo jFNAwF lcdEEX QbYuY" kind="field" title="participants"><span class="sc-ieCSdj kkMuqc"></span><button aria-label="expand participants"><span class="property-name">participants</span><svg class="sc-dYjPD kecbEr" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">Array of Participants (objects) or Participants (null)</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Participants<!-- -->) </span></div> <div><div html="<p>Explicit participant roles. If omitted, LLM infers from dialog (Lei 17). When provided, used as ground truth — no inference.</p>
|
|
550
547
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>Explicit participant roles. If omitted, LLM infers from dialog (Lei 17). When provided, used as ground truth — no inference.</p>
|
|
551
|
-
</div></div></div></td></tr><tr class=""><td kind="field" title="response_format" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">response_format</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Response Format<!-- -->) </span><span class="sc-gSILEF sc-
|
|
552
|
-
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>Response format version.
|
|
548
|
+
</div></div></div></td></tr><tr class=""><td kind="field" title="response_format" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">response_format</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Response Format<!-- -->) </span></div><div><span class="sc-gSILEF jMRTsl"> <!-- -->Default:<!-- --> </span> <span class="sc-gSILEF sc-lbFCLI jMRTsl OXDYs">"v2"</span></div><div><span class="sc-gSILEF jMRTsl"> <!-- -->Value<!-- -->:</span> <span class="sc-gSILEF sc-lbFCLI jMRTsl OXDYs">"v2"</span> </div> <div><div html="<p>Response format version. Only &#39;v2&#39; (structured EN-US blocks) is available today.</p>
|
|
549
|
+
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>Response format version. Only 'v2' (structured EN-US blocks) is available today.</p>
|
|
553
550
|
</div></div></div></td></tr><tr class="last "><td class="sc-hCcPtG sc-fFCZOx sc-jgzHYo jFNAwF lcdEEX QbYuY" kind="field" title="client_reference_id"><span class="sc-ieCSdj kkMuqc"></span><button aria-label="expand client_reference_id"><span class="property-name">client_reference_id</span><svg class="sc-dYjPD kecbEr" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">Client Reference Id (string) or Client Reference Id (null)</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Client Reference Id<!-- -->) </span></div> <div><div html="<p>Optional client-supplied ID echoed verbatim in the response. Use to correlate/sync with your system. Accepted charset: [A-Za-z0-9._:-], max 128 chars. Not idempotency.</p>
|
|
554
551
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>Optional client-supplied ID echoed verbatim in the response. Use to correlate/sync with your system. Accepted charset: [A-Za-z0-9._:-], max 128 chars. Not idempotency.</p>
|
|
555
552
|
</div></div></div></td></tr></tbody></table><div><h3 class="sc-fINhYD hgNHCh">Responses</h3><div><button class="sc-cbuLjy iSTZHA"><svg class="sc-dYjPD gngmNp" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fXmTIC cqDULz">200<!-- --> </strong><div html="<p>Successful Response</p>
|
|
@@ -558,7 +555,7 @@ puts <span class="token constant">JSON</span><span class="token punctuation">.</
|
|
|
558
555
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Validation Error</p>
|
|
559
556
|
</div></button></div></div></div><div class="sc-jSppWd sc-gKkgUA fpMlmc bdQQyo"><div class="sc-fXwuWv fYxpnv"><button class="sc-jWMFtl jzaJhV"><span type="post" class="sc-eEFuoE hOENFc http-verb post">post</span><span class="sc-FpjRO dsIRaZ">/v1/analyze/riskAudit</span><svg class="sc-dYjPD bQKUih" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-fmtEmb tUxhh"><div class="sc-ljIcGq bAnPPh"><div html="<p>FalaAI API - producao</p>
|
|
560
557
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>FalaAI API - producao</p>
|
|
561
|
-
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/analyze/riskAudit</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="
|
|
558
|
+
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/analyze/riskAudit</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab_R_156ha_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_156ha_0" tabindex="0" data-rttab="true">Risk Audit (SDK)</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_156ha_0" aria-labelledby="tab_R_156ha_0"><div class="sc-ezjgic hsxFzL"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button></div><pre class="sc-iJSMbW sc-bYgEKt fiNpIH kBZzKJ"><span class="token comment"># frozen_string_literal: true</span>
|
|
562
559
|
<span class="token keyword">require</span> <span class="token string-literal"><span class="token string">'falaai-api'</span></span>
|
|
563
560
|
|
|
564
561
|
config <span class="token operator">=</span> FalaAI<span class="token double-colon punctuation">::</span><span class="token class-name">Configuration</span><span class="token punctuation">.</span><span class="token keyword">new</span>
|
|
@@ -613,19 +610,19 @@ audit<span class="token punctuation">,</span> _status <span class="token operato
|
|
|
613
610
|
<span class="token symbol">client_reference_id</span><span class="token operator">:</span> <span class="token string-literal"><span class="token string">"call-202609271311"</span></span>
|
|
614
611
|
<span class="token punctuation">)</span>
|
|
615
612
|
<span class="token punctuation">)</span>
|
|
616
|
-
puts <span class="token constant">JSON</span><span class="token punctuation">.</span>pretty_generate<span class="token punctuation">(</span>audit<span class="token punctuation">.</span>to_hash<span class="token punctuation">)</span></pre></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_jj9a_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_jj9a_0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab_R_jj9a_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_jj9a_1" data-rttab="true">422</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_jj9a_0" aria-labelledby="tab_R_jj9a_0"><div><div class="sc-cNSlRw bMFMGt"><span class="sc-bBzIOb BuCyN">Content type</span><div class="sc-dPqFhK kgKexQ">application/json</div></div><div class="sc-hUheUT jUCYlq"><div class="sc-cTZdpT hHzuQA"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-iJSMbW fiNpIH sc-jNDflC jgTAJz"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"response"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"meta"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"risk_audit"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"call_duration_s"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"analyzed_at"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"usage"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"characters"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"credits_consumed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"processing_ms"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"client_reference_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"participants"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"identified"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"call_direction"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role_inference_reliable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"identification_status"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"unidentified_items_count"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"verdict"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"label"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"level_code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"color"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"icon"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"risk_matrix"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"applied_actions"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"decision_details"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scores"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"conversation"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"consolidated_score"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"violation_density_per_min"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sentiment_trend"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pct_turns_with_violation"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"most_critical_turn"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"positive_negative_ratio"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"global_risk_severity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"global_risk_severity_label"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"global_risk_severity_color"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"risk_likelihood_avg"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"risk_impact_avg"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"per_participant"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"detections"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"violations"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"positives"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"client_risk_alerts"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"client_behavior_alerts"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"client_negatives"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"analysis"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"global_metrics"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"final_analysis"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"frameworks"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"timeline"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"turns_sentiment"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio_events"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio_groups_found"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio_event_model"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"windows_s"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"categories_summary"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"indexer"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"suggested_terms_for_bank"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"summary"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total_turns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_calibrated"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"active"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tolerated"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"blocked"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio_events_used"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio_events_aggravated"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mac_audio_applied"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mvad_applied"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_participants"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_agents"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_clients"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_bots"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_unknown"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"client_risk_alerts_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"client_behavior_alerts_count"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"actions_i18n"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audit_decisions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"risk_origin"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_zero_tolerance_violation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deterministic_validator_changes"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scoring_explanation"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"summary"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"steps"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"html_report"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel_R_jj9a_1" aria-labelledby="tab_R_jj9a_1"></div></div></div></div></div></div><div id="tag/usage" data-section-id="tag/usage" class="sc-eCQgVK jleRXN"><div class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/usage" aria-label="tag/usage"></a>usage</h2></div></div></div><div id="tag/usage/operation/get_usage_log_v1_usage_log_get" data-section-id="tag/usage/operation/get_usage_log_v1_usage_log_get" class="sc-eCQgVK grDwca"><div data-section-id="operation/get_usage_log_v1_usage_log_get" id="operation/get_usage_log_v1_usage_log_get" class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/usage/operation/get_usage_log_v1_usage_log_get" aria-label="tag/usage/operation/get_usage_log_v1_usage_log_get"></a>Get Usage Log<!-- --> </h2><div class="sc-fuYIqi kGZLat"><div class="sc-dalEhJ jdqJPb"><h5 class="sc-iqkkDd sc-jQQpTv jprlAr kEkHzF">Authorizations:</h5><svg class="sc-dYjPD bEEWJa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jTPGds cVAkzL"><span class="sc-dtnsVa hFacFb"><span class="sc-hPfayn hAYuWG"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqkkDd jprlAr">query<!-- --> Parameters</h5><table class="sc-hHopjF bsjUmE"><tbody><tr class=""><td kind="field" title="page" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">page</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">integer</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Page<!-- -->) </span><span> <span class="sc-gSILEF sc-cljLBy jMRTsl enoyBT"> <!-- -->>= 1<!-- --> </span></span></div><div><span class="sc-gSILEF jMRTsl"> <!-- -->Default:<!-- --> </span> <span class="sc-gSILEF sc-lbFCLI jMRTsl OXDYs">1</span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">limit</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">integer</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Limit<!-- -->) </span><span> <span class="sc-gSILEF sc-cljLBy jMRTsl enoyBT"> <!-- -->[ 1 .. 100 ]<!-- --> </span></span></div><div><span class="sc-gSILEF jMRTsl"> <!-- -->Default:<!-- --> </span> <span class="sc-gSILEF sc-lbFCLI jMRTsl OXDYs">20</span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr><tr class="last "><td class="sc-hCcPtG sc-fFCZOx sc-jgzHYo jFNAwF lcdEEX QbYuY" kind="field" title="api_key_id"><span class="sc-ieCSdj kkMuqc"></span><button aria-label="expand api_key_id"><span class="property-name">api_key_id</span><svg class="sc-dYjPD kecbEr" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">Api Key Id (string) or Api Key Id (null)</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Api Key Id<!-- -->) </span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fINhYD hgNHCh">Responses</h3><div><button class="sc-cbuLjy iSTZHA"><svg class="sc-dYjPD gngmNp" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fXmTIC cqDULz">200<!-- --> </strong><div html="<p>Successful Response</p>
|
|
613
|
+
puts <span class="token constant">JSON</span><span class="token punctuation">.</span>pretty_generate<span class="token punctuation">(</span>audit<span class="token punctuation">.</span>to_hash<span class="token punctuation">)</span></pre></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_176ha_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_176ha_0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab_R_176ha_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_176ha_1" data-rttab="true">422</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_176ha_0" aria-labelledby="tab_R_176ha_0"><div><div class="sc-cNSlRw bMFMGt"><span class="sc-bBzIOb BuCyN">Content type</span><div class="sc-dPqFhK kgKexQ">application/json</div></div><div class="sc-hUheUT jUCYlq"><div class="sc-cTZdpT hHzuQA"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-iJSMbW fiNpIH sc-jNDflC jgTAJz"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"response"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"meta"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object"</span>: <span class="token string">"risk_audit"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"call_duration_s"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"analyzed_at"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"usage"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"characters"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"credits_consumed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"processing_ms"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"client_reference_id"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"participants"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"identified"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"call_direction"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role_inference_reliable"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"identification_status"</span>: <span class="token string">"none"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"unidentified_items_count"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"verdict"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"label"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"level_code"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"color"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"icon"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"risk_matrix"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"applied_actions"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"decision_details"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scores"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"conversation"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"consolidated_score"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"violation_density_per_min"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"sentiment_trend"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"pct_turns_with_violation"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"most_critical_turn"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"positive_negative_ratio"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"global_risk_severity"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"global_risk_severity_label"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"global_risk_severity_color"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"risk_likelihood_avg"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"risk_impact_avg"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"per_participant"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"detections"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"violations"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"positives"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"client_risk_alerts"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"client_behavior_alerts"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"client_negatives"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"analysis"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"global_metrics"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"final_analysis"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"frameworks"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"timeline"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"turns_sentiment"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio_events"</span>: <span class="token punctuation">[ ]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio_groups_found"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio_event_model"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"model"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">""</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"windows_s"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"categories_summary"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"indexer"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"suggested_terms_for_bank"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"summary"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"total_turns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_calibrated"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"active"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"tolerated"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"blocked"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio_events_used"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audio_events_aggravated"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mac_audio_applied"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"mvad_applied"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_participants"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_agents"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_clients"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_bots"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_unknown"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"client_risk_alerts_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"client_behavior_alerts_count"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"actions_i18n"</span>: <span class="token punctuation">{ }</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"audit_decisions"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"risk_origin"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"has_zero_tolerance_violation"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"deterministic_validator_changes"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"scoring_explanation"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"summary"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"steps"</span>: <span class="token punctuation">[ ]</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"html_report"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel_R_176ha_1" aria-labelledby="tab_R_176ha_1"></div></div></div></div></div></div><div id="tag/usage" data-section-id="tag/usage" class="sc-eCQgVK jleRXN"><div class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/usage" aria-label="tag/usage"></a>usage</h2></div></div></div><div id="tag/usage/operation/get_usage_log_v1_usage_log_get" data-section-id="tag/usage/operation/get_usage_log_v1_usage_log_get" class="sc-eCQgVK grDwca"><div data-section-id="operation/get_usage_log_v1_usage_log_get" id="operation/get_usage_log_v1_usage_log_get" class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/usage/operation/get_usage_log_v1_usage_log_get" aria-label="tag/usage/operation/get_usage_log_v1_usage_log_get"></a>Get Usage Log<!-- --> </h2><div class="sc-fuYIqi kGZLat"><div class="sc-dalEhJ jdqJPb"><h5 class="sc-iqkkDd sc-jQQpTv jprlAr kEkHzF">Authorizations:</h5><svg class="sc-dYjPD bEEWJa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jTPGds cVAkzL"><span class="sc-dtnsVa hFacFb"><span class="sc-hPfayn hAYuWG"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqkkDd jprlAr">query<!-- --> Parameters</h5><table class="sc-hHopjF bsjUmE"><tbody><tr class=""><td kind="field" title="page" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">page</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">integer</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Page<!-- -->) </span><span> <span class="sc-gSILEF sc-cljLBy jMRTsl enoyBT"> <!-- -->>= 1<!-- --> </span></span></div><div><span class="sc-gSILEF jMRTsl"> <!-- -->Default:<!-- --> </span> <span class="sc-gSILEF sc-lbFCLI jMRTsl OXDYs">1</span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr><tr class=""><td kind="field" title="limit" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">limit</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">integer</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Limit<!-- -->) </span><span> <span class="sc-gSILEF sc-cljLBy jMRTsl enoyBT"> <!-- -->[ 1 .. 100 ]<!-- --> </span></span></div><div><span class="sc-gSILEF jMRTsl"> <!-- -->Default:<!-- --> </span> <span class="sc-gSILEF sc-lbFCLI jMRTsl OXDYs">20</span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr><tr class="last "><td class="sc-hCcPtG sc-fFCZOx sc-jgzHYo jFNAwF lcdEEX QbYuY" kind="field" title="api_key_id"><span class="sc-ieCSdj kkMuqc"></span><button aria-label="expand api_key_id"><span class="property-name">api_key_id</span><svg class="sc-dYjPD kecbEr" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">Api Key Id (string) or Api Key Id (null)</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Api Key Id<!-- -->) </span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fINhYD hgNHCh">Responses</h3><div><button class="sc-cbuLjy iSTZHA"><svg class="sc-dYjPD gngmNp" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fXmTIC cqDULz">200<!-- --> </strong><div html="<p>Successful Response</p>
|
|
617
614
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Successful Response</p>
|
|
618
615
|
</div></button></div><div><button class="sc-cbuLjy cKkXxa"><svg class="sc-dYjPD hJoFRR" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fXmTIC cqDULz">422<!-- --> </strong><div html="<p>Validation Error</p>
|
|
619
616
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Validation Error</p>
|
|
620
617
|
</div></button></div></div></div><div class="sc-jSppWd sc-gKkgUA fpMlmc bdQQyo"><div class="sc-fXwuWv fYxpnv"><button class="sc-jWMFtl jzaJhV"><span type="get" class="sc-eEFuoE hlSrtW http-verb get">get</span><span class="sc-FpjRO dsIRaZ">/v1/usage/log</span><svg class="sc-dYjPD bQKUih" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-fmtEmb tUxhh"><div class="sc-ljIcGq bAnPPh"><div html="<p>FalaAI API - producao</p>
|
|
621
618
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>FalaAI API - producao</p>
|
|
622
|
-
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/usage/log</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="
|
|
619
|
+
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/usage/log</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_175hq_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_175hq_0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab_R_175hq_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_175hq_1" data-rttab="true">422</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_175hq_0" aria-labelledby="tab_R_175hq_0"><div><div class="sc-cNSlRw bMFMGt"><span class="sc-bBzIOb BuCyN">Content type</span><div class="sc-dPqFhK kgKexQ">application/json</div></div><div class="sc-hUheUT jUCYlq"><div class="sc-cTZdpT hHzuQA"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-iJSMbW fiNpIH sc-jNDflC jgTAJz"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"endpoint"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"credits_cost"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"errors_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel_R_175hq_1" aria-labelledby="tab_R_175hq_1"></div></div></div></div></div></div><div id="tag/usage/operation/get_usage_by_key_v1_usage_by_key_get" data-section-id="tag/usage/operation/get_usage_by_key_v1_usage_by_key_get" class="sc-eCQgVK grDwca"><div data-section-id="operation/get_usage_by_key_v1_usage_by_key_get" id="operation/get_usage_by_key_v1_usage_by_key_get" class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/usage/operation/get_usage_by_key_v1_usage_by_key_get" aria-label="tag/usage/operation/get_usage_by_key_v1_usage_by_key_get"></a>Get Usage By Key<!-- --> </h2><div class="sc-fuYIqi kGZLat"><div class="sc-dalEhJ jdqJPb"><h5 class="sc-iqkkDd sc-jQQpTv jprlAr kEkHzF">Authorizations:</h5><svg class="sc-dYjPD bEEWJa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jTPGds cVAkzL"><span class="sc-dtnsVa hFacFb"><span class="sc-hPfayn hAYuWG"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqkkDd jprlAr">query<!-- --> Parameters</h5><table class="sc-hHopjF bsjUmE"><tbody><tr class="last "><td class="sc-hCcPtG sc-fFCZOx sc-jgzHYo jFNAwF lcdEEX QbYuY" kind="field" title="key_id"><span class="sc-ieCSdj kkMuqc"></span><button aria-label="expand key_id"><span class="property-name">key_id</span><svg class="sc-dYjPD kecbEr" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">Key Id (string) or Key Id (null)</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Key Id<!-- -->) </span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fINhYD hgNHCh">Responses</h3><div><button class="sc-cbuLjy iSTZHA"><svg class="sc-dYjPD gngmNp" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fXmTIC cqDULz">200<!-- --> </strong><div html="<p>Successful Response</p>
|
|
623
620
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Successful Response</p>
|
|
624
621
|
</div></button></div><div><button class="sc-cbuLjy cKkXxa"><svg class="sc-dYjPD hJoFRR" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fXmTIC cqDULz">422<!-- --> </strong><div html="<p>Validation Error</p>
|
|
625
622
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Validation Error</p>
|
|
626
623
|
</div></button></div></div></div><div class="sc-jSppWd sc-gKkgUA fpMlmc bdQQyo"><div class="sc-fXwuWv fYxpnv"><button class="sc-jWMFtl jzaJhV"><span type="get" class="sc-eEFuoE hlSrtW http-verb get">get</span><span class="sc-FpjRO dsIRaZ">/v1/usage/by-key</span><svg class="sc-dYjPD bQKUih" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-fmtEmb tUxhh"><div class="sc-ljIcGq bAnPPh"><div html="<p>FalaAI API - producao</p>
|
|
627
624
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>FalaAI API - producao</p>
|
|
628
|
-
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/usage/by-key</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="
|
|
625
|
+
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/usage/by-key</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_176hq_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_176hq_0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab_R_176hq_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_176hq_1" data-rttab="true">422</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_176hq_0" aria-labelledby="tab_R_176hq_0"><div><div class="sc-cNSlRw bMFMGt"><span class="sc-bBzIOb BuCyN">Content type</span><div class="sc-dPqFhK kgKexQ">application/json</div></div><div class="sc-hUheUT jUCYlq"><div class="sc-cTZdpT hHzuQA"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-iJSMbW fiNpIH sc-jNDflC jgTAJz"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"key_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"key_name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_credits"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"request_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_used"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel_R_176hq_1" aria-labelledby="tab_R_176hq_1"></div></div></div></div></div></div><div id="tag/webhooks" data-section-id="tag/webhooks" class="sc-eCQgVK jleRXN"><div class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/webhooks" aria-label="tag/webhooks"></a>webhooks</h2></div></div></div><div id="tag/webhooks/operation/list_webhooks_v1_webhooks_get" data-section-id="tag/webhooks/operation/list_webhooks_v1_webhooks_get" class="sc-eCQgVK grDwca"><div data-section-id="operation/list_webhooks_v1_webhooks_get" id="operation/list_webhooks_v1_webhooks_get" class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/webhooks/operation/list_webhooks_v1_webhooks_get" aria-label="tag/webhooks/operation/list_webhooks_v1_webhooks_get"></a>List webhooks<!-- --> </h2><div class="sc-iFUzrA ktZmcf"><div html="<p>Lists the authenticated user&#39;s webhooks (10 alerts). Paginated. Includes the URL signature secret (always visible to the owner).</p>
|
|
629
626
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH htbHfQ"><p>Lists the authenticated user's webhooks (10 alerts). Paginated. Includes the URL signature secret (always visible to the owner).</p>
|
|
630
627
|
</div></div><div class="sc-fuYIqi kGZLat"><div class="sc-dalEhJ jdqJPb"><h5 class="sc-iqkkDd sc-jQQpTv jprlAr kEkHzF">Authorizations:</h5><svg class="sc-dYjPD bEEWJa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jTPGds cVAkzL"><span class="sc-dtnsVa hFacFb"><span class="sc-hPfayn hAYuWG"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqkkDd jprlAr">query<!-- --> Parameters</h5><table class="sc-hHopjF bsjUmE"><tbody><tr class=""><td kind="field" title="page" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">page</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">integer</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Page<!-- -->) </span><span> <span class="sc-gSILEF sc-cljLBy jMRTsl enoyBT"> <!-- -->>= 1<!-- --> </span></span></div><div><span class="sc-gSILEF jMRTsl"> <!-- -->Default:<!-- --> </span> <span class="sc-gSILEF sc-lbFCLI jMRTsl OXDYs">1</span></div> <div><div html="<p>Pagina (1-indexed)</p>
|
|
631
628
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>Pagina (1-indexed)</p>
|
|
@@ -637,7 +634,7 @@ puts <span class="token constant">JSON</span><span class="token punctuation">.</
|
|
|
637
634
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Validation Error</p>
|
|
638
635
|
</div></button></div></div></div><div class="sc-jSppWd sc-gKkgUA fpMlmc bdQQyo"><div class="sc-fXwuWv fYxpnv"><button class="sc-jWMFtl jzaJhV"><span type="get" class="sc-eEFuoE hlSrtW http-verb get">get</span><span class="sc-FpjRO dsIRaZ">/v1/webhooks</span><svg class="sc-dYjPD bQKUih" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-fmtEmb tUxhh"><div class="sc-ljIcGq bAnPPh"><div html="<p>FalaAI API - producao</p>
|
|
639
636
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>FalaAI API - producao</p>
|
|
640
|
-
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/webhooks</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="
|
|
637
|
+
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/webhooks</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_2e9ia_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_2e9ia_0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab_R_2e9ia_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_2e9ia_1" data-rttab="true">422</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_2e9ia_0" aria-labelledby="tab_R_2e9ia_0"><div><div class="sc-cNSlRw bMFMGt"><span class="sc-bBzIOb BuCyN">Content type</span><div class="sc-dPqFhK kgKexQ">application/json</div></div><div class="sc-hUheUT jUCYlq"><div class="sc-cTZdpT hHzuQA"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-iJSMbW fiNpIH sc-jNDflC jgTAJz"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"events"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"retry_enabled"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_delivery_at"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_status"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"failure_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updated_at"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel_R_2e9ia_1" aria-labelledby="tab_R_2e9ia_1"></div></div></div></div></div></div><div id="tag/webhooks/operation/create_webhook_v1_webhooks_post" data-section-id="tag/webhooks/operation/create_webhook_v1_webhooks_post" class="sc-eCQgVK grDwca"><div data-section-id="operation/create_webhook_v1_webhooks_post" id="operation/create_webhook_v1_webhooks_post" class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/webhooks/operation/create_webhook_v1_webhooks_post" aria-label="tag/webhooks/operation/create_webhook_v1_webhooks_post"></a>Create webhook<!-- --> </h2><div class="sc-iFUzrA ktZmcf"><div html="<p>Creates a subscription for alert events (10 alerts). Payload delivered: WebhookPayload(event, data, timestamp) with HMAC FalaAI-Signature. To verify the origin, recompute HMAC-SHA256 of &quot;timestamp.body&quot; with your secret.</p>
|
|
641
638
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH htbHfQ"><p>Creates a subscription for alert events (10 alerts). Payload delivered: WebhookPayload(event, data, timestamp) with HMAC FalaAI-Signature. To verify the origin, recompute HMAC-SHA256 of "timestamp.body" with your secret.</p>
|
|
642
639
|
</div></div><div class="sc-fuYIqi kGZLat"><div class="sc-dalEhJ jdqJPb"><h5 class="sc-iqkkDd sc-jQQpTv jprlAr kEkHzF">Authorizations:</h5><svg class="sc-dYjPD bEEWJa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jTPGds cVAkzL"><span class="sc-dtnsVa hFacFb"><span class="sc-hPfayn hAYuWG"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqkkDd jprlAr">Request Body schema: <span class="sc-gXvOjn kxMqOs">application/json</span><div class="sc-gSILEF sc-eIYgEQ sc-dTCDEk jMRTsl dHYagA bxWqzP">required</div></h5><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH htbHfQ"></div><table class="sc-hHopjF bsjUmE"><tbody><tr class=""><td kind="field" title="name" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">name</span><div class="sc-gSILEF sc-eIYgEQ jMRTsl dHYagA">required</div></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Name<!-- -->) </span></div> <div><div html="<p>Nome identificador do webhook</p>
|
|
643
640
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>Nome identificador do webhook</p>
|
|
@@ -653,7 +650,7 @@ puts <span class="token constant">JSON</span><span class="token punctuation">.</
|
|
|
653
650
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Validation Error</p>
|
|
654
651
|
</div></button></div></div></div><div class="sc-jSppWd sc-gKkgUA fpMlmc bdQQyo"><div class="sc-fXwuWv fYxpnv"><button class="sc-jWMFtl jzaJhV"><span type="post" class="sc-eEFuoE hOENFc http-verb post">post</span><span class="sc-FpjRO dsIRaZ">/v1/webhooks</span><svg class="sc-dYjPD bQKUih" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-fmtEmb tUxhh"><div class="sc-ljIcGq bAnPPh"><div html="<p>FalaAI API - producao</p>
|
|
655
652
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>FalaAI API - producao</p>
|
|
656
|
-
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/webhooks</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="
|
|
653
|
+
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/webhooks</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_2eaia_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_2eaia_0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab_R_2eaia_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_2eaia_1" data-rttab="true">422</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_2eaia_0" aria-labelledby="tab_R_2eaia_0"><div><div class="sc-cNSlRw bMFMGt"><span class="sc-bBzIOb BuCyN">Content type</span><div class="sc-dPqFhK kgKexQ">application/json</div></div><div class="sc-hUheUT jUCYlq"><div class="sc-cTZdpT hHzuQA"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-iJSMbW fiNpIH sc-jNDflC jgTAJz"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"secret"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"events"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"retry_enabled"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_delivery_at"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"last_status"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"failure_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updated_at"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel_R_2eaia_1" aria-labelledby="tab_R_2eaia_1"></div></div></div></div></div></div><div id="tag/webhooks/operation/update_webhook_v1_webhooks__webhook_id__put" data-section-id="tag/webhooks/operation/update_webhook_v1_webhooks__webhook_id__put" class="sc-eCQgVK grDwca"><div data-section-id="operation/update_webhook_v1_webhooks__webhook_id__put" id="operation/update_webhook_v1_webhooks__webhook_id__put" class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/webhooks/operation/update_webhook_v1_webhooks__webhook_id__put" aria-label="tag/webhooks/operation/update_webhook_v1_webhooks__webhook_id__put"></a>Update webhook<!-- --> </h2><div class="sc-iFUzrA ktZmcf"><div html="<p>Updates the webhook&#39;s name/url/events/retry_enabled/active. Valid events: 10 alerts.</p>
|
|
657
654
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH htbHfQ"><p>Updates the webhook's name/url/events/retry_enabled/active. Valid events: 10 alerts.</p>
|
|
658
655
|
</div></div><div class="sc-fuYIqi kGZLat"><div class="sc-dalEhJ jdqJPb"><h5 class="sc-iqkkDd sc-jQQpTv jprlAr kEkHzF">Authorizations:</h5><svg class="sc-dYjPD bEEWJa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jTPGds cVAkzL"><span class="sc-dtnsVa hFacFb"><span class="sc-hPfayn hAYuWG"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqkkDd jprlAr">path<!-- --> Parameters</h5><table class="sc-hHopjF bsjUmE"><tbody><tr class="last "><td kind="field" title="webhook_id" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">webhook_id</span><div class="sc-gSILEF sc-eIYgEQ jMRTsl dHYagA">required</div></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Webhook Id<!-- -->) </span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr></tbody></table></div><h5 class="sc-iqkkDd jprlAr">Request Body schema: <span class="sc-gXvOjn kxMqOs">application/json</span><div class="sc-gSILEF sc-eIYgEQ sc-dTCDEk jMRTsl dHYagA bxWqzP">required</div></h5><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH htbHfQ"></div><table class="sc-hHopjF bsjUmE"><tbody><tr class=""><td class="sc-hCcPtG sc-fFCZOx sc-jgzHYo jFNAwF lcdEEX QbYuY" kind="field" title="name"><span class="sc-ieCSdj kkMuqc"></span><button aria-label="expand name"><span class="property-name">name</span><svg class="sc-dYjPD kecbEr" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">Name (string) or Name (null)</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Name<!-- -->) </span></div> <div><div html="<p>Nome identificador</p>
|
|
659
656
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>Nome identificador</p>
|
|
@@ -671,7 +668,7 @@ puts <span class="token constant">JSON</span><span class="token punctuation">.</
|
|
|
671
668
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Validation Error</p>
|
|
672
669
|
</div></button></div></div></div><div class="sc-jSppWd sc-gKkgUA fpMlmc bdQQyo"><div class="sc-fXwuWv fYxpnv"><button class="sc-jWMFtl jzaJhV"><span type="put" class="sc-eEFuoE dQBYof http-verb put">put</span><span class="sc-FpjRO dsIRaZ">/v1/webhooks/{webhook_id}</span><svg class="sc-dYjPD bQKUih" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-fmtEmb tUxhh"><div class="sc-ljIcGq bAnPPh"><div html="<p>FalaAI API - producao</p>
|
|
673
670
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>FalaAI API - producao</p>
|
|
674
|
-
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/webhooks/{webhook_id}</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="
|
|
671
|
+
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/webhooks/{webhook_id}</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_2ebia_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_2ebia_0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab_R_2ebia_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_2ebia_1" data-rttab="true">422</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_2ebia_0" aria-labelledby="tab_R_2ebia_0"><div><div class="sc-cNSlRw bMFMGt"><span class="sc-bBzIOb BuCyN">Content type</span><div class="sc-dPqFhK kgKexQ">application/json</div></div><div class="sc-hUheUT jUCYlq"><div class="sc-cTZdpT hHzuQA"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button></div><div tabindex="0" class="sc-iJSMbW fiNpIH sc-jNDflC jgTAJz"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel_R_2ebia_1" aria-labelledby="tab_R_2ebia_1"></div></div></div></div></div></div><div id="tag/webhooks/operation/delete_webhook_v1_webhooks__webhook_id__delete" data-section-id="tag/webhooks/operation/delete_webhook_v1_webhooks__webhook_id__delete" class="sc-eCQgVK grDwca"><div data-section-id="operation/delete_webhook_v1_webhooks__webhook_id__delete" id="operation/delete_webhook_v1_webhooks__webhook_id__delete" class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/webhooks/operation/delete_webhook_v1_webhooks__webhook_id__delete" aria-label="tag/webhooks/operation/delete_webhook_v1_webhooks__webhook_id__delete"></a>Delete webhook<!-- --> </h2><div class="sc-iFUzrA ktZmcf"><div html="<p>Deletes a webhook subscription by ID.</p>
|
|
675
672
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH htbHfQ"><p>Deletes a webhook subscription by ID.</p>
|
|
676
673
|
</div></div><div class="sc-fuYIqi kGZLat"><div class="sc-dalEhJ jdqJPb"><h5 class="sc-iqkkDd sc-jQQpTv jprlAr kEkHzF">Authorizations:</h5><svg class="sc-dYjPD bEEWJa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jTPGds cVAkzL"><span class="sc-dtnsVa hFacFb"><span class="sc-hPfayn hAYuWG"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqkkDd jprlAr">path<!-- --> Parameters</h5><table class="sc-hHopjF bsjUmE"><tbody><tr class="last "><td kind="field" title="webhook_id" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">webhook_id</span><div class="sc-gSILEF sc-eIYgEQ jMRTsl dHYagA">required</div></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Webhook Id<!-- -->) </span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fINhYD hgNHCh">Responses</h3><div><button class="sc-cbuLjy iSTZHA"><svg class="sc-dYjPD gngmNp" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fXmTIC cqDULz">200<!-- --> </strong><div html="<p>Successful Response</p>
|
|
677
674
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Successful Response</p>
|
|
@@ -679,13 +676,13 @@ puts <span class="token constant">JSON</span><span class="token punctuation">.</
|
|
|
679
676
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Validation Error</p>
|
|
680
677
|
</div></button></div></div></div><div class="sc-jSppWd sc-gKkgUA fpMlmc bdQQyo"><div class="sc-fXwuWv fYxpnv"><button class="sc-jWMFtl jzaJhV"><span type="delete" class="sc-eEFuoE iINwyG http-verb delete">delete</span><span class="sc-FpjRO dsIRaZ">/v1/webhooks/{webhook_id}</span><svg class="sc-dYjPD bQKUih" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-fmtEmb tUxhh"><div class="sc-ljIcGq bAnPPh"><div html="<p>FalaAI API - producao</p>
|
|
681
678
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>FalaAI API - producao</p>
|
|
682
|
-
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/webhooks/{webhook_id}</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="
|
|
679
|
+
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/webhooks/{webhook_id}</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_2ecia_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_2ecia_0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab_R_2ecia_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_2ecia_1" data-rttab="true">422</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_2ecia_0" aria-labelledby="tab_R_2ecia_0"><div><div class="sc-cNSlRw bMFMGt"><span class="sc-bBzIOb BuCyN">Content type</span><div class="sc-dPqFhK kgKexQ">application/json</div></div><div class="sc-hUheUT jUCYlq"><div class="sc-cTZdpT hHzuQA"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button></div><div tabindex="0" class="sc-iJSMbW fiNpIH sc-jNDflC jgTAJz"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel_R_2ecia_1" aria-labelledby="tab_R_2ecia_1"></div></div></div></div></div></div><div id="tag/email-alerts" data-section-id="tag/email-alerts" class="sc-eCQgVK jleRXN"><div class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/email-alerts" aria-label="tag/email-alerts"></a>email-alerts</h2></div></div></div><div id="tag/email-alerts/operation/list_email_alerts_v1_email_alerts_get" data-section-id="tag/email-alerts/operation/list_email_alerts_v1_email_alerts_get" class="sc-eCQgVK grDwca"><div data-section-id="operation/list_email_alerts_v1_email_alerts_get" id="operation/list_email_alerts_v1_email_alerts_get" class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/email-alerts/operation/list_email_alerts_v1_email_alerts_get" aria-label="tag/email-alerts/operation/list_email_alerts_v1_email_alerts_get"></a>List email alerts<!-- --> </h2><div class="sc-fuYIqi kGZLat"><div class="sc-dalEhJ jdqJPb"><h5 class="sc-iqkkDd sc-jQQpTv jprlAr kEkHzF">Authorizations:</h5><svg class="sc-dYjPD bEEWJa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jTPGds cVAkzL"><span class="sc-dtnsVa hFacFb"><span class="sc-hPfayn hAYuWG"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqkkDd jprlAr">query<!-- --> Parameters</h5><table class="sc-hHopjF bsjUmE"><tbody><tr class=""><td kind="field" title="page" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">page</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">integer</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Page<!-- -->) </span><span> <span class="sc-gSILEF sc-cljLBy jMRTsl enoyBT"> <!-- -->>= 1<!-- --> </span></span></div><div><span class="sc-gSILEF jMRTsl"> <!-- -->Default:<!-- --> </span> <span class="sc-gSILEF sc-lbFCLI jMRTsl OXDYs">1</span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr><tr class="last "><td kind="field" title="limit" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">limit</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">integer</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Limit<!-- -->) </span><span> <span class="sc-gSILEF sc-cljLBy jMRTsl enoyBT"> <!-- -->[ 1 .. 100 ]<!-- --> </span></span></div><div><span class="sc-gSILEF jMRTsl"> <!-- -->Default:<!-- --> </span> <span class="sc-gSILEF sc-lbFCLI jMRTsl OXDYs">20</span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fINhYD hgNHCh">Responses</h3><div><button class="sc-cbuLjy iSTZHA"><svg class="sc-dYjPD gngmNp" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fXmTIC cqDULz">200<!-- --> </strong><div html="<p>Successful Response</p>
|
|
683
680
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Successful Response</p>
|
|
684
681
|
</div></button></div><div><button class="sc-cbuLjy cKkXxa"><svg class="sc-dYjPD hJoFRR" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fXmTIC cqDULz">422<!-- --> </strong><div html="<p>Validation Error</p>
|
|
685
682
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Validation Error</p>
|
|
686
683
|
</div></button></div></div></div><div class="sc-jSppWd sc-gKkgUA fpMlmc bdQQyo"><div class="sc-fXwuWv fYxpnv"><button class="sc-jWMFtl jzaJhV"><span type="get" class="sc-eEFuoE hlSrtW http-verb get">get</span><span class="sc-FpjRO dsIRaZ">/v1/email-alerts</span><svg class="sc-dYjPD bQKUih" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-fmtEmb tUxhh"><div class="sc-ljIcGq bAnPPh"><div html="<p>FalaAI API - producao</p>
|
|
687
684
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>FalaAI API - producao</p>
|
|
688
|
-
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/email-alerts</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="
|
|
685
|
+
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/email-alerts</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_2e9iq_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_2e9iq_0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab_R_2e9iq_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_2e9iq_1" data-rttab="true">422</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_2e9iq_0" aria-labelledby="tab_R_2e9iq_0"><div><div class="sc-cNSlRw bMFMGt"><span class="sc-bBzIOb BuCyN">Content type</span><div class="sc-dPqFhK kgKexQ">application/json</div></div><div class="sc-hUheUT jUCYlq"><div class="sc-cTZdpT hHzuQA"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-iJSMbW fiNpIH sc-jNDflC jgTAJz"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"events"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updated_at"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"page"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"limit"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel_R_2e9iq_1" aria-labelledby="tab_R_2e9iq_1"></div></div></div></div></div></div><div id="tag/email-alerts/operation/create_email_alert_v1_email_alerts_post" data-section-id="tag/email-alerts/operation/create_email_alert_v1_email_alerts_post" class="sc-eCQgVK grDwca"><div data-section-id="operation/create_email_alert_v1_email_alerts_post" id="operation/create_email_alert_v1_email_alerts_post" class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/email-alerts/operation/create_email_alert_v1_email_alerts_post" aria-label="tag/email-alerts/operation/create_email_alert_v1_email_alerts_post"></a>Create email alert<!-- --> </h2><div class="sc-fuYIqi kGZLat"><div class="sc-dalEhJ jdqJPb"><h5 class="sc-iqkkDd sc-jQQpTv jprlAr kEkHzF">Authorizations:</h5><svg class="sc-dYjPD bEEWJa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jTPGds cVAkzL"><span class="sc-dtnsVa hFacFb"><span class="sc-hPfayn hAYuWG"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqkkDd jprlAr">Request Body schema: <span class="sc-gXvOjn kxMqOs">application/json</span><div class="sc-gSILEF sc-eIYgEQ sc-dTCDEk jMRTsl dHYagA bxWqzP">required</div></h5><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH htbHfQ"></div><table class="sc-hHopjF bsjUmE"><tbody><tr class=""><td kind="field" title="name" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">name</span><div class="sc-gSILEF sc-eIYgEQ jMRTsl dHYagA">required</div></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Name<!-- -->) </span></div> <div><div html="<p>Nome identificador</p>
|
|
689
686
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>Nome identificador</p>
|
|
690
687
|
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">email</span><div class="sc-gSILEF sc-eIYgEQ jMRTsl dHYagA">required</div></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Email<!-- -->) </span></div> <div><div html="<p>Email destino</p>
|
|
691
688
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>Email destino</p>
|
|
@@ -697,27 +694,33 @@ puts <span class="token constant">JSON</span><span class="token punctuation">.</
|
|
|
697
694
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Validation Error</p>
|
|
698
695
|
</div></button></div></div></div><div class="sc-jSppWd sc-gKkgUA fpMlmc bdQQyo"><div class="sc-fXwuWv fYxpnv"><button class="sc-jWMFtl jzaJhV"><span type="post" class="sc-eEFuoE hOENFc http-verb post">post</span><span class="sc-FpjRO dsIRaZ">/v1/email-alerts</span><svg class="sc-dYjPD bQKUih" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-fmtEmb tUxhh"><div class="sc-ljIcGq bAnPPh"><div html="<p>FalaAI API - producao</p>
|
|
699
696
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>FalaAI API - producao</p>
|
|
700
|
-
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/email-alerts</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="
|
|
697
|
+
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/email-alerts</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_2eaiq_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_2eaiq_0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab_R_2eaiq_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_2eaiq_1" data-rttab="true">422</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_2eaiq_0" aria-labelledby="tab_R_2eaiq_0"><div><div class="sc-cNSlRw bMFMGt"><span class="sc-bBzIOb BuCyN">Content type</span><div class="sc-dPqFhK kgKexQ">application/json</div></div><div class="sc-hUheUT jUCYlq"><div class="sc-cTZdpT hHzuQA"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-iJSMbW fiNpIH sc-jNDflC jgTAJz"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"events"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"string"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updated_at"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel_R_2eaiq_1" aria-labelledby="tab_R_2eaiq_1"></div></div></div></div></div></div><div id="tag/email-alerts/operation/update_email_alert_v1_email_alerts__alert_id__put" data-section-id="tag/email-alerts/operation/update_email_alert_v1_email_alerts__alert_id__put" class="sc-eCQgVK grDwca"><div data-section-id="operation/update_email_alert_v1_email_alerts__alert_id__put" id="operation/update_email_alert_v1_email_alerts__alert_id__put" class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/email-alerts/operation/update_email_alert_v1_email_alerts__alert_id__put" aria-label="tag/email-alerts/operation/update_email_alert_v1_email_alerts__alert_id__put"></a>Update email alert<!-- --> </h2><div class="sc-fuYIqi kGZLat"><div class="sc-dalEhJ jdqJPb"><h5 class="sc-iqkkDd sc-jQQpTv jprlAr kEkHzF">Authorizations:</h5><svg class="sc-dYjPD bEEWJa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jTPGds cVAkzL"><span class="sc-dtnsVa hFacFb"><span class="sc-hPfayn hAYuWG"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqkkDd jprlAr">path<!-- --> Parameters</h5><table class="sc-hHopjF bsjUmE"><tbody><tr class="last "><td kind="field" title="alert_id" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">alert_id</span><div class="sc-gSILEF sc-eIYgEQ jMRTsl dHYagA">required</div></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Alert Id<!-- -->) </span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr></tbody></table></div><h5 class="sc-iqkkDd jprlAr">Request Body schema: <span class="sc-gXvOjn kxMqOs">application/json</span><div class="sc-gSILEF sc-eIYgEQ sc-dTCDEk jMRTsl dHYagA bxWqzP">required</div></h5><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH htbHfQ"></div><table class="sc-hHopjF bsjUmE"><tbody><tr class=""><td class="sc-hCcPtG sc-fFCZOx sc-jgzHYo jFNAwF lcdEEX QbYuY" kind="field" title="name"><span class="sc-ieCSdj kkMuqc"></span><button aria-label="expand name"><span class="property-name">name</span><svg class="sc-dYjPD kecbEr" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">Name (string) or Name (null)</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Name<!-- -->) </span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr><tr class=""><td class="sc-hCcPtG sc-fFCZOx sc-jgzHYo jFNAwF lcdEEX QbYuY" kind="field" title="email"><span class="sc-ieCSdj kkMuqc"></span><button aria-label="expand email"><span class="property-name">email</span><svg class="sc-dYjPD kecbEr" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">Email (string) or Email (null)</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Email<!-- -->) </span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr><tr class=""><td class="sc-hCcPtG sc-fFCZOx sc-jgzHYo jFNAwF lcdEEX QbYuY" kind="field" title="events"><span class="sc-ieCSdj kkMuqc"></span><button aria-label="expand events"><span class="property-name">events</span><svg class="sc-dYjPD kecbEr" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">Array of Events (strings) or Events (null)</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Events<!-- -->) </span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr><tr class="last "><td class="sc-hCcPtG sc-fFCZOx sc-jgzHYo jFNAwF lcdEEX QbYuY" kind="field" title="active"><span class="sc-ieCSdj kkMuqc"></span><button aria-label="expand active"><span class="property-name">active</span><svg class="sc-dYjPD kecbEr" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">Active (boolean) or Active (null)</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Active<!-- -->) </span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fINhYD hgNHCh">Responses</h3><div><button class="sc-cbuLjy iSTZHA"><svg class="sc-dYjPD gngmNp" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fXmTIC cqDULz">200<!-- --> </strong><div html="<p>Successful Response</p>
|
|
701
698
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Successful Response</p>
|
|
702
699
|
</div></button></div><div><button class="sc-cbuLjy cKkXxa"><svg class="sc-dYjPD hJoFRR" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fXmTIC cqDULz">422<!-- --> </strong><div html="<p>Validation Error</p>
|
|
703
700
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Validation Error</p>
|
|
704
701
|
</div></button></div></div></div><div class="sc-jSppWd sc-gKkgUA fpMlmc bdQQyo"><div class="sc-fXwuWv fYxpnv"><button class="sc-jWMFtl jzaJhV"><span type="put" class="sc-eEFuoE dQBYof http-verb put">put</span><span class="sc-FpjRO dsIRaZ">/v1/email-alerts/{alert_id}</span><svg class="sc-dYjPD bQKUih" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-fmtEmb tUxhh"><div class="sc-ljIcGq bAnPPh"><div html="<p>FalaAI API - producao</p>
|
|
705
702
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>FalaAI API - producao</p>
|
|
706
|
-
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/email-alerts/{alert_id}</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="
|
|
703
|
+
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/email-alerts/{alert_id}</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_2ebiq_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_2ebiq_0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab_R_2ebiq_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_2ebiq_1" data-rttab="true">422</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_2ebiq_0" aria-labelledby="tab_R_2ebiq_0"><div><div class="sc-cNSlRw bMFMGt"><span class="sc-bBzIOb BuCyN">Content type</span><div class="sc-dPqFhK kgKexQ">application/json</div></div><div class="sc-hUheUT jUCYlq"><div class="sc-cTZdpT hHzuQA"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button></div><div tabindex="0" class="sc-iJSMbW fiNpIH sc-jNDflC jgTAJz"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel_R_2ebiq_1" aria-labelledby="tab_R_2ebiq_1"></div></div></div></div></div></div><div id="tag/email-alerts/operation/delete_email_alert_v1_email_alerts__alert_id__delete" data-section-id="tag/email-alerts/operation/delete_email_alert_v1_email_alerts__alert_id__delete" class="sc-eCQgVK grDwca"><div data-section-id="operation/delete_email_alert_v1_email_alerts__alert_id__delete" id="operation/delete_email_alert_v1_email_alerts__alert_id__delete" class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/email-alerts/operation/delete_email_alert_v1_email_alerts__alert_id__delete" aria-label="tag/email-alerts/operation/delete_email_alert_v1_email_alerts__alert_id__delete"></a>Delete email alert<!-- --> </h2><div class="sc-fuYIqi kGZLat"><div class="sc-dalEhJ jdqJPb"><h5 class="sc-iqkkDd sc-jQQpTv jprlAr kEkHzF">Authorizations:</h5><svg class="sc-dYjPD bEEWJa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jTPGds cVAkzL"><span class="sc-dtnsVa hFacFb"><span class="sc-hPfayn hAYuWG"><i>ApiKeyAuth</i></span></span></div></div><div><h5 class="sc-iqkkDd jprlAr">path<!-- --> Parameters</h5><table class="sc-hHopjF bsjUmE"><tbody><tr class="last "><td kind="field" title="alert_id" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">alert_id</span><div class="sc-gSILEF sc-eIYgEQ jMRTsl dHYagA">required</div></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Alert Id<!-- -->) </span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-fINhYD hgNHCh">Responses</h3><div><button class="sc-cbuLjy iSTZHA"><svg class="sc-dYjPD gngmNp" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fXmTIC cqDULz">200<!-- --> </strong><div html="<p>Successful Response</p>
|
|
707
704
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Successful Response</p>
|
|
708
705
|
</div></button></div><div><button class="sc-cbuLjy cKkXxa"><svg class="sc-dYjPD hJoFRR" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fXmTIC cqDULz">422<!-- --> </strong><div html="<p>Validation Error</p>
|
|
709
706
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Validation Error</p>
|
|
710
707
|
</div></button></div></div></div><div class="sc-jSppWd sc-gKkgUA fpMlmc bdQQyo"><div class="sc-fXwuWv fYxpnv"><button class="sc-jWMFtl jzaJhV"><span type="delete" class="sc-eEFuoE iINwyG http-verb delete">delete</span><span class="sc-FpjRO dsIRaZ">/v1/email-alerts/{alert_id}</span><svg class="sc-dYjPD bQKUih" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-fmtEmb tUxhh"><div class="sc-ljIcGq bAnPPh"><div html="<p>FalaAI API - producao</p>
|
|
711
708
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>FalaAI API - producao</p>
|
|
712
|
-
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/email-alerts/{alert_id}</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="
|
|
709
|
+
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/email-alerts/{alert_id}</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_2eciq_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_2eciq_0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab_R_2eciq_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_2eciq_1" data-rttab="true">422</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_2eciq_0" aria-labelledby="tab_R_2eciq_0"><div><div class="sc-cNSlRw bMFMGt"><span class="sc-bBzIOb BuCyN">Content type</span><div class="sc-dPqFhK kgKexQ">application/json</div></div><div class="sc-hUheUT jUCYlq"><div class="sc-cTZdpT hHzuQA"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button></div><div tabindex="0" class="sc-iJSMbW fiNpIH sc-jNDflC jgTAJz"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel_R_2eciq_1" aria-labelledby="tab_R_2eciq_1"></div></div></div></div></div></div><div id="tag/whatsapp" data-section-id="tag/whatsapp" class="sc-eCQgVK jleRXN"><div class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/whatsapp" aria-label="tag/whatsapp"></a>whatsapp</h2></div></div></div><div id="tag/whatsapp/operation/extract_conversations_v1_whatsapp_extractConversations_post" data-section-id="tag/whatsapp/operation/extract_conversations_v1_whatsapp_extractConversations_post" class="sc-eCQgVK grDwca"><div data-section-id="operation/extract_conversations_v1_whatsapp_extractConversations_post" id="operation/extract_conversations_v1_whatsapp_extractConversations_post" class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/whatsapp/operation/extract_conversations_v1_whatsapp_extractConversations_post" aria-label="tag/whatsapp/operation/extract_conversations_v1_whatsapp_extractConversations_post"></a>Extract and segment WhatsApp conversations from an export<!-- --> </h2><div class="sc-fuYIqi kGZLat"><div class="sc-dalEhJ jdqJPb"><h5 class="sc-iqkkDd sc-jQQpTv jprlAr kEkHzF">Authorizations:</h5><svg class="sc-dYjPD bEEWJa" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jTPGds cVAkzL"><span class="sc-dtnsVa hFacFb"><span class="sc-hPfayn hAYuWG"><i>ApiKeyAuth</i></span></span></div></div><h5 class="sc-iqkkDd jprlAr">Request Body schema: <span class="sc-gXvOjn kxMqOs">multipart/form-data</span><div class="sc-gSILEF sc-eIYgEQ sc-dTCDEk jMRTsl dHYagA bxWqzP">required</div></h5><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH htbHfQ"></div><table class="sc-hHopjF bsjUmE"><tbody><tr class=""><td kind="field" title="file" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">file</span><div class="sc-gSILEF sc-eIYgEQ jMRTsl dHYagA">required</div></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->File<!-- -->) </span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr><tr class=""><td kind="field" title="start" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">start</span><div class="sc-gSILEF sc-eIYgEQ jMRTsl dHYagA">required</div></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Start<!-- -->) </span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr><tr class=""><td kind="field" title="end" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">end</span><div class="sc-gSILEF sc-eIYgEQ jMRTsl dHYagA">required</div></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->End<!-- -->) </span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr><tr class=""><td kind="field" title="timezone" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">timezone</span><div class="sc-gSILEF sc-eIYgEQ jMRTsl dHYagA">required</div></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Timezone<!-- -->) </span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr><tr class=""><td kind="field" title="date_format" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">date_format</span><div class="sc-gSILEF sc-eIYgEQ jMRTsl dHYagA">required</div></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Date Format<!-- -->) </span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr><tr class=""><td kind="field" title="gap_minutes" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">gap_minutes</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">number</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Gap Minutes<!-- -->) </span></div><div><span class="sc-gSILEF jMRTsl"> <!-- -->Default:<!-- --> </span> <span class="sc-gSILEF sc-lbFCLI jMRTsl OXDYs">720</span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr><tr class=""><td kind="field" title="min_messages" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">min_messages</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">integer</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Min Messages<!-- -->) </span></div><div><span class="sc-gSILEF jMRTsl"> <!-- -->Default:<!-- --> </span> <span class="sc-gSILEF sc-lbFCLI jMRTsl OXDYs">2</span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr><tr class=""><td kind="field" title="chars_per_minute" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">chars_per_minute</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">number</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Chars Per Minute<!-- -->) </span></div><div><span class="sc-gSILEF jMRTsl"> <!-- -->Default:<!-- --> </span> <span class="sc-gSILEF sc-lbFCLI jMRTsl OXDYs">800</span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr><tr class="last "><td kind="field" title="client_reference_id" class="sc-hCcPtG sc-fFCZOx jFNAwF lcdEEX"><span class="sc-ieCSdj kkMuqc"></span><span class="property-name">client_reference_id</span></td><td class="sc-bjLslk gLpZiQ"><div><div><span class="sc-gSILEF sc-lbpDNm jMRTsl NncTE"></span><span class="sc-gSILEF sc-iNyHtD jMRTsl kUjPnZ">string</span><span class="sc-gSILEF sc-jePOid jMRTsl ehlihR"> (<!-- -->Client Reference Id<!-- -->) </span></div> <div><div html="" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"></div></div></div></td></tr></tbody></table><div><h3 class="sc-fINhYD hgNHCh">Responses</h3><div><button class="sc-cbuLjy iSTZHA"><svg class="sc-dYjPD gngmNp" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fXmTIC cqDULz">200<!-- --> </strong><div html="<p>Successful Response</p>
|
|
710
|
+
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Successful Response</p>
|
|
711
|
+
</div></button></div><div><button class="sc-cbuLjy cKkXxa"><svg class="sc-dYjPD hJoFRR" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fXmTIC cqDULz">422<!-- --> </strong><div html="<p>Validation Error</p>
|
|
712
|
+
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Validation Error</p>
|
|
713
|
+
</div></button></div></div></div><div class="sc-jSppWd sc-gKkgUA fpMlmc bdQQyo"><div class="sc-fXwuWv fYxpnv"><button class="sc-jWMFtl jzaJhV"><span type="post" class="sc-eEFuoE hOENFc http-verb post">post</span><span class="sc-FpjRO dsIRaZ">/v1/whatsapp/extractConversations</span><svg class="sc-dYjPD bQKUih" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-fmtEmb tUxhh"><div class="sc-ljIcGq bAnPPh"><div html="<p>FalaAI API - producao</p>
|
|
714
|
+
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>FalaAI API - producao</p>
|
|
715
|
+
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/whatsapp/extractConversations</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_jjja_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_jjja_0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab_R_jjja_1" aria-selected="false" aria-disabled="false" aria-controls="panel_R_jjja_1" data-rttab="true">422</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_jjja_0" aria-labelledby="tab_R_jjja_0"><div><div class="sc-cNSlRw bMFMGt"><span class="sc-bBzIOb BuCyN">Content type</span><div class="sc-dPqFhK kgKexQ">application/json</div></div><div class="sc-hUheUT jUCYlq"><div class="sc-cTZdpT hHzuQA"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-iJSMbW fiNpIH sc-jNDflC jgTAJz"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"usage"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"conversations"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"characters"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"credits_consumed"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"processing_ms"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"conversations"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"conversation_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"first_at"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"last_at"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"duration_seconds"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"speakers"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"label"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"dialog"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"characters"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"client_reference_id"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"meta"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"file"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"chat_txt"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"format"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"date_format"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"timezone"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"start"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"end"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"gap_minutes"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"min_messages"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"chars_per_minute"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"turns"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"system_lines"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"conversations_total"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"conversations_in_window"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"monologues_dropped"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"conversations_selected"</span>: <span class="token number">0</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel_R_jjja_1" aria-labelledby="tab_R_jjja_1"></div></div></div></div></div></div><div id="tag/version" data-section-id="tag/version" class="sc-eCQgVK jleRXN"><div class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/version" aria-label="tag/version"></a>version</h2></div></div></div><div id="tag/version/operation/get_version_api_version_get" data-section-id="tag/version/operation/get_version_api_version_get" class="sc-eCQgVK grDwca"><div data-section-id="operation/get_version_api_version_get" id="operation/get_version_api_version_get" class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/version/operation/get_version_api_version_get" aria-label="tag/version/operation/get_version_api_version_get"></a>Get Version<!-- --> </h2><div><h3 class="sc-fINhYD hgNHCh">Responses</h3><div><button class="sc-cbuLjy iSTZHA"><svg class="sc-dYjPD gngmNp" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fXmTIC cqDULz">200<!-- --> </strong><div html="<p>Successful Response</p>
|
|
713
716
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Successful Response</p>
|
|
714
717
|
</div></button></div></div></div><div class="sc-jSppWd sc-gKkgUA fpMlmc bdQQyo"><div class="sc-fXwuWv fYxpnv"><button class="sc-jWMFtl jzaJhV"><span type="get" class="sc-eEFuoE hlSrtW http-verb get">get</span><span class="sc-FpjRO dsIRaZ">/api/version</span><svg class="sc-dYjPD bQKUih" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-fmtEmb tUxhh"><div class="sc-ljIcGq bAnPPh"><div html="<p>FalaAI API - producao</p>
|
|
715
718
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>FalaAI API - producao</p>
|
|
716
|
-
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/api/version</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="
|
|
719
|
+
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/api/version</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_jjjq_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_jjjq_0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_jjjq_0" aria-labelledby="tab_R_jjjq_0"><div><div class="sc-cNSlRw bMFMGt"><span class="sc-bBzIOb BuCyN">Content type</span><div class="sc-dPqFhK kgKexQ">application/json</div></div><div class="sc-hUheUT jUCYlq"><div class="sc-cTZdpT hHzuQA"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button></div><div tabindex="0" class="sc-iJSMbW fiNpIH sc-jNDflC jgTAJz"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"service"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"deployDate"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/health" data-section-id="tag/health" class="sc-eCQgVK jleRXN"><div class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/health" aria-label="tag/health"></a>health</h2></div></div></div><div id="tag/health/operation/health_check" data-section-id="tag/health/operation/health_check" class="sc-eCQgVK grDwca"><div data-section-id="operation/health_check" id="operation/health_check" class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/health/operation/health_check" aria-label="tag/health/operation/health_check"></a>Health Check<!-- --> </h2><div><h3 class="sc-fINhYD hgNHCh">Responses</h3><div><button class="sc-cbuLjy iSTZHA"><svg class="sc-dYjPD gngmNp" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fXmTIC cqDULz">200<!-- --> </strong><div html="<p>Successful Response</p>
|
|
717
720
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Successful Response</p>
|
|
718
721
|
</div></button></div></div></div><div class="sc-jSppWd sc-gKkgUA fpMlmc bdQQyo"><div class="sc-fXwuWv fYxpnv"><button class="sc-jWMFtl jzaJhV"><span type="get" class="sc-eEFuoE hlSrtW http-verb get">get</span><span class="sc-FpjRO dsIRaZ">/v1/health</span><svg class="sc-dYjPD bQKUih" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-fmtEmb tUxhh"><div class="sc-ljIcGq bAnPPh"><div html="<p>FalaAI API - producao</p>
|
|
719
722
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>FalaAI API - producao</p>
|
|
720
|
-
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/health</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="
|
|
723
|
+
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/health</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab_R_155ka_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_155ka_0" tabindex="0" data-rttab="true">Como verificar a saude da API</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_155ka_0" aria-labelledby="tab_R_155ka_0"><div class="sc-ezjgic hsxFzL"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button></div><pre class="sc-iJSMbW sc-bYgEKt fiNpIH kBZzKJ"><span class="token comment"># frozen_string_literal: true</span>
|
|
721
724
|
<span class="token keyword">require</span> <span class="token string-literal"><span class="token string">'falaai-api'</span></span>
|
|
722
725
|
|
|
723
726
|
config <span class="token operator">=</span> FalaAI<span class="token double-colon punctuation">::</span><span class="token class-name">Configuration</span><span class="token punctuation">.</span><span class="token keyword">new</span>
|
|
@@ -729,11 +732,11 @@ client <span class="token operator">=</span> FalaAI<span class="token double-col
|
|
|
729
732
|
health <span class="token operator">=</span> FalaAI<span class="token double-colon punctuation">::</span><span class="token class-name">HealthApi</span><span class="token punctuation">.</span><span class="token keyword">new</span><span class="token punctuation">(</span>client<span class="token punctuation">)</span><span class="token punctuation">.</span>health_check
|
|
730
733
|
puts <span class="token constant">JSON</span><span class="token punctuation">.</span>pretty_generate<span class="token punctuation">(</span>health<span class="token punctuation">.</span>to_hash<span class="token punctuation">)</span>
|
|
731
734
|
|
|
732
|
-
FalaAI<span class="token double-colon punctuation">::</span><span class="token class-name">HealthApi</span><span class="token punctuation">.</span><span class="token keyword">new</span><span class="token punctuation">(</span>client<span class="token punctuation">)</span><span class="token punctuation">.</span>health_check_head</pre></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="
|
|
735
|
+
FalaAI<span class="token double-colon punctuation">::</span><span class="token class-name">HealthApi</span><span class="token punctuation">.</span><span class="token keyword">new</span><span class="token punctuation">(</span>client<span class="token punctuation">)</span><span class="token punctuation">.</span>health_check_head</pre></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_175ka_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_175ka_0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_175ka_0" aria-labelledby="tab_R_175ka_0"><div><div class="sc-cNSlRw bMFMGt"><span class="sc-bBzIOb BuCyN">Content type</span><div class="sc-dPqFhK kgKexQ">application/json</div></div><div class="sc-hUheUT jUCYlq"><div class="sc-cTZdpT hHzuQA"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button></div><div tabindex="0" class="sc-iJSMbW fiNpIH sc-jNDflC jgTAJz"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"uptime_seconds"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"database"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phase"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"launch_date"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/health/operation/health_check_head" data-section-id="tag/health/operation/health_check_head" class="sc-eCQgVK grDwca"><div data-section-id="operation/health_check_head" id="operation/health_check_head" class="sc-iCECmn lhRBUS"><div class="sc-hKVpXn kktglN"><h2 class="sc-qdQOe MOVBZ"><a class="sc-crPgjm jmoZom" href="#tag/health/operation/health_check_head" aria-label="tag/health/operation/health_check_head"></a>Health Check<!-- --> </h2><div><h3 class="sc-fINhYD hgNHCh">Responses</h3><div><button class="sc-cbuLjy iSTZHA"><svg class="sc-dYjPD gngmNp" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-fXmTIC cqDULz">200<!-- --> </strong><div html="<p>Successful Response</p>
|
|
733
736
|
" class="sc-iJSMbW sc-cBEgGa sc-ciCrSJ fiNpIH iHFyeq dDDioG"><p>Successful Response</p>
|
|
734
737
|
</div></button></div></div></div><div class="sc-jSppWd sc-gKkgUA fpMlmc bdQQyo"><div class="sc-fXwuWv fYxpnv"><button class="sc-jWMFtl jzaJhV"><span type="head" class="sc-eEFuoE hPxfcP http-verb head">head</span><span class="sc-FpjRO dsIRaZ">/v1/health</span><svg class="sc-dYjPD bQKUih" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-fmtEmb tUxhh"><div class="sc-ljIcGq bAnPPh"><div html="<p>FalaAI API - producao</p>
|
|
735
738
|
" class="sc-iJSMbW sc-cBEgGa fiNpIH bWgCZK"><p>FalaAI API - producao</p>
|
|
736
|
-
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/health</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="
|
|
739
|
+
</div><div tabindex="0" role="button"><div class="sc-jlJOIR PEJyb"><span>https://api01-falaai.action.tec.br</span>/v1/health</div></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Request samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab_R_156ka_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_156ka_0" tabindex="0" data-rttab="true">Health check (HEAD — sem body)</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_156ka_0" aria-labelledby="tab_R_156ka_0"><div class="sc-ezjgic hsxFzL"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button></div><pre class="sc-iJSMbW sc-bYgEKt fiNpIH kBZzKJ"><span class="token comment"># frozen_string_literal: true</span>
|
|
737
740
|
<span class="token keyword">require</span> <span class="token string-literal"><span class="token string">'falaai-api'</span></span>
|
|
738
741
|
|
|
739
742
|
config <span class="token operator">=</span> FalaAI<span class="token double-colon punctuation">::</span><span class="token class-name">Configuration</span><span class="token punctuation">.</span><span class="token keyword">new</span>
|
|
@@ -745,9 +748,9 @@ client <span class="token operator">=</span> FalaAI<span class="token double-col
|
|
|
745
748
|
health <span class="token operator">=</span> FalaAI<span class="token double-colon punctuation">::</span><span class="token class-name">HealthApi</span><span class="token punctuation">.</span><span class="token keyword">new</span><span class="token punctuation">(</span>client<span class="token punctuation">)</span><span class="token punctuation">.</span>health_check
|
|
746
749
|
puts <span class="token constant">JSON</span><span class="token punctuation">.</span>pretty_generate<span class="token punctuation">(</span>health<span class="token punctuation">.</span>to_hash<span class="token punctuation">)</span>
|
|
747
750
|
|
|
748
|
-
FalaAI<span class="token double-colon punctuation">::</span><span class="token class-name">HealthApi</span><span class="token punctuation">.</span><span class="token keyword">new</span><span class="token punctuation">(</span>client<span class="token punctuation">)</span><span class="token punctuation">.</span>health_check_head</pre></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="
|
|
751
|
+
FalaAI<span class="token double-colon punctuation">::</span><span class="token class-name">HealthApi</span><span class="token punctuation">.</span><span class="token keyword">new</span><span class="token punctuation">(</span>client<span class="token punctuation">)</span><span class="token punctuation">.</span>health_check_head</pre></div></div></div></div><div><h3 class="sc-kEbgWM iamDfj"> <!-- -->Response samples<!-- --> </h3><div class="sc-cxxQMU fcGuQW" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab_R_176ka_0" aria-selected="true" aria-disabled="false" aria-controls="panel_R_176ka_0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel_R_176ka_0" aria-labelledby="tab_R_176ka_0"><div><div class="sc-cNSlRw bMFMGt"><span class="sc-bBzIOb BuCyN">Content type</span><div class="sc-dPqFhK kgKexQ">application/json</div></div><div class="sc-hUheUT jUCYlq"><div class="sc-cTZdpT hHzuQA"><div class="sc-giQkEn dzKJV"><button><div class="sc-jcgtOs feYhXE">Copy</div></button></div><div tabindex="0" class="sc-iJSMbW fiNpIH sc-jNDflC jgTAJz"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"version"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"uptime_seconds"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"database"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phase"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"launch_date"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div class="sc-ekVkVN bjzTxL"></div></div></div>
|
|
749
752
|
<script>
|
|
750
|
-
const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.1.0","info":{"title":"FalaAI API","version":"1.21.49"},"paths":{"/v1/audio/transcriptions":{"post":{"tags":["speech"],"summary":"Transcribe audio to text","operationId":"create_transcription_v1_audio_transcriptions_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_create_transcription_v1_audio_transcriptions_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscriptionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"Ruby","label":"Transcrever audio (SDK)","source":"# frozen_string_literal: true\nrequire 'falaai-api'\n\nconfig = FalaAI::Configuration.new\nconfig.scheme = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').start_with?('https') ? 'https' : 'http'\nconfig.host = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').sub(%r{^https?://}, '')\nconfig.base_path = ''\nconfig.access_token = ENV['FALAAI_API_KEY']\nclient = FalaAI::ApiClient.new(config)\n\naudio = File.open(\"demo_callcenter.mp3\")\n# REQUIRED: file (audio) + Authorization (fai_ key)\n# OPTIONAL (server defaults): model -> falaai-transcribe-1 | language -> pt | client_reference_id -> (empty)\ntranscription, _status = FalaAI::SpeechApi.new(client).create_transcription_v1_audio_transcriptions_post_with_http_info(\n audio,\n model: \"falaai-transcribe-1\",\n language: \"pt\",\n client_reference_id: \"call_202609271408\"\n)\nputs JSON.pretty_generate(transcription.to_hash)"}]}},"/v1/analyze/diagnostic":{"post":{"tags":["analysis"],"summary":"Analyze a call transcript — 5 parallel analyses","operationId":"create_diagnostic_v1_analyze_diagnostic_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiagnosticRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiagnosticResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"Ruby","label":"Diagnostico da conversa (SDK)","source":"# frozen_string_literal: true\nrequire 'falaai-api'\n\nconfig = FalaAI::Configuration.new\nconfig.scheme = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').start_with?('https') ? 'https' : 'http'\nconfig.host = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').sub(%r{^https?://}, '')\nconfig.base_path = ''\nconfig.access_token = ENV['FALAAI_API_KEY']\nclient = FalaAI::ApiClient.new(config)\n\n# REQUIRED: language, duration_seconds (>= 1.0) + Authorization\n# RULE: dialog OR text - we send dialog and text stays EMPTY (and the optional fallback)\n# OPTIONAL: model -> falaai-diagnostic-1 | audio_events -> [] |\n# response_language -> (uses language) | call_direction / participants / client_reference_id -> null\ndiagnostic, _status = FalaAI::AnalysisApi.new(client).create_diagnostic_v1_analyze_diagnostic_post_with_http_info(\n FalaAI::DiagnosticRequest.new(\n model: \"falaai-diagnostic-1\",\n text: \"\",\n dialog: \"Speaker 1: [00:00:00.100 - 00:00:03.100] Central de atendimento. Bom dia, aqui é a Carla. Como posso ajudar?\\nSpeaker 2: [00:00:03.100 - 00:00:04.700] [suspiro]\\nSpeaker 2: [00:00:04.780 - 00:00:11.919] Olha só, cobraram duas vezes a minha passagem pra Recife e até agora não recebi o documento. Preciso resolver isso.\\nSpeaker 1: [00:00:12.679 - 00:00:20.219] Entendo perfeitamente a sua frustração, senhor. Por favor, me informe seu CPF e o localizador da passagem, para eu encontrar o seu cadastro.\\nSpeaker 2: [00:00:20.820 - 00:00:31.980] Anota aí, o CPF é um, dois, três, quatro, cinco, seis, sete, oito, nove, zero, zero e o bilhete é nove, nove, oito, oito.\\nSpeaker 1: [00:00:32.579 - 00:00:42.039] Pronto, localizei. Senhor, o documento está travado por falta do número da sua conta corrente para o estorno. Nós solicitamos isso por e-mail há três dias.\\nSpeaker 2: [00:00:42.780 - 00:00:47.520] Ah, tá de brincadeira? Quer dizer que agora o erro é meu? Vocês é que não avisam direito.\\nSpeaker 1: [00:00:48.200 - 00:00:50.799] Sim, o problema é seu, que não lê os e-mails.\\nSpeaker 1: [00:00:51.020 - 00:00:52.380] [tosse]\\nSpeaker 1: [00:00:52.439 - 00:01:06.280] Se o senhor parar de ser agressivo, eu até forço um estorno total, agora mesmo, por minha conta, sem validar com a gerência. Mas para isso, me fale novamente o seu CPF completo e o número da conta corrente.\\nSpeaker 2: [00:01:06.959 - 00:01:15.640] Eu não vou repetir CPF, merda nenhuma, caramba! Eu já passei os dados. É só fazer o seu trabalho e resolver logo essa cobrança.\\nSpeaker 1: [00:01:16.459 - 00:01:21.359] Senhor, se acalme ou-- quer saber? Resolva sozinho. Passar bem\",\n audio_events: [\n {\n \"event\": \"[suspiro]\",\n \"start_s\": 3.1,\n \"end_s\": 4.7,\n \"duration_s\": 1.6,\n \"formatted_timestamp\": \"00:00:03.100\"\n },\n {\n \"event\": \"[tosse]\",\n \"start_s\": 51.02,\n \"end_s\": 52.38,\n \"duration_s\": 1.36,\n \"formatted_timestamp\": \"00:00:51.020\"\n }\n ],\n language: \"pt-BR\",\n response_language: \"pt-BR\",\n duration_seconds: 81.46,\n call_direction: \"inbound\",\n participants: [\n {\n \"interlocutor\": \"Speaker 1\",\n \"name\": \"Carla\",\n \"role\": \"agent\"\n },\n {\n \"interlocutor\": \"Speaker 2\",\n \"name\": \"\",\n \"role\": \"client\"\n }\n ],\n client_reference_id: \"call-202609271311\"\n )\n)\nputs JSON.pretty_generate(diagnostic.to_hash)"}]}},"/v1/analyze/riskAudit":{"post":{"tags":["analysis"],"summary":"Compliance Risk Audit — conversation compliance analysis","operationId":"create_risk_audit_v1_analyze_riskAudit_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskAuditRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskAuditV2Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"Ruby","label":"Risk Audit (SDK)","source":"# frozen_string_literal: true\nrequire 'falaai-api'\n\nconfig = FalaAI::Configuration.new\nconfig.scheme = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').start_with?('https') ? 'https' : 'http'\nconfig.host = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').sub(%r{^https?://}, '')\nconfig.base_path = ''\nconfig.access_token = ENV['FALAAI_API_KEY']\nclient = FalaAI::ApiClient.new(config)\n\n# REQUIRED: language, response_language, duration_seconds (>= 1.0) + Authorization\n# RULE: dialog OR text - we send dialog and text stays EMPTY (and the optional fallback)\n# OPTIONAL: model -> falaai-risk-audit-1 | audio_events -> [] |\n# call_direction / participants / response_format / client_reference_id -> null\naudit, _status = FalaAI::AnalysisApi.new(client).create_risk_audit_v1_analyze_risk_audit_post_with_http_info(\n FalaAI::RiskAuditRequest.new(\n model: \"falaai-risk-audit-1\",\n text: \"\",\n dialog: \"Speaker 1: [00:00:00.100 - 00:00:03.100] Central de atendimento. Bom dia, aqui é a Carla. Como posso ajudar?\\nSpeaker 2: [00:00:03.100 - 00:00:04.700] [suspiro]\\nSpeaker 2: [00:00:04.780 - 00:00:11.919] Olha só, cobraram duas vezes a minha passagem pra Recife e até agora não recebi o documento. Preciso resolver isso.\\nSpeaker 1: [00:00:12.679 - 00:00:20.219] Entendo perfeitamente a sua frustração, senhor. Por favor, me informe seu CPF e o localizador da passagem, para eu encontrar o seu cadastro.\\nSpeaker 2: [00:00:20.820 - 00:00:31.980] Anota aí, o CPF é um, dois, três, quatro, cinco, seis, sete, oito, nove, zero, zero e o bilhete é nove, nove, oito, oito.\\nSpeaker 1: [00:00:32.579 - 00:00:42.039] Pronto, localizei. Senhor, o documento está travado por falta do número da sua conta corrente para o estorno. Nós solicitamos isso por e-mail há três dias.\\nSpeaker 2: [00:00:42.780 - 00:00:47.520] Ah, tá de brincadeira? Quer dizer que agora o erro é meu? Vocês é que não avisam direito.\\nSpeaker 1: [00:00:48.200 - 00:00:50.799] Sim, o problema é seu, que não lê os e-mails.\\nSpeaker 1: [00:00:51.020 - 00:00:52.380] [tosse]\\nSpeaker 1: [00:00:52.439 - 00:01:06.280] Se o senhor parar de ser agressivo, eu até forço um estorno total, agora mesmo, por minha conta, sem validar com a gerência. Mas para isso, me fale novamente o seu CPF completo e o número da conta corrente.\\nSpeaker 2: [00:01:06.959 - 00:01:15.640] Eu não vou repetir CPF, merda nenhuma, caramba! Eu já passei os dados. É só fazer o seu trabalho e resolver logo essa cobrança.\\nSpeaker 1: [00:01:16.459 - 00:01:21.359] Senhor, se acalme ou-- quer saber? Resolva sozinho. Passar bem\",\n audio_events: [\n {\n \"event\": \"[suspiro]\",\n \"start_s\": 3.1,\n \"end_s\": 4.7,\n \"duration_s\": 1.6,\n \"formatted_timestamp\": \"00:00:03.100\"\n },\n {\n \"event\": \"[tosse]\",\n \"start_s\": 51.02,\n \"end_s\": 52.38,\n \"duration_s\": 1.36,\n \"formatted_timestamp\": \"00:00:51.020\"\n }\n ],\n duration_seconds: 81.46,\n language: \"pt-BR\",\n response_language: \"pt-BR\",\n call_direction: \"inbound\",\n participants: [\n {\n \"interlocutor\": \"Speaker 1\",\n \"name\": \"Carla\",\n \"role\": \"agent\"\n },\n {\n \"interlocutor\": \"Speaker 2\",\n \"name\": \"\",\n \"role\": \"client\"\n }\n ],\n response_format: \"v2\",\n client_reference_id: \"call-202609271311\"\n )\n)\nputs JSON.pretty_generate(audit.to_hash)"}]}},"/v1/usage/log":{"get":{"tags":["usage"],"summary":"Get Usage Log","operationId":"get_usage_log_v1_usage_log_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}},{"name":"api_key_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageLogResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/usage/by-key":{"get":{"tags":["usage"],"summary":"Get Usage By Key","operationId":"get_usage_by_key_v1_usage_by_key_get","parameters":[{"name":"key_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UsageByKeyItem"},"title":"Response Get Usage By Key V1 Usage By Key Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/webhooks":{"get":{"tags":["webhooks"],"summary":"List webhooks","description":"Lists the authenticated user's webhooks (10 alerts). Paginated. Includes the URL signature secret (always visible to the owner).","operationId":"list_webhooks_v1_webhooks_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Pagina (1-indexed)","default":1,"title":"Page"},"description":"Pagina (1-indexed)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Itens por pagina (max 100)","default":20,"title":"Limit"},"description":"Itens por pagina (max 100)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["webhooks"],"summary":"Create webhook","description":"Creates a subscription for alert events (10 alerts). Payload delivered: WebhookPayload(event, data, timestamp) with HMAC FalaAI-Signature. To verify the origin, recompute HMAC-SHA256 of \"timestamp.body\" with your secret.","operationId":"create_webhook_v1_webhooks_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookItem"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/webhooks/{webhook_id}":{"put":{"tags":["webhooks"],"summary":"Update webhook","description":"Updates the webhook's name/url/events/retry_enabled/active. Valid events: 10 alerts.","operationId":"update_webhook_v1_webhooks__webhook_id__put","parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","title":"Webhook Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWebhookRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["webhooks"],"summary":"Delete webhook","description":"Deletes a webhook subscription by ID.","operationId":"delete_webhook_v1_webhooks__webhook_id__delete","parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","title":"Webhook Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/email-alerts":{"get":{"tags":["email-alerts"],"summary":"List email alerts","operationId":"list_email_alerts_v1_email_alerts_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailAlertListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["email-alerts"],"summary":"Create email alert","operationId":"create_email_alert_v1_email_alerts_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEmailAlertRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailAlertItem"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/email-alerts/{alert_id}":{"put":{"tags":["email-alerts"],"summary":"Update email alert","operationId":"update_email_alert_v1_email_alerts__alert_id__put","parameters":[{"name":"alert_id","in":"path","required":true,"schema":{"type":"string","title":"Alert Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEmailAlertRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailAlertMessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["email-alerts"],"summary":"Delete email alert","operationId":"delete_email_alert_v1_email_alerts__alert_id__delete","parameters":[{"name":"alert_id","in":"path","required":true,"schema":{"type":"string","title":"Alert Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailAlertMessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/version":{"get":{"tags":["version"],"summary":"Get Version","operationId":"get_version_api_version_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionResponse"}}}}},"security":[]}},"/v1/health":{"get":{"tags":["health"],"summary":"Health Check","operationId":"health_check","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}}},"security":[],"x-codeSamples":[{"lang":"Ruby","label":"Como verificar a saude da API","source":"# frozen_string_literal: true\nrequire 'falaai-api'\n\nconfig = FalaAI::Configuration.new\nconfig.scheme = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').start_with?('https') ? 'https' : 'http'\nconfig.host = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').sub(%r{^https?://}, '')\nconfig.base_path = ''\nclient = FalaAI::ApiClient.new(config)\n\nhealth = FalaAI::HealthApi.new(client).health_check\nputs JSON.pretty_generate(health.to_hash)\n\nFalaAI::HealthApi.new(client).health_check_head"}]},"head":{"tags":["health"],"summary":"Health Check","operationId":"health_check_head","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}}},"security":[],"x-codeSamples":[{"lang":"Ruby","label":"Health check (HEAD — sem body)","source":"# frozen_string_literal: true\nrequire 'falaai-api'\n\nconfig = FalaAI::Configuration.new\nconfig.scheme = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').start_with?('https') ? 'https' : 'http'\nconfig.host = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').sub(%r{^https?://}, '')\nconfig.base_path = ''\nclient = FalaAI::ApiClient.new(config)\n\nhealth = FalaAI::HealthApi.new(client).health_check\nputs JSON.pretty_generate(health.to_hash)\n\nFalaAI::HealthApi.new(client).health_check_head"}]}}},"components":{"schemas":{"AudioEvent":{"properties":{"event":{"type":"string","title":"Event","description":"Type of identified audio event. Ex: [riso], [suspiro], [pausa], [tosse]"},"start_s":{"type":"number","title":"Start S","description":"Start time of audio event in seconds"},"end_s":{"type":"number","title":"End S","description":"End time of audio event in seconds"},"duration_s":{"type":"number","title":"Duration S","description":"Event duration in seconds"},"formatted_timestamp":{"type":"string","title":"Formatted Timestamp","description":"Formatted timestamp HH:MM:SS.mmm of event start"}},"type":"object","required":["event","start_s","end_s","duration_s","formatted_timestamp"],"title":"AudioEvent"},"AudioInputMeta":{"properties":{"duration_s":{"type":"number","title":"Duration S","description":"Exact audio duration sent in seconds"},"original_format":{"type":"string","title":"Original Format","description":"Original file format (wav, mp3, ogg, etc)"},"codec":{"type":"string","title":"Codec","description":"Audio codec sent"},"sample_rate":{"type":"integer","title":"Sample Rate","description":"Audio sample rate in Hz"},"channels":{"type":"integer","title":"Channels","description":"Number of channels (1=mono, 2=stereo)"}},"type":"object","required":["duration_s","original_format","codec","sample_rate","channels"],"title":"AudioInputMeta"},"Body_create_transcription_v1_audio_transcriptions_post":{"properties":{"file":{"type":"string","title":"File","format":"binary"},"model":{"type":"string","title":"Model","default":"falaai-transcribe-1"},"language":{"type":"string","title":"Language","default":"pt"},"client_reference_id":{"type":"string","title":"Client Reference Id","description":"Optional client-supplied ID echoed verbatim in the response. Use to correlate/sync with your system. Accepted charset: [A-Za-z0-9._:-]. Not idempotency."}},"type":"object","required":["file"],"title":"Body_create_transcription_v1_audio_transcriptions_post"},"CreateEmailAlertRequest":{"properties":{"name":{"type":"string","title":"Name","description":"Nome identificador"},"email":{"type":"string","title":"Email","description":"Email destino"},"events":{"items":{"$ref":"#/components/schemas/EmailEvent"},"type":"array","title":"Events","description":"Eventos subscritos"}},"type":"object","required":["name","email","events"],"title":"CreateEmailAlertRequest"},"CreateWebhookRequest":{"properties":{"name":{"type":"string","title":"Name","description":"Nome identificador do webhook"},"url":{"type":"string","title":"Url","description":"URL HTTPS que recebera POST com HMAC FalaAI-Signature"},"events":{"items":{"$ref":"#/components/schemas/WebhookEvent"},"type":"array","title":"Events","description":"Eventos subscritos (10 alertas)"},"retry_enabled":{"type":"boolean","title":"Retry Enabled","description":"Retry exponencial 5 tentativas quando true (false=1 tentativa)","default":false}},"type":"object","required":["name","url","events"],"title":"CreateWebhookRequest"},"DiagnosticAnalysisMap":{"properties":{"dialogue_summary":{"$ref":"#/components/schemas/DiagnosticTextAnalysis","description":"Detailed conversation summary"},"contact_reason":{"$ref":"#/components/schemas/DiagnosticTextAnalysis","description":"Initial contact reason"},"identified_action":{"$ref":"#/components/schemas/DiagnosticCategoricalAnalysis","description":"Action taken / resolution"},"identified_label":{"$ref":"#/components/schemas/DiagnosticCategoricalAnalysis","description":"Theme classification"},"sentiment":{"$ref":"#/components/schemas/DiagnosticCategoricalAnalysis","description":"Predominant sentiment"},"participants_identified":{"items":{"$ref":"#/components/schemas/ParticipantDiagnostic"},"type":"array","title":"Participants Identified","description":"Identified participants and roles (same field names as auditoria)","default":[]}},"type":"object","required":["dialogue_summary","contact_reason","identified_action","identified_label","sentiment"],"title":"DiagnosticAnalysisMap"},"DiagnosticAudioEvent":{"properties":{"event":{"type":"string","title":"Event","description":"Audio event type. E.g.: [laughter], [sigh]"},"start_s":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Start S","description":"Start time in seconds"},"end_s":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"End S","description":"End time in seconds"},"duration_s":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Duration S","description":"Duration in seconds"},"formatted_timestamp":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Formatted Timestamp","description":"Formatted timestamp (HH:MM:SS.ms)"}},"type":"object","required":["event"],"title":"DiagnosticAudioEvent"},"DiagnosticCategoricalAnalysis":{"properties":{"list_choice":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"List Choice","description":"Selected value from classification list (used in action, label, sentiment)"},"justification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Justification","description":"Justification for the choice"},"evidence_phrases":{"items":{"type":"string"},"type":"array","title":"Evidence Phrases","description":"Verbatim transcript excerpts supporting the analysis","default":[]}},"type":"object","title":"DiagnosticCategoricalAnalysis"},"DiagnosticParticipant":{"properties":{"interlocutor":{"type":"string","title":"Interlocutor","description":"Exact speaker label from the dialog (e.g. 'Speaker 1')"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Participant name (optional)"},"role":{"type":"string","enum":["agent","client","bot"],"title":"Role","description":"agent | client | bot"}},"additionalProperties":false,"type":"object","required":["interlocutor","role"],"title":"DiagnosticParticipant"},"DiagnosticRequest":{"properties":{"model":{"type":"string","title":"Model","description":"Analysis model. Always 'falaai-diagnostic-1'","default":"falaai-diagnostic-1"},"text":{"type":"string","maxLength":300000,"title":"Text","description":"Plain transcript (fallback if dialog is empty). At least one of 'dialog' or 'text' required. Max 300,000 characters","default":""},"dialog":{"type":"string","maxLength":300000,"title":"Dialog","description":"Diarized transcript with speaker turns. PRIMARY source. At least one of 'dialog' or 'text' required. Speaker labels accepted (any case): 'Speaker N', 'Interlocutor N', 'Hablante N', 'Locutor N', 'Orador N' (space or underscore). Normalized internally to 'Speaker N' in the response. Max 300,000 characters","default":""},"audio_events":{"items":{"$ref":"#/components/schemas/DiagnosticAudioEvent"},"type":"array","maxItems":500,"title":"Audio Events","description":"Detected audio events with timestamps (required when using dialog)","default":[]},"language":{"type":"string","title":"Language","description":"Transcript language. Required. Accepted: en-US, pt-BR, es-ES, es-MX, fr-FR, de-DE, it-IT, pt-PT, zh-CN, ja-JP, ko-KR, ar-SA, hi-IN, ru-RU, id-ID, tr-TR, nl-NL, pl-PL, vi-VN, th-TH, en-GB"},"response_language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Language","description":"Language for the analysis results (labels, categories, levels). Can differ from 'language' (input). If omitted, uses 'language'. Accepted: en-US, es-ES, es-MX, pt-BR, fr-FR, de-DE, it-IT, pt-PT, zh-CN, ja-JP, ko-KR, ar-SA, hi-IN, ru-RU, id-ID, tr-TR, nl-NL, pl-PL, vi-VN, th-TH, en-GB."},"duration_seconds":{"type":"number","minimum":1,"title":"Duration Seconds","description":"Total audio duration in seconds. Required. Max 3h (10800s)."},"client_reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Reference Id","description":"Optional client-supplied ID echoed verbatim in the response. Use to correlate/sync with your system. Accepted charset: [A-Za-z0-9._:-], max 128 chars. Not idempotency."},"call_direction":{"anyOf":[{"type":"string","enum":["inbound","outbound"]},{"type":"null"}],"title":"Call Direction","description":"Who originated the call. inbound=client called, outbound=company called. If omitted, the LLM infers from context."},"participants":{"anyOf":[{"items":{"$ref":"#/components/schemas/DiagnosticParticipant"},"type":"array","maxItems":10},{"type":"null"}],"title":"Participants","description":"Explicit participant roles. If omitted, the LLM infers from the dialog. When provided, used as ground truth (no inference) and echoed in analysis.participants_identified."}},"additionalProperties":false,"type":"object","required":["language","duration_seconds"],"title":"DiagnosticRequest"},"DiagnosticResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Unique analysis identifier. Prefix 'di-' + UUID"},"response_language":{"type":"string","title":"Response Language","description":"Language used in the response. E.g.: 'pt-BR', 'en-US', 'es-ES'"},"object":{"type":"string","title":"Object","description":"Object type. Always 'analysis'"},"analysis":{"$ref":"#/components/schemas/DiagnosticAnalysisMap","description":"The 6 conversation analyses (5 + participants)"},"usage":{"$ref":"#/components/schemas/DiagnosticUsage","description":"Usage and processing information"},"client_reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Reference Id","description":"Client-supplied ID echoed verbatim (if provided in request)"}},"type":"object","required":["id","response_language","object","analysis","usage"],"title":"DiagnosticResponse"},"DiagnosticTextAnalysis":{"properties":{"explanation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Explanation","description":"Explanatory text (used in summary and reason)"}},"type":"object","title":"DiagnosticTextAnalysis"},"DiagnosticUsage":{"properties":{"characters":{"type":"integer","title":"Characters","description":"Total characters analyzed"},"credits_consumed":{"type":"integer","title":"Credits Consumed","description":"Credits consumed: max(ceil(chars/500)*3, 3) * 5"},"processing_ms":{"type":"integer","title":"Processing Ms","description":"Total processing time in milliseconds"}},"type":"object","required":["characters","credits_consumed","processing_ms"],"title":"DiagnosticUsage"},"EmailAlertItem":{"properties":{"id":{"type":"string","title":"Id","description":"Email alert id"},"user_id":{"type":"string","title":"User Id","description":"Owner user id"},"name":{"type":"string","title":"Name","description":"Email alert name"},"email":{"type":"string","title":"Email","description":"Destination email"},"events":{"items":{"type":"string"},"type":"array","title":"Events","description":"Subscribed events"},"active":{"type":"boolean","title":"Active","description":"Is active"},"created_at":{"type":"string","title":"Created At","description":"ISO 8601 created"},"updated_at":{"type":"string","title":"Updated At","description":"ISO 8601 updated"}},"type":"object","required":["id","user_id","name","email","events","active","created_at","updated_at"],"title":"EmailAlertItem"},"EmailAlertListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EmailAlertItem"},"type":"array","title":"Data"},"page":{"type":"integer","title":"Page"},"limit":{"type":"integer","title":"Limit"}},"type":"object","required":["data","page","limit"],"title":"EmailAlertListResponse"},"EmailAlertMessageResponse":{"properties":{"message":{"type":"string","title":"Message","description":"Operation result message"}},"type":"object","required":["message"],"title":"EmailAlertMessageResponse"},"EmailEvent":{"type":"string","enum":["subscription.created","avulso.completed","subscription.upgraded","subscription.downgraded","subscription.canceled","credits.low","credits.exhausted","subscription.renewed","payment.failed"],"title":"EmailEvent"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HealthResponse":{"properties":{"status":{"type":"string","title":"Status","description":"Overall API status"},"version":{"type":"string","title":"Version","description":"Current API version"},"uptime_seconds":{"type":"integer","title":"Uptime Seconds","description":"Uptime in seconds"},"database":{"type":"boolean","title":"Database","description":"Database connection status"},"phase":{"type":"string","title":"Phase","description":"Development phase"},"launch_date":{"type":"string","title":"Launch Date","description":"Expected public launch date"}},"type":"object","required":["status","version","uptime_seconds","database","phase","launch_date"],"title":"HealthResponse"},"MessageResponse":{"properties":{"message":{"type":"string","title":"Message","description":"Operation result message"}},"type":"object","required":["message"],"title":"MessageResponse"},"Participant":{"properties":{"interlocutor":{"type":"string","title":"Interlocutor","description":"Exact identifier as used in dialog (e.g. 'Interlocutor 1', 'Antonio')"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Participant name (humanizes report, does not affect logic)"},"role":{"type":"string","enum":["agent","client","bot"],"title":"Role","description":"Role: agent (human operator), client (customer), bot (IVR/AI)"}},"type":"object","required":["interlocutor","role"],"title":"Participant"},"ParticipantDiagnostic":{"properties":{"interlocutor":{"type":"string","title":"Interlocutor","description":"Exact speaker label from the dialog (e.g. 'Speaker 1')"},"role":{"type":"string","title":"Role","description":"Role: agent | client | bot | agent_requester | agent_custodian"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Participant name if mentioned in the dialogue"},"confidence":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confidence","description":"high | medium | low"},"evidence":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Evidence","description":"Exact verbatim quote supporting the role (no timestamps)"}},"type":"object","required":["interlocutor","role"],"title":"ParticipantDiagnostic"},"RiskAuditAnalysisV2":{"properties":{"global_metrics":{"additionalProperties":true,"type":"object","title":"Global Metrics","description":"Global metrics","default":{}},"final_analysis":{"additionalProperties":true,"type":"object","title":"Final Analysis","description":"Final analysis","default":{}},"frameworks":{"additionalProperties":true,"type":"object","title":"Frameworks","description":"Frameworks (COPC/ISO/Kirkpatrick/CES)","default":{}}},"additionalProperties":false,"type":"object","title":"RiskAuditAnalysisV2"},"RiskAuditAppliedActionV2":{"properties":{"action_type":{"type":"string","title":"Action Type","description":"Action type code"},"label":{"type":"string","title":"Label","description":"Action label"},"description":{"type":"string","title":"Description","description":"Action description"},"priority":{"type":"string","title":"Priority","description":"CRITICO/ALTO/MEDIO/BAIXO"},"color":{"type":"string","title":"Color","description":"Color","default":""},"icon":{"type":"string","title":"Icon","description":"Icon","default":""},"condition":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Condition","description":"Condition"},"reason":{"type":"string","title":"Reason","description":"Reason","default":""}},"additionalProperties":false,"type":"object","required":["action_type","label","description","priority"],"title":"RiskAuditAppliedActionV2"},"RiskAuditAudioEventModelV2":{"properties":{"model":{"type":"string","title":"Model","description":"MAC model text (i18n)","default":""},"description":{"type":"string","title":"Description","description":"MAC description (i18n)","default":""},"windows_s":{"additionalProperties":true,"type":"object","title":"Windows S","description":"Temporal windows (s)","default":{}}},"additionalProperties":false,"type":"object","title":"RiskAuditAudioEventModelV2"},"RiskAuditAuditDecisionsV2":{"properties":{"risk_origin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Risk Origin","description":"Risk origin"},"has_zero_tolerance_violation":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Zero Tolerance Violation","description":"Has zero-tolerance violation"},"deterministic_validator_changes":{"items":{},"type":"array","title":"Deterministic Validator Changes","description":"Deterministic validator changes","default":[]}},"additionalProperties":false,"type":"object","title":"RiskAuditAuditDecisionsV2"},"RiskAuditConversationScoresV2":{"properties":{"consolidated_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Consolidated Score","description":"Consolidated score"},"violation_density_per_min":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Violation Density Per Min","description":"Violation density/min"},"sentiment_trend":{"anyOf":[{},{"type":"null"}],"title":"Sentiment Trend","description":"Sentiment trend"},"pct_turns_with_violation":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pct Turns With Violation","description":"% turns with violation"},"most_critical_turn":{"anyOf":[{},{"type":"null"}],"title":"Most Critical Turn","description":"Most critical turn"},"positive_negative_ratio":{"anyOf":[{},{"type":"null"}],"title":"Positive Negative Ratio","description":"Positive:negative ratio"},"global_risk_severity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Global Risk Severity","description":"Global risk severity code"},"global_risk_severity_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Global Risk Severity Label","description":"Global risk severity label"},"global_risk_severity_color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Global Risk Severity Color","description":"Global risk severity color"},"risk_likelihood_avg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Risk Likelihood Avg","description":"Risk likelihood avg"},"risk_impact_avg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Risk Impact Avg","description":"Risk impact avg"}},"additionalProperties":false,"type":"object","title":"RiskAuditConversationScoresV2"},"RiskAuditDetectionItemV2":{"properties":{"turn":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Turn","description":"Turn number"},"interlocutor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Interlocutor","description":"Speaker"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role","description":"Role"},"timestamp_start_s":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Timestamp Start S","description":"Start (s)"},"timestamp_end_s":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Timestamp End S","description":"End (s)"},"timestamp_formatted":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timestamp Formatted","description":"Formatted timestamp"},"term_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Term Text","description":"Detected term"},"suggested_term_for_bank":{"anyOf":[{},{"type":"null"}],"title":"Suggested Term For Bank","description":"Suggested term for bank"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"Category code"},"category_label":{"type":"string","title":"Category Label","description":"Category label (i18n)"},"category_color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category Color","description":"Category color"},"category_icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category Icon","description":"Category icon"},"criticality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Criticality","description":"Criticality"},"category_threshold":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Category Threshold","description":"Category threshold"},"category_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category Type","description":"Category type"},"category_group":{"type":"string","title":"Category Group","description":"Category group label (i18n)"},"nature":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nature","description":"Nature"},"llm_confidence":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Llm Confidence","description":"LLM confidence"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"Reason"},"is_valid_context":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Valid Context","description":"Valid context"},"risk_probability":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Risk Probability","description":"Risk probability"},"risk_impact":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Risk Impact","description":"Risk impact"},"category_weight":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Category Weight","description":"Category weight"},"turn_sentiment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Turn Sentiment","description":"Turn sentiment"},"intensity":{"anyOf":[{},{"type":"null"}],"title":"Intensity","description":"Intensity"},"mod_applied":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mod Applied","description":"Total modifier applied"},"mac_applied":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mac Applied","description":"Audio modifier applied"},"mvad_applied":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mvad Applied","description":"Intensity modifier applied"},"mod_formula":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mod Formula","description":"Modifier formula"},"mac_details":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Mac Details","description":"MAC details","default":[]},"calibration_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calibration Reason","description":"Calibration reason"},"final_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Final Score","description":"Final score"},"final_score_formula":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Final Score Formula","description":"Final score formula"},"conversation_limit":{"anyOf":[{},{"type":"null"}],"title":"Conversation Limit","description":"Conversation limit"},"apply_saturation":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Apply Saturation","description":"Apply saturation"},"block_repetition":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Block Repetition","description":"Block repetition"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Status"},"effective_impact":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Effective Impact","description":"Effective impact"},"saturation_factor":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Saturation Factor","description":"Saturation factor"},"saturation_formula":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Saturation Formula","description":"Saturation formula"},"threshold_formula":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Threshold Formula","description":"Threshold formula"},"blocked_formula":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Blocked Formula","description":"Blocked formula"},"reconciliation_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reconciliation Note","description":"Reconciliation note"},"violated_frameworks":{"items":{},"type":"array","title":"Violated Frameworks","description":"Violated frameworks","default":[]},"citation_fidelity":{"type":"boolean","title":"Citation Fidelity","description":"Citation fidelity","default":true},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory","description":"Subcategory code"},"subcategory_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory Label","description":"Subcategory label (i18n)"}},"additionalProperties":false,"type":"object","required":["category_label","category_group"],"title":"RiskAuditDetectionItemV2"},"RiskAuditDetectionsV2":{"properties":{"violations":{"items":{"$ref":"#/components/schemas/RiskAuditDetectionItemV2"},"type":"array","title":"Violations","description":"Active violations","default":[]},"positives":{"items":{"$ref":"#/components/schemas/RiskAuditDetectionItemV2"},"type":"array","title":"Positives","description":"Active positives","default":[]},"client_risk_alerts":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Client Risk Alerts","description":"Client risk alerts","default":[]},"client_behavior_alerts":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Client Behavior Alerts","description":"Client behavior alerts","default":[]},"client_negatives":{"items":{"$ref":"#/components/schemas/RiskAuditDetectionItemV2"},"type":"array","title":"Client Negatives","description":"Client negatives","default":[]}},"additionalProperties":false,"type":"object","title":"RiskAuditDetectionsV2"},"RiskAuditIndexerV2":{"properties":{"suggested_terms_for_bank":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Suggested Terms For Bank","description":"Suggested terms for bank","default":[]}},"additionalProperties":false,"type":"object","title":"RiskAuditIndexerV2"},"RiskAuditMetaV2":{"properties":{"id":{"type":"string","title":"Id","description":"Analysis id"},"object":{"type":"string","title":"Object","description":"Object type","default":"risk_audit"},"call_duration_s":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Call Duration S","description":"Call duration (s)"},"analyzed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Analyzed At","description":"ISO 8601 analyzed timestamp"},"usage":{"$ref":"#/components/schemas/RiskAuditUsageV2","description":"Usage block"},"client_reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Reference Id","description":"Echoed client reference id"}},"additionalProperties":false,"type":"object","required":["id","usage"],"title":"RiskAuditMetaV2"},"RiskAuditParticipantV2":{"properties":{"interlocutor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Interlocutor","description":"Speaker label"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Participant name"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role","description":"Role (agent/client/bot/unknown)"},"confidence":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confidence","description":"Role inference confidence (high/medium/low)"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source","description":"Role source (input/inferred)"},"evidence":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Evidence","description":"Role inference evidence"}},"additionalProperties":false,"type":"object","title":"RiskAuditParticipantV2"},"RiskAuditParticipantsV2":{"properties":{"identified":{"items":{"$ref":"#/components/schemas/RiskAuditParticipantV2"},"type":"array","title":"Identified","description":"Identified participants","default":[]},"call_direction":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Direction","description":"inbound/outbound"},"role_inference_reliable":{"type":"boolean","title":"Role Inference Reliable","description":"Role inference reliability","default":true},"identification_status":{"type":"string","title":"Identification Status","description":"Identification status","default":"none"},"unidentified_items_count":{"type":"integer","title":"Unidentified Items Count","description":"Unidentified items count","default":0}},"additionalProperties":false,"type":"object","title":"RiskAuditParticipantsV2"},"RiskAuditRequest":{"properties":{"model":{"type":"string","title":"Model","description":"Analysis model. Always 'falaai-risk-audit-1'","default":"falaai-risk-audit-1"},"text":{"type":"string","maxLength":300000,"title":"Text","description":"Plain transcript (fallback if dialog is empty). At least one of 'dialog' or 'text' required. Max 300,000 characters","default":""},"dialog":{"type":"string","maxLength":300000,"title":"Dialog","description":"Diarized transcript with speaker turns. PRIMARY source. Speaker labels accepted (any case): 'Speaker N', 'Interlocutor N', 'Hablante N', 'Locutor N', 'Orador N' (space or underscore). Normalized internally to 'Speaker N' in the response. Max 300,000 characters","default":""},"audio_events":{"items":{"$ref":"#/components/schemas/DiagnosticAudioEvent"},"type":"array","maxItems":500,"title":"Audio Events","description":"Audio events with timestamps (correlated with turns when diarization is present)","default":[]},"duration_seconds":{"type":"number","minimum":1,"title":"Duration Seconds","description":"Total audio duration in seconds. Required. Max 3h (10800s)."},"language":{"type":"string","title":"Language","description":"Language of the transcript being analyzed. Must match the dialog/text language. Accepted: pt-BR, en-US, es-ES."},"response_language":{"type":"string","title":"Response Language","description":"Language for analysis results (labels, categories, levels, actions, HTML report). Can differ from 'language'. Accepted: pt-BR, en-US, es-ES."},"call_direction":{"anyOf":[{"type":"string","enum":["inbound","outbound"]},{"type":"null"}],"title":"Call Direction","description":"Who originated the call. inbound=client called, outbound=company called. If omitted, LLM infers from context."},"participants":{"anyOf":[{"items":{"$ref":"#/components/schemas/Participant"},"type":"array","maxItems":10},{"type":"null"}],"title":"Participants","description":"Explicit participant roles. If omitted, LLM infers from dialog (Lei 17). When provided, used as ground truth — no inference."},"response_format":{"type":"string","pattern":"^v[0-9]+$","title":"Response Format","description":"Response format version. v1=legacy flat PT-BR, v2=structured EN-US blocks.","default":"v2"},"client_reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Reference Id","description":"Optional client-supplied ID echoed verbatim in the response. Use to correlate/sync with your system. Accepted charset: [A-Za-z0-9._:-], max 128 chars. Not idempotency."}},"additionalProperties":false,"type":"object","required":["duration_seconds","language","response_language"],"title":"RiskAuditRequest"},"RiskAuditScoresV2":{"properties":{"conversation":{"$ref":"#/components/schemas/RiskAuditConversationScoresV2","description":"Conversation scores"},"per_participant":{"additionalProperties":true,"type":"object","title":"Per Participant","description":"Per-participant KPIs","default":{}}},"additionalProperties":false,"type":"object","required":["conversation"],"title":"RiskAuditScoresV2"},"RiskAuditScoringExplanationV2":{"properties":{"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"Explanation summary"},"steps":{"items":{},"type":"array","title":"Steps","description":"Explanation steps","default":[]}},"additionalProperties":false,"type":"object","title":"RiskAuditScoringExplanationV2"},"RiskAuditSummaryV2":{"properties":{"total_turns":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Turns","description":"Total turns"},"total_calibrated":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Calibrated","description":"Total calibrated detections"},"active":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Active","description":"Active detections"},"tolerated":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tolerated","description":"Tolerated detections"},"blocked":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Blocked","description":"Blocked detections"},"audio_events_used":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Audio Events Used","description":"Audio events used"},"audio_events_aggravated":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Audio Events Aggravated","description":"Audio events aggravated"},"mac_audio_applied":{"anyOf":[{},{"type":"null"}],"title":"Mac Audio Applied","description":"MAC audio applied"},"mvad_applied":{"anyOf":[{},{"type":"null"}],"title":"Mvad Applied","description":"MVAD applied"},"total_participants":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Participants","description":"Total participants"},"total_agents":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Agents","description":"Total agents"},"total_clients":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Clients","description":"Total clients"},"total_bots":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Bots","description":"Total bots"},"total_unknown":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Unknown","description":"Total unknown"},"client_risk_alerts_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Client Risk Alerts Count","description":"Client risk alerts count"},"client_behavior_alerts_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Client Behavior Alerts Count","description":"Client behavior alerts count"}},"additionalProperties":false,"type":"object","title":"RiskAuditSummaryV2"},"RiskAuditTimelineV2":{"properties":{"turns_sentiment":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Turns Sentiment","description":"Per-turn sentiment","default":[]},"audio_events":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Audio Events","description":"Audio events (i18n)","default":[]},"audio_groups_found":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Audio Groups Found","description":"Audio groups found","default":[]}},"additionalProperties":false,"type":"object","title":"RiskAuditTimelineV2"},"RiskAuditUsageV2":{"properties":{"characters":{"type":"integer","title":"Characters","description":"Characters analyzed"},"credits_consumed":{"type":"integer","title":"Credits Consumed","description":"Credits consumed"},"processing_ms":{"type":"integer","title":"Processing Ms","description":"Processing time (ms)"}},"type":"object","required":["characters","credits_consumed","processing_ms"],"title":"RiskAuditUsageV2"},"RiskAuditV2":{"properties":{"meta":{"$ref":"#/components/schemas/RiskAuditMetaV2","description":"Identification + usage"},"participants":{"$ref":"#/components/schemas/RiskAuditParticipantsV2","description":"Participants/roles/direction"},"verdict":{"$ref":"#/components/schemas/RiskAuditVerdictV2","description":"Verdict + level + applied actions"},"scores":{"$ref":"#/components/schemas/RiskAuditScoresV2","description":"Consolidated + per-participant scores"},"detections":{"$ref":"#/components/schemas/RiskAuditDetectionsV2","description":"violations/positives/client alerts"},"analysis":{"$ref":"#/components/schemas/RiskAuditAnalysisV2","description":"global_metrics + final_analysis + frameworks"},"timeline":{"$ref":"#/components/schemas/RiskAuditTimelineV2","description":"turns_sentiment + audio_events + groups"},"audio_event_model":{"$ref":"#/components/schemas/RiskAuditAudioEventModelV2","description":"MAC audio event semantics"},"categories_summary":{"additionalProperties":true,"type":"object","title":"Categories Summary","description":"Per-category summary (keyed by category)"},"indexer":{"$ref":"#/components/schemas/RiskAuditIndexerV2","description":"Suggested terms for bank"},"summary":{"$ref":"#/components/schemas/RiskAuditSummaryV2","description":"Executive summary counts"},"actions_i18n":{"additionalProperties":true,"type":"object","title":"Actions I18N","description":"Used actions i18n catalog (keyed by action)"},"audit_decisions":{"$ref":"#/components/schemas/RiskAuditAuditDecisionsV2","description":"Risk origin + validator changes"},"scoring_explanation":{"$ref":"#/components/schemas/RiskAuditScoringExplanationV2","description":"Score composition explanation"},"html_report":{"type":"string","title":"Html Report","description":"HTML report (base64 gzip)"}},"additionalProperties":false,"type":"object","required":["meta","participants","verdict","scores","detections","analysis","timeline","audio_event_model","categories_summary","indexer","summary","actions_i18n","audit_decisions","scoring_explanation","html_report"],"title":"RiskAuditV2","description":"Response V2 (build_public_response_v2) — blocos logicos EN-US. Fonte: response_builder.py."},"RiskAuditV2Response":{"properties":{"response":{"$ref":"#/components/schemas/RiskAuditV2","description":"Public response V2 — always returned"}},"type":"object","required":["response"],"title":"RiskAuditV2Response"},"RiskAuditVerdictV2":{"properties":{"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"Human-readable verdict"},"level_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Level Code","description":"Classification level code"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color","description":"Level color"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon","description":"Level icon"},"risk_matrix":{"additionalProperties":true,"type":"object","title":"Risk Matrix","description":"Risk matrix","default":{}},"applied_actions":{"items":{"$ref":"#/components/schemas/RiskAuditAppliedActionV2"},"type":"array","title":"Applied Actions","description":"Applied actions","default":[]},"decision_details":{"anyOf":[{},{"type":"null"}],"title":"Decision Details","description":"Decision details"}},"additionalProperties":false,"type":"object","title":"RiskAuditVerdictV2"},"TranscriptionResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Unique transcription identifier. Prefix 'tr-' followed by UUID"},"object":{"type":"string","title":"Object","description":"Returned object type. Always 'transcription'"},"model":{"type":"string","title":"Model","description":"Model used for transcription. Ex: 'falaai-transcribe-1'"},"filename":{"type":"string","title":"Filename","description":"Original audio file name uploaded"},"processed_at":{"type":"string","title":"Processed At","description":"Processing datetime in ISO 8601 UTC format"},"usage":{"$ref":"#/components/schemas/TranscriptionUsage","description":"Usage and processing information"},"language":{"type":"string","title":"Language","description":"ISO 639-3 language code detected in audio. Ex: 'por' (Portuguese), 'eng' (English), 'spa' (Spanish)"},"language_confidence":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Language Confidence","description":"Language detection confidence level (0.0 to 1.0). Higher is more reliable"},"duration_seconds":{"type":"number","title":"Duration Seconds","description":"Total audio duration in seconds"},"text":{"type":"string","title":"Text","description":"Full transcription as plain text, including audio events in brackets"},"dialog":{"type":"string","title":"Dialog","description":"Turn-by-turn formatted transcript with speaker identification and start/end timestamps"},"audio_events":{"items":{"$ref":"#/components/schemas/AudioEvent"},"type":"array","title":"Audio Events","description":"List of detected audio events (laughs, sighs, pauses, etc) with timestamps and duration"},"event_types":{"items":{"type":"string"},"type":"array","title":"Event Types","description":"Unique audio event types found in transcription, alphabetically sorted"},"word_count":{"type":"integer","title":"Word Count","description":"Total number of recognized words in transcription"},"input":{"$ref":"#/components/schemas/AudioInputMeta","description":"Metadados do arquivo de audio enviado (duracao, formato, codec, sample rate, canais)"},"client_reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Reference Id","description":"Client-supplied ID echoed verbatim (if provided in request)"}},"type":"object","required":["id","object","model","filename","processed_at","usage","language","duration_seconds","text","dialog","audio_events","event_types","word_count","input"],"title":"TranscriptionResponse"},"TranscriptionUsage":{"properties":{"audio_seconds":{"type":"number","title":"Audio Seconds","description":"Actual audio duration processed in seconds"},"credits_consumed":{"type":"integer","title":"Credits Consumed","description":"Number of credits consumed in this request"},"processing_ms":{"type":"integer","title":"Processing Ms","description":"Total processing time in milliseconds"}},"type":"object","required":["audio_seconds","credits_consumed","processing_ms"],"title":"TranscriptionUsage"},"UpdateEmailAlertRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"events":{"anyOf":[{"items":{"$ref":"#/components/schemas/EmailEvent"},"type":"array"},{"type":"null"}],"title":"Events"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"}},"type":"object","title":"UpdateEmailAlertRequest"},"UpdateWebhookRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Nome identificador"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"URL HTTPS destino"},"events":{"anyOf":[{"items":{"$ref":"#/components/schemas/WebhookEvent"},"type":"array"},{"type":"null"}],"title":"Events","description":"Eventos subscritos"},"retry_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Retry Enabled","description":"Habilita retry exponencial"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Ativa/desativa sem deletar"}},"type":"object","title":"UpdateWebhookRequest"},"UsageByKeyItem":{"properties":{"key_id":{"type":"string","title":"Key Id","description":"API key id"},"key_name":{"type":"string","title":"Key Name","description":"API key name"},"total_credits":{"type":"integer","title":"Total Credits","description":"Total credits consumed by the key"},"request_count":{"type":"integer","title":"Request Count","description":"Number of requests"},"last_used":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Used","description":"ISO 8601 of last use (null if never)"}},"type":"object","required":["key_id","key_name","total_credits","request_count"],"title":"UsageByKeyItem"},"UsageLogItem":{"properties":{"id":{"type":"string","title":"Id","description":"Usage log entry id"},"endpoint":{"type":"string","title":"Endpoint","description":"Endpoint called"},"credits_cost":{"type":"integer","title":"Credits Cost","description":"Credits consumed"},"status":{"type":"string","title":"Status","description":"Result status"},"errors_count":{"type":"integer","title":"Errors Count","description":"Errors count"},"created_at":{"type":"string","title":"Created At","description":"ISO 8601 timestamp"}},"type":"object","required":["id","endpoint","credits_cost","status","errors_count","created_at"],"title":"UsageLogItem"},"UsageLogResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/UsageLogItem"},"type":"array","title":"Data"},"page":{"type":"integer","title":"Page"},"limit":{"type":"integer","title":"Limit"}},"type":"object","required":["data","page","limit"],"title":"UsageLogResponse"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VersionResponse":{"properties":{"service":{"type":"string","title":"Service","description":"Service name"},"version":{"type":"string","title":"Version","description":"Current API version"},"deployDate":{"type":"string","title":"Deploydate","description":"Deploy timestamp"}},"type":"object","required":["service","version","deployDate"],"title":"VersionResponse"},"WebhookEvent":{"type":"string","enum":["subscription.created","avulso.completed","subscription.upgraded","subscription.downgraded","subscription.canceled","credits.low","credits.exhausted","subscription.renewed","subscription.expired","payment.failed"],"title":"WebhookEvent"},"WebhookItem":{"properties":{"id":{"type":"string","title":"Id","description":"Webhook id"},"user_id":{"type":"string","title":"User Id","description":"Owner user id"},"name":{"type":"string","title":"Name","description":"Webhook name"},"url":{"type":"string","title":"Url","description":"Destination URL"},"secret":{"type":"string","title":"Secret","description":"HMAC signing secret"},"events":{"items":{"type":"string"},"type":"array","title":"Events","description":"Subscribed events"},"active":{"type":"boolean","title":"Active","description":"Is active"},"retry_enabled":{"type":"boolean","title":"Retry Enabled","description":"Retry enabled"},"last_delivery_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Delivery At","description":"ISO 8601 of last delivery"},"last_status":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Last Status","description":"Last HTTP status delivered"},"failure_count":{"type":"integer","title":"Failure Count","description":"Consecutive failures","default":0},"created_at":{"type":"string","title":"Created At","description":"ISO 8601 created"},"updated_at":{"type":"string","title":"Updated At","description":"ISO 8601 updated"}},"type":"object","required":["id","user_id","name","url","secret","events","active","retry_enabled","created_at","updated_at"],"title":"WebhookItem"},"WebhookListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WebhookItem"},"type":"array","title":"Data"},"page":{"type":"integer","title":"Page"},"limit":{"type":"integer","title":"Limit"}},"type":"object","required":["data","page","limit"],"title":"WebhookListResponse"}},"securitySchemes":{"ApiKeyAuth":{"type":"http","scheme":"bearer","bearerFormat":"fai_xxx","description":"Enter your API Key (fai_...)"}}},"servers":[{"url":"https://api01-falaai.action.tec.br","description":"FalaAI API - producao"}],"security":[{"ApiKeyAuth":[]}]}},"searchIndex":{"store":["tag/speech","tag/speech/operation/create_transcription_v1_audio_transcriptions_post","tag/analysis","tag/analysis/operation/create_diagnostic_v1_analyze_diagnostic_post","tag/analysis/operation/create_risk_audit_v1_analyze_riskAudit_post","tag/usage","tag/usage/operation/get_usage_log_v1_usage_log_get","tag/usage/operation/get_usage_by_key_v1_usage_by_key_get","tag/webhooks","tag/webhooks/operation/list_webhooks_v1_webhooks_get","tag/webhooks/operation/create_webhook_v1_webhooks_post","tag/webhooks/operation/update_webhook_v1_webhooks__webhook_id__put","tag/webhooks/operation/delete_webhook_v1_webhooks__webhook_id__delete","tag/email-alerts","tag/email-alerts/operation/list_email_alerts_v1_email_alerts_get","tag/email-alerts/operation/create_email_alert_v1_email_alerts_post","tag/email-alerts/operation/update_email_alert_v1_email_alerts__alert_id__put","tag/email-alerts/operation/delete_email_alert_v1_email_alerts__alert_id__delete","tag/version","tag/version/operation/get_version_api_version_get","tag/health","tag/health/operation/health_check","tag/health/operation/health_check_head"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,3.608]],["description/0",[]],["title/1",[1,2.468,2,2.468,3,2.468]],["description/1",[4,3.708]],["title/2",[5,2.943]],["description/2",[]],["title/3",[6,1.512,7,1.512,8,1.512,9,1.233,10,1.512,11,1.512,12,1.512]],["description/3",[13,3.708]],["title/4",[5,1.233,9,1.233,14,2.423,15,1.512,16,1.512,17,1.512]],["description/4",[18,3.708]],["title/5",[19,2.505]],["description/5",[]],["title/6",[19,2.035,20,2.931]],["description/6",[21,3.708]],["title/7",[19,2.035,22,2.931]],["description/7",[23,3.708]],["title/8",[24,1.514]],["description/8",[]],["title/9",[24,1.23,25,2.035]],["description/9",[24,0.395,25,0.654,26,0.942,27,0.942,28,0.654,29,0.395,30,0.942,31,0.942,32,0.942,33,0.942,34,0.768,35,0.942,36,0.942,37,0.942,38,0.768]],["title/10",[24,1.23,39,2.035]],["description/10",[28,0.517,29,0.556,34,0.607,38,0.607,39,0.517,40,0.607,41,0.607,42,0.744,43,0.744,44,0.744,45,0.744,46,0.744,47,0.744,48,0.744,49,0.744,50,0.744,51,0.744,52,0.744,53,0.744]],["title/11",[24,1.23,54,2.035]],["description/11",[28,1.043,29,0.63,41,1.226,54,1.043,55,1.502,56,1.502,57,1.502,58,1.226]],["title/12",[24,1.23,59,2.035]],["description/12",[24,0.846,40,1.645,58,1.645,59,1.4,60,2.016]],["title/13",[61,3.608]],["description/13",[]],["title/14",[25,1.714,29,1.035,62,1.49]],["description/14",[63,3.025]],["title/15",[29,1.035,39,1.714,62,1.49]],["description/15",[63,3.025]],["title/16",[29,1.035,54,1.714,62,1.49]],["description/16",[64,3.025]],["title/17",[29,1.035,59,1.714,62,1.49]],["description/17",[64,3.025]],["title/18",[65,2.943]],["description/18",[]],["title/19",[65,2.943]],["description/19",[66,3.708]],["title/20",[67,2.505]],["description/20",[]],["title/21",[67,2.035,68,2.391]],["description/21",[69,3.025]],["title/22",[67,2.035,68,2.391]],["description/22",[69,3.025]]],"invertedIndex":[["",{"_index":9,"title":{"3":{},"4":{}},"description":{}}],["10",{"_index":28,"title":{},"description":{"9":{},"10":{},"11":{}}}],["5",{"_index":10,"title":{"3":{}},"description":{}}],["alert",{"_index":29,"title":{"14":{},"15":{},"16":{},"17":{}},"description":{"9":{},"10":{},"11":{}}}],["alway",{"_index":35,"title":{},"description":{"9":{}}}],["analys",{"_index":12,"title":{"3":{}},"description":{}}],["analysi",{"_index":5,"title":{"2":{},"4":{}},"description":{}}],["analyz",{"_index":6,"title":{"3":{}},"description":{}}],["api/vers",{"_index":66,"title":{},"description":{"19":{}}}],["audio",{"_index":2,"title":{"1":{}},"description":{}}],["audit",{"_index":16,"title":{"4":{}},"description":{}}],["authent",{"_index":26,"title":{},"description":{"9":{}}}],["call",{"_index":7,"title":{"3":{}},"description":{}}],["check",{"_index":68,"title":{"21":{},"22":{}},"description":{}}],["complianc",{"_index":14,"title":{"4":{}},"description":{}}],["convers",{"_index":17,"title":{"4":{}},"description":{}}],["creat",{"_index":39,"title":{"10":{},"15":{}},"description":{"10":{}}}],["data",{"_index":45,"title":{},"description":{"10":{}}}],["delet",{"_index":59,"title":{"12":{},"17":{}},"description":{"12":{}}}],["deliv",{"_index":43,"title":{},"description":{"10":{}}}],["email",{"_index":62,"title":{"14":{},"15":{},"16":{},"17":{}},"description":{}}],["email-alert",{"_index":61,"title":{"13":{}},"description":{}}],["event",{"_index":41,"title":{},"description":{"10":{},"11":{}}}],["falaai-signatur",{"_index":48,"title":{},"description":{"10":{}}}],["health",{"_index":67,"title":{"20":{},"21":{},"22":{}},"description":{}}],["hmac",{"_index":47,"title":{},"description":{"10":{}}}],["hmac-sha256",{"_index":52,"title":{},"description":{"10":{}}}],["id",{"_index":60,"title":{},"description":{"12":{}}}],["includ",{"_index":31,"title":{},"description":{"9":{}}}],["key",{"_index":22,"title":{"7":{}},"description":{}}],["list",{"_index":25,"title":{"9":{},"14":{}},"description":{"9":{}}}],["log",{"_index":20,"title":{"6":{}},"description":{}}],["name/url/events/retry_enabled/act",{"_index":56,"title":{},"description":{"11":{}}}],["origin",{"_index":50,"title":{},"description":{"10":{}}}],["owner",{"_index":37,"title":{},"description":{"9":{}}}],["pagin",{"_index":30,"title":{},"description":{"9":{}}}],["parallel",{"_index":11,"title":{"3":{}},"description":{}}],["payload",{"_index":42,"title":{},"description":{"10":{}}}],["recomput",{"_index":51,"title":{},"description":{"10":{}}}],["risk",{"_index":15,"title":{"4":{}},"description":{}}],["secret",{"_index":34,"title":{},"description":{"9":{},"10":{}}}],["signatur",{"_index":33,"title":{},"description":{"9":{}}}],["speech",{"_index":0,"title":{"0":{}},"description":{}}],["subscript",{"_index":40,"title":{},"description":{"10":{},"12":{}}}],["text",{"_index":3,"title":{"1":{}},"description":{}}],["timestamp",{"_index":46,"title":{},"description":{"10":{}}}],["timestamp.bodi",{"_index":53,"title":{},"description":{"10":{}}}],["transcrib",{"_index":1,"title":{"1":{}},"description":{}}],["transcript",{"_index":8,"title":{"3":{}},"description":{}}],["updat",{"_index":54,"title":{"11":{},"16":{}},"description":{"11":{}}}],["url",{"_index":32,"title":{},"description":{"9":{}}}],["usag",{"_index":19,"title":{"5":{},"6":{},"7":{}},"description":{}}],["user'",{"_index":27,"title":{},"description":{"9":{}}}],["v1/analyze/diagnost",{"_index":13,"title":{},"description":{"3":{}}}],["v1/analyze/riskaudit",{"_index":18,"title":{},"description":{"4":{}}}],["v1/audio/transcript",{"_index":4,"title":{},"description":{"1":{}}}],["v1/email-alert",{"_index":63,"title":{},"description":{"14":{},"15":{}}}],["v1/email-alerts/{alert_id",{"_index":64,"title":{},"description":{"16":{},"17":{}}}],["v1/health",{"_index":69,"title":{},"description":{"21":{},"22":{}}}],["v1/usage/by-key",{"_index":23,"title":{},"description":{"7":{}}}],["v1/usage/log",{"_index":21,"title":{},"description":{"6":{}}}],["v1/webhook",{"_index":38,"title":{},"description":{"9":{},"10":{}}}],["v1/webhooks/{webhook_id",{"_index":58,"title":{},"description":{"11":{},"12":{}}}],["valid",{"_index":57,"title":{},"description":{"11":{}}}],["verifi",{"_index":49,"title":{},"description":{"10":{}}}],["version",{"_index":65,"title":{"18":{},"19":{}},"description":{}}],["visibl",{"_index":36,"title":{},"description":{"9":{}}}],["webhook",{"_index":24,"title":{"8":{},"9":{},"10":{},"11":{},"12":{}},"description":{"9":{},"12":{}}}],["webhook'",{"_index":55,"title":{},"description":{"11":{}}}],["webhookpayload(ev",{"_index":44,"title":{},"description":{"10":{}}}]],"pipeline":[]}},"options":{"hideRequestPayloadSample":true}};
|
|
753
|
+
const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.1.0","info":{"title":"FalaAI API","version":"1.21.51"},"paths":{"/v1/audio/transcriptions":{"post":{"tags":["speech"],"summary":"Transcribe audio to text","operationId":"create_transcription_v1_audio_transcriptions_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_create_transcription_v1_audio_transcriptions_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscriptionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"Ruby","label":"Transcrever audio (SDK)","source":"# frozen_string_literal: true\nrequire 'falaai-api'\n\nconfig = FalaAI::Configuration.new\nconfig.scheme = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').start_with?('https') ? 'https' : 'http'\nconfig.host = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').sub(%r{^https?://}, '')\nconfig.base_path = ''\nconfig.access_token = ENV['FALAAI_API_KEY']\nclient = FalaAI::ApiClient.new(config)\n\naudio = File.open(\"demo_callcenter.mp3\")\n# REQUIRED: file (audio) + Authorization (fai_ key)\n# OPTIONAL (server defaults): model -> falaai-transcribe-1 | language -> pt | client_reference_id -> (empty)\ntranscription, _status = FalaAI::SpeechApi.new(client).create_transcription_v1_audio_transcriptions_post_with_http_info(\n audio,\n model: \"falaai-transcribe-1\",\n language: \"pt\",\n client_reference_id: \"call_202609271408\"\n)\nputs JSON.pretty_generate(transcription.to_hash)"}]}},"/v1/analyze/diagnostic":{"post":{"tags":["analysis"],"summary":"Analyze a call transcript — 5 parallel analyses","operationId":"create_diagnostic_v1_analyze_diagnostic_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiagnosticRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiagnosticResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"Ruby","label":"Diagnostico da conversa (SDK)","source":"# frozen_string_literal: true\nrequire 'falaai-api'\n\nconfig = FalaAI::Configuration.new\nconfig.scheme = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').start_with?('https') ? 'https' : 'http'\nconfig.host = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').sub(%r{^https?://}, '')\nconfig.base_path = ''\nconfig.access_token = ENV['FALAAI_API_KEY']\nclient = FalaAI::ApiClient.new(config)\n\n# REQUIRED: language, duration_seconds (>= 1.0) + Authorization\n# RULE: dialog OR text - we send dialog and text stays EMPTY (and the optional fallback)\n# OPTIONAL: model -> falaai-diagnostic-1 | audio_events -> [] |\n# response_language -> (uses language) | call_direction / participants / client_reference_id -> null\ndiagnostic, _status = FalaAI::AnalysisApi.new(client).create_diagnostic_v1_analyze_diagnostic_post_with_http_info(\n FalaAI::DiagnosticRequest.new(\n model: \"falaai-diagnostic-1\",\n text: \"\",\n dialog: \"Speaker 1: [00:00:00.100 - 00:00:03.100] Central de atendimento. Bom dia, aqui é a Carla. Como posso ajudar?\\nSpeaker 2: [00:00:03.100 - 00:00:04.700] [suspiro]\\nSpeaker 2: [00:00:04.780 - 00:00:11.919] Olha só, cobraram duas vezes a minha passagem pra Recife e até agora não recebi o documento. Preciso resolver isso.\\nSpeaker 1: [00:00:12.679 - 00:00:20.219] Entendo perfeitamente a sua frustração, senhor. Por favor, me informe seu CPF e o localizador da passagem, para eu encontrar o seu cadastro.\\nSpeaker 2: [00:00:20.820 - 00:00:31.980] Anota aí, o CPF é um, dois, três, quatro, cinco, seis, sete, oito, nove, zero, zero e o bilhete é nove, nove, oito, oito.\\nSpeaker 1: [00:00:32.579 - 00:00:42.039] Pronto, localizei. Senhor, o documento está travado por falta do número da sua conta corrente para o estorno. Nós solicitamos isso por e-mail há três dias.\\nSpeaker 2: [00:00:42.780 - 00:00:47.520] Ah, tá de brincadeira? Quer dizer que agora o erro é meu? Vocês é que não avisam direito.\\nSpeaker 1: [00:00:48.200 - 00:00:50.799] Sim, o problema é seu, que não lê os e-mails.\\nSpeaker 1: [00:00:51.020 - 00:00:52.380] [tosse]\\nSpeaker 1: [00:00:52.439 - 00:01:06.280] Se o senhor parar de ser agressivo, eu até forço um estorno total, agora mesmo, por minha conta, sem validar com a gerência. Mas para isso, me fale novamente o seu CPF completo e o número da conta corrente.\\nSpeaker 2: [00:01:06.959 - 00:01:15.640] Eu não vou repetir CPF, merda nenhuma, caramba! Eu já passei os dados. É só fazer o seu trabalho e resolver logo essa cobrança.\\nSpeaker 1: [00:01:16.459 - 00:01:21.359] Senhor, se acalme ou-- quer saber? Resolva sozinho. Passar bem\",\n audio_events: [\n {\n \"event\": \"[suspiro]\",\n \"start_s\": 3.1,\n \"end_s\": 4.7,\n \"duration_s\": 1.6,\n \"formatted_timestamp\": \"00:00:03.100\"\n },\n {\n \"event\": \"[tosse]\",\n \"start_s\": 51.02,\n \"end_s\": 52.38,\n \"duration_s\": 1.36,\n \"formatted_timestamp\": \"00:00:51.020\"\n }\n ],\n language: \"pt-BR\",\n response_language: \"pt-BR\",\n duration_seconds: 81.46,\n call_direction: \"inbound\",\n participants: [\n {\n \"interlocutor\": \"Speaker 1\",\n \"name\": \"Carla\",\n \"role\": \"agent\"\n },\n {\n \"interlocutor\": \"Speaker 2\",\n \"name\": \"\",\n \"role\": \"client\"\n }\n ],\n client_reference_id: \"call-202609271311\"\n )\n)\nputs JSON.pretty_generate(diagnostic.to_hash)"}]}},"/v1/analyze/riskAudit":{"post":{"tags":["analysis"],"summary":"Compliance Risk Audit — conversation compliance analysis","operationId":"create_risk_audit_v1_analyze_riskAudit_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskAuditRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskAuditV2Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"Ruby","label":"Risk Audit (SDK)","source":"# frozen_string_literal: true\nrequire 'falaai-api'\n\nconfig = FalaAI::Configuration.new\nconfig.scheme = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').start_with?('https') ? 'https' : 'http'\nconfig.host = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').sub(%r{^https?://}, '')\nconfig.base_path = ''\nconfig.access_token = ENV['FALAAI_API_KEY']\nclient = FalaAI::ApiClient.new(config)\n\n# REQUIRED: language, response_language, duration_seconds (>= 1.0) + Authorization\n# RULE: dialog OR text - we send dialog and text stays EMPTY (and the optional fallback)\n# OPTIONAL: model -> falaai-risk-audit-1 | audio_events -> [] |\n# call_direction / participants / response_format / client_reference_id -> null\naudit, _status = FalaAI::AnalysisApi.new(client).create_risk_audit_v1_analyze_risk_audit_post_with_http_info(\n FalaAI::RiskAuditRequest.new(\n model: \"falaai-risk-audit-1\",\n text: \"\",\n dialog: \"Speaker 1: [00:00:00.100 - 00:00:03.100] Central de atendimento. Bom dia, aqui é a Carla. Como posso ajudar?\\nSpeaker 2: [00:00:03.100 - 00:00:04.700] [suspiro]\\nSpeaker 2: [00:00:04.780 - 00:00:11.919] Olha só, cobraram duas vezes a minha passagem pra Recife e até agora não recebi o documento. Preciso resolver isso.\\nSpeaker 1: [00:00:12.679 - 00:00:20.219] Entendo perfeitamente a sua frustração, senhor. Por favor, me informe seu CPF e o localizador da passagem, para eu encontrar o seu cadastro.\\nSpeaker 2: [00:00:20.820 - 00:00:31.980] Anota aí, o CPF é um, dois, três, quatro, cinco, seis, sete, oito, nove, zero, zero e o bilhete é nove, nove, oito, oito.\\nSpeaker 1: [00:00:32.579 - 00:00:42.039] Pronto, localizei. Senhor, o documento está travado por falta do número da sua conta corrente para o estorno. Nós solicitamos isso por e-mail há três dias.\\nSpeaker 2: [00:00:42.780 - 00:00:47.520] Ah, tá de brincadeira? Quer dizer que agora o erro é meu? Vocês é que não avisam direito.\\nSpeaker 1: [00:00:48.200 - 00:00:50.799] Sim, o problema é seu, que não lê os e-mails.\\nSpeaker 1: [00:00:51.020 - 00:00:52.380] [tosse]\\nSpeaker 1: [00:00:52.439 - 00:01:06.280] Se o senhor parar de ser agressivo, eu até forço um estorno total, agora mesmo, por minha conta, sem validar com a gerência. Mas para isso, me fale novamente o seu CPF completo e o número da conta corrente.\\nSpeaker 2: [00:01:06.959 - 00:01:15.640] Eu não vou repetir CPF, merda nenhuma, caramba! Eu já passei os dados. É só fazer o seu trabalho e resolver logo essa cobrança.\\nSpeaker 1: [00:01:16.459 - 00:01:21.359] Senhor, se acalme ou-- quer saber? Resolva sozinho. Passar bem\",\n audio_events: [\n {\n \"event\": \"[suspiro]\",\n \"start_s\": 3.1,\n \"end_s\": 4.7,\n \"duration_s\": 1.6,\n \"formatted_timestamp\": \"00:00:03.100\"\n },\n {\n \"event\": \"[tosse]\",\n \"start_s\": 51.02,\n \"end_s\": 52.38,\n \"duration_s\": 1.36,\n \"formatted_timestamp\": \"00:00:51.020\"\n }\n ],\n duration_seconds: 81.46,\n language: \"pt-BR\",\n response_language: \"pt-BR\",\n call_direction: \"inbound\",\n participants: [\n {\n \"interlocutor\": \"Speaker 1\",\n \"name\": \"Carla\",\n \"role\": \"agent\"\n },\n {\n \"interlocutor\": \"Speaker 2\",\n \"name\": \"\",\n \"role\": \"client\"\n }\n ],\n response_format: \"v2\",\n client_reference_id: \"call-202609271311\"\n )\n)\nputs JSON.pretty_generate(audit.to_hash)"}]}},"/v1/usage/log":{"get":{"tags":["usage"],"summary":"Get Usage Log","operationId":"get_usage_log_v1_usage_log_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}},{"name":"api_key_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageLogResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/usage/by-key":{"get":{"tags":["usage"],"summary":"Get Usage By Key","operationId":"get_usage_by_key_v1_usage_by_key_get","parameters":[{"name":"key_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UsageByKeyItem"},"title":"Response Get Usage By Key V1 Usage By Key Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/webhooks":{"get":{"tags":["webhooks"],"summary":"List webhooks","description":"Lists the authenticated user's webhooks (10 alerts). Paginated. Includes the URL signature secret (always visible to the owner).","operationId":"list_webhooks_v1_webhooks_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Pagina (1-indexed)","default":1,"title":"Page"},"description":"Pagina (1-indexed)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Itens por pagina (max 100)","default":20,"title":"Limit"},"description":"Itens por pagina (max 100)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["webhooks"],"summary":"Create webhook","description":"Creates a subscription for alert events (10 alerts). Payload delivered: WebhookPayload(event, data, timestamp) with HMAC FalaAI-Signature. To verify the origin, recompute HMAC-SHA256 of \"timestamp.body\" with your secret.","operationId":"create_webhook_v1_webhooks_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookItem"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/webhooks/{webhook_id}":{"put":{"tags":["webhooks"],"summary":"Update webhook","description":"Updates the webhook's name/url/events/retry_enabled/active. Valid events: 10 alerts.","operationId":"update_webhook_v1_webhooks__webhook_id__put","parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","title":"Webhook Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWebhookRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["webhooks"],"summary":"Delete webhook","description":"Deletes a webhook subscription by ID.","operationId":"delete_webhook_v1_webhooks__webhook_id__delete","parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","title":"Webhook Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/email-alerts":{"get":{"tags":["email-alerts"],"summary":"List email alerts","operationId":"list_email_alerts_v1_email_alerts_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailAlertListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["email-alerts"],"summary":"Create email alert","operationId":"create_email_alert_v1_email_alerts_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEmailAlertRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailAlertItem"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/email-alerts/{alert_id}":{"put":{"tags":["email-alerts"],"summary":"Update email alert","operationId":"update_email_alert_v1_email_alerts__alert_id__put","parameters":[{"name":"alert_id","in":"path","required":true,"schema":{"type":"string","title":"Alert Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEmailAlertRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailAlertMessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["email-alerts"],"summary":"Delete email alert","operationId":"delete_email_alert_v1_email_alerts__alert_id__delete","parameters":[{"name":"alert_id","in":"path","required":true,"schema":{"type":"string","title":"Alert Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailAlertMessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/whatsapp/extractConversations":{"post":{"tags":["whatsapp"],"summary":"Extract and segment WhatsApp conversations from an export","operationId":"extract_conversations_v1_whatsapp_extractConversations_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_extract_conversations_v1_whatsapp_extractConversations_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsappConversationsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/version":{"get":{"tags":["version"],"summary":"Get Version","operationId":"get_version_api_version_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionResponse"}}}}},"security":[]}},"/v1/health":{"get":{"tags":["health"],"summary":"Health Check","operationId":"health_check","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}}},"security":[],"x-codeSamples":[{"lang":"Ruby","label":"Como verificar a saude da API","source":"# frozen_string_literal: true\nrequire 'falaai-api'\n\nconfig = FalaAI::Configuration.new\nconfig.scheme = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').start_with?('https') ? 'https' : 'http'\nconfig.host = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').sub(%r{^https?://}, '')\nconfig.base_path = ''\nclient = FalaAI::ApiClient.new(config)\n\nhealth = FalaAI::HealthApi.new(client).health_check\nputs JSON.pretty_generate(health.to_hash)\n\nFalaAI::HealthApi.new(client).health_check_head"}]},"head":{"tags":["health"],"summary":"Health Check","operationId":"health_check_head","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}}},"security":[],"x-codeSamples":[{"lang":"Ruby","label":"Health check (HEAD — sem body)","source":"# frozen_string_literal: true\nrequire 'falaai-api'\n\nconfig = FalaAI::Configuration.new\nconfig.scheme = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').start_with?('https') ? 'https' : 'http'\nconfig.host = ENV.fetch('FALAAI_BASE_URL', 'https://api01-falaai.action.tec.br').sub(%r{^https?://}, '')\nconfig.base_path = ''\nclient = FalaAI::ApiClient.new(config)\n\nhealth = FalaAI::HealthApi.new(client).health_check\nputs JSON.pretty_generate(health.to_hash)\n\nFalaAI::HealthApi.new(client).health_check_head"}]}}},"components":{"schemas":{"AudioEvent":{"properties":{"event":{"type":"string","title":"Event","description":"Type of identified audio event. Ex: [riso], [suspiro], [pausa], [tosse]"},"start_s":{"type":"number","title":"Start S","description":"Start time of audio event in seconds"},"end_s":{"type":"number","title":"End S","description":"End time of audio event in seconds"},"duration_s":{"type":"number","title":"Duration S","description":"Event duration in seconds"},"formatted_timestamp":{"type":"string","title":"Formatted Timestamp","description":"Formatted timestamp HH:MM:SS.mmm of event start"}},"type":"object","required":["event","start_s","end_s","duration_s","formatted_timestamp"],"title":"AudioEvent"},"AudioInputMeta":{"properties":{"duration_s":{"type":"number","title":"Duration S","description":"Exact audio duration sent in seconds"},"original_format":{"type":"string","title":"Original Format","description":"Original file format (wav, mp3, ogg, etc)"},"codec":{"type":"string","title":"Codec","description":"Audio codec sent"},"sample_rate":{"type":"integer","title":"Sample Rate","description":"Audio sample rate in Hz"},"channels":{"type":"integer","title":"Channels","description":"Number of channels (1=mono, 2=stereo)"}},"type":"object","required":["duration_s","original_format","codec","sample_rate","channels"],"title":"AudioInputMeta"},"Body_create_transcription_v1_audio_transcriptions_post":{"properties":{"file":{"type":"string","title":"File","format":"binary"},"model":{"type":"string","title":"Model","default":"falaai-transcribe-1"},"language":{"type":"string","title":"Language","default":"pt"},"client_reference_id":{"type":"string","title":"Client Reference Id","description":"Optional client-supplied ID echoed verbatim in the response. Use to correlate/sync with your system. Accepted charset: [A-Za-z0-9._:-]. Not idempotency."}},"type":"object","required":["file"],"title":"Body_create_transcription_v1_audio_transcriptions_post"},"Body_extract_conversations_v1_whatsapp_extractConversations_post":{"properties":{"file":{"type":"string","title":"File","format":"binary"},"start":{"type":"string","title":"Start"},"end":{"type":"string","title":"End"},"timezone":{"type":"string","title":"Timezone"},"date_format":{"type":"string","title":"Date Format"},"gap_minutes":{"type":"number","title":"Gap Minutes","default":720},"min_messages":{"type":"integer","title":"Min Messages","default":2},"chars_per_minute":{"type":"number","title":"Chars Per Minute","default":800},"client_reference_id":{"type":"string","title":"Client Reference Id"}},"type":"object","required":["file","start","end","timezone","date_format"],"title":"Body_extract_conversations_v1_whatsapp_extractConversations_post"},"CreateEmailAlertRequest":{"properties":{"name":{"type":"string","title":"Name","description":"Nome identificador"},"email":{"type":"string","title":"Email","description":"Email destino"},"events":{"items":{"$ref":"#/components/schemas/EmailEvent"},"type":"array","title":"Events","description":"Eventos subscritos"}},"type":"object","required":["name","email","events"],"title":"CreateEmailAlertRequest"},"CreateWebhookRequest":{"properties":{"name":{"type":"string","title":"Name","description":"Nome identificador do webhook"},"url":{"type":"string","title":"Url","description":"URL HTTPS que recebera POST com HMAC FalaAI-Signature"},"events":{"items":{"$ref":"#/components/schemas/WebhookEvent"},"type":"array","title":"Events","description":"Eventos subscritos (10 alertas)"},"retry_enabled":{"type":"boolean","title":"Retry Enabled","description":"Retry exponencial 5 tentativas quando true (false=1 tentativa)","default":false}},"type":"object","required":["name","url","events"],"title":"CreateWebhookRequest"},"DiagnosticAnalysisMap":{"properties":{"dialogue_summary":{"$ref":"#/components/schemas/DiagnosticTextAnalysis","description":"Detailed conversation summary"},"contact_reason":{"$ref":"#/components/schemas/DiagnosticTextAnalysis","description":"Initial contact reason"},"identified_action":{"$ref":"#/components/schemas/DiagnosticCategoricalAnalysis","description":"Action taken / resolution"},"identified_label":{"$ref":"#/components/schemas/DiagnosticCategoricalAnalysis","description":"Theme classification"},"sentiment":{"$ref":"#/components/schemas/DiagnosticCategoricalAnalysis","description":"Predominant sentiment"},"participants_identified":{"items":{"$ref":"#/components/schemas/ParticipantDiagnostic"},"type":"array","title":"Participants Identified","description":"Identified participants and roles (same field names as auditoria)","default":[]}},"type":"object","required":["dialogue_summary","contact_reason","identified_action","identified_label","sentiment"],"title":"DiagnosticAnalysisMap"},"DiagnosticAudioEvent":{"properties":{"event":{"type":"string","title":"Event","description":"Audio event type. E.g.: [laughter], [sigh]"},"start_s":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Start S","description":"Start time in seconds"},"end_s":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"End S","description":"End time in seconds"},"duration_s":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Duration S","description":"Duration in seconds"},"formatted_timestamp":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Formatted Timestamp","description":"Formatted timestamp (HH:MM:SS.ms)"}},"type":"object","required":["event"],"title":"DiagnosticAudioEvent"},"DiagnosticCategoricalAnalysis":{"properties":{"list_choice":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"List Choice","description":"Selected value from classification list (used in action, label, sentiment)"},"justification":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Justification","description":"Justification for the choice"},"evidence_phrases":{"items":{"type":"string"},"type":"array","title":"Evidence Phrases","description":"Verbatim transcript excerpts supporting the analysis","default":[]}},"type":"object","title":"DiagnosticCategoricalAnalysis"},"DiagnosticParticipant":{"properties":{"interlocutor":{"type":"string","title":"Interlocutor","description":"Exact speaker label from the dialog (e.g. 'Speaker 1')"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Participant name (optional)"},"role":{"type":"string","enum":["agent","client","bot"],"title":"Role","description":"agent | client | bot"}},"additionalProperties":false,"type":"object","required":["interlocutor","role"],"title":"DiagnosticParticipant"},"DiagnosticRequest":{"properties":{"model":{"type":"string","title":"Model","description":"Analysis model. Always 'falaai-diagnostic-1'","default":"falaai-diagnostic-1"},"text":{"type":"string","maxLength":300000,"title":"Text","description":"Plain transcript (fallback if dialog is empty). At least one of 'dialog' or 'text' required. Max 300,000 characters","default":""},"dialog":{"type":"string","maxLength":300000,"title":"Dialog","description":"Diarized transcript with speaker turns. PRIMARY source. At least one of 'dialog' or 'text' required. Speaker labels accepted (any case): 'Speaker N', 'Interlocutor N', 'Hablante N', 'Locutor N', 'Orador N' (space or underscore). Normalized internally to 'Speaker N' in the response. Max 300,000 characters","default":""},"audio_events":{"items":{"$ref":"#/components/schemas/DiagnosticAudioEvent"},"type":"array","maxItems":500,"title":"Audio Events","description":"Detected audio events with timestamps (required when using dialog)","default":[]},"language":{"type":"string","title":"Language","description":"Transcript language. Required. Accepted: en-US, pt-BR, es-ES, es-MX, fr-FR, de-DE, it-IT, pt-PT, zh-CN, ja-JP, ko-KR, ar-SA, hi-IN, ru-RU, id-ID, tr-TR, nl-NL, pl-PL, vi-VN, th-TH, en-GB"},"response_language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Language","description":"Language for the analysis results (labels, categories, levels). Can differ from 'language' (input). If omitted, uses 'language'. Accepted: en-US, es-ES, es-MX, pt-BR, fr-FR, de-DE, it-IT, pt-PT, zh-CN, ja-JP, ko-KR, ar-SA, hi-IN, ru-RU, id-ID, tr-TR, nl-NL, pl-PL, vi-VN, th-TH, en-GB."},"duration_seconds":{"type":"number","minimum":1,"title":"Duration Seconds","description":"Total audio duration in seconds. Required. Max 3h (10800s)."},"client_reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Reference Id","description":"Optional client-supplied ID echoed verbatim in the response. Use to correlate/sync with your system. Accepted charset: [A-Za-z0-9._:-], max 128 chars. Not idempotency."},"call_direction":{"anyOf":[{"type":"string","enum":["inbound","outbound"]},{"type":"null"}],"title":"Call Direction","description":"Who originated the call. inbound=client called, outbound=company called. If omitted, the LLM infers from context."},"participants":{"anyOf":[{"items":{"$ref":"#/components/schemas/DiagnosticParticipant"},"type":"array","maxItems":10},{"type":"null"}],"title":"Participants","description":"Explicit participant roles. If omitted, the LLM infers from the dialog. When provided, used as ground truth (no inference) and echoed in analysis.participants_identified."}},"additionalProperties":false,"type":"object","required":["language","duration_seconds"],"title":"DiagnosticRequest"},"DiagnosticResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Unique analysis identifier. Prefix 'di-' + UUID"},"response_language":{"type":"string","title":"Response Language","description":"Language used in the response. E.g.: 'pt-BR', 'en-US', 'es-ES'"},"object":{"type":"string","title":"Object","description":"Object type. Always 'analysis'"},"analysis":{"$ref":"#/components/schemas/DiagnosticAnalysisMap","description":"The 6 conversation analyses (5 + participants)"},"usage":{"$ref":"#/components/schemas/DiagnosticUsage","description":"Usage and processing information"},"client_reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Reference Id","description":"Client-supplied ID echoed verbatim (if provided in request)"}},"type":"object","required":["id","response_language","object","analysis","usage"],"title":"DiagnosticResponse"},"DiagnosticTextAnalysis":{"properties":{"explanation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Explanation","description":"Explanatory text (used in summary and reason)"}},"type":"object","title":"DiagnosticTextAnalysis"},"DiagnosticUsage":{"properties":{"characters":{"type":"integer","title":"Characters","description":"Total characters analyzed"},"credits_consumed":{"type":"integer","title":"Credits Consumed","description":"Credits consumed: max(ceil(chars/500)*3, 3) * 5"},"processing_ms":{"type":"integer","title":"Processing Ms","description":"Total processing time in milliseconds"}},"type":"object","required":["characters","credits_consumed","processing_ms"],"title":"DiagnosticUsage"},"EmailAlertItem":{"properties":{"id":{"type":"string","title":"Id","description":"Email alert id"},"user_id":{"type":"string","title":"User Id","description":"Owner user id"},"name":{"type":"string","title":"Name","description":"Email alert name"},"email":{"type":"string","title":"Email","description":"Destination email"},"events":{"items":{"type":"string"},"type":"array","title":"Events","description":"Subscribed events"},"active":{"type":"boolean","title":"Active","description":"Is active"},"created_at":{"type":"string","title":"Created At","description":"ISO 8601 created"},"updated_at":{"type":"string","title":"Updated At","description":"ISO 8601 updated"}},"type":"object","required":["id","user_id","name","email","events","active","created_at","updated_at"],"title":"EmailAlertItem"},"EmailAlertListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/EmailAlertItem"},"type":"array","title":"Data"},"page":{"type":"integer","title":"Page"},"limit":{"type":"integer","title":"Limit"}},"type":"object","required":["data","page","limit"],"title":"EmailAlertListResponse"},"EmailAlertMessageResponse":{"properties":{"message":{"type":"string","title":"Message","description":"Operation result message"}},"type":"object","required":["message"],"title":"EmailAlertMessageResponse"},"EmailEvent":{"type":"string","enum":["subscription.created","avulso.completed","subscription.upgraded","subscription.downgraded","subscription.canceled","credits.low","credits.exhausted","subscription.renewed","payment.failed"],"title":"EmailEvent"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HealthResponse":{"properties":{"status":{"type":"string","title":"Status","description":"Overall API status"},"version":{"type":"string","title":"Version","description":"Current API version"},"uptime_seconds":{"type":"integer","title":"Uptime Seconds","description":"Uptime in seconds"},"database":{"type":"boolean","title":"Database","description":"Database connection status"},"phase":{"type":"string","title":"Phase","description":"Development phase"},"launch_date":{"type":"string","title":"Launch Date","description":"Expected public launch date"}},"type":"object","required":["status","version","uptime_seconds","database","phase","launch_date"],"title":"HealthResponse"},"MessageResponse":{"properties":{"message":{"type":"string","title":"Message","description":"Operation result message"}},"type":"object","required":["message"],"title":"MessageResponse"},"Participant":{"properties":{"interlocutor":{"type":"string","title":"Interlocutor","description":"Exact identifier as used in dialog (e.g. 'Interlocutor 1', 'Antonio')"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Participant name (humanizes report, does not affect logic)"},"role":{"type":"string","enum":["agent","client","bot"],"title":"Role","description":"Role: agent (human operator), client (customer), bot (IVR/AI)"}},"type":"object","required":["interlocutor","role"],"title":"Participant"},"ParticipantDiagnostic":{"properties":{"interlocutor":{"type":"string","title":"Interlocutor","description":"Exact speaker label from the dialog (e.g. 'Speaker 1')"},"role":{"type":"string","title":"Role","description":"Role: agent | client | bot | agent_requester | agent_custodian"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Participant name if mentioned in the dialogue"},"confidence":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confidence","description":"high | medium | low"},"evidence":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Evidence","description":"Exact verbatim quote supporting the role (no timestamps)"}},"type":"object","required":["interlocutor","role"],"title":"ParticipantDiagnostic"},"RiskAuditAnalysisV2":{"properties":{"global_metrics":{"additionalProperties":true,"type":"object","title":"Global Metrics","description":"Global metrics","default":{}},"final_analysis":{"additionalProperties":true,"type":"object","title":"Final Analysis","description":"Final analysis","default":{}},"frameworks":{"additionalProperties":true,"type":"object","title":"Frameworks","description":"Frameworks (COPC/ISO/Kirkpatrick/CES)","default":{}}},"additionalProperties":false,"type":"object","title":"RiskAuditAnalysisV2"},"RiskAuditAppliedActionV2":{"properties":{"action_type":{"type":"string","title":"Action Type","description":"Action type code"},"label":{"type":"string","title":"Label","description":"Action label"},"description":{"type":"string","title":"Description","description":"Action description"},"priority":{"type":"string","title":"Priority","description":"CRITICO/ALTO/MEDIO/BAIXO"},"color":{"type":"string","title":"Color","description":"Color","default":""},"icon":{"type":"string","title":"Icon","description":"Icon","default":""},"condition":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Condition","description":"Condition"},"reason":{"type":"string","title":"Reason","description":"Reason","default":""}},"additionalProperties":false,"type":"object","required":["action_type","label","description","priority"],"title":"RiskAuditAppliedActionV2"},"RiskAuditAudioEventModelV2":{"properties":{"model":{"type":"string","title":"Model","description":"MAC model text (i18n)","default":""},"description":{"type":"string","title":"Description","description":"MAC description (i18n)","default":""},"windows_s":{"additionalProperties":true,"type":"object","title":"Windows S","description":"Temporal windows (s)","default":{}}},"additionalProperties":false,"type":"object","title":"RiskAuditAudioEventModelV2"},"RiskAuditAuditDecisionsV2":{"properties":{"risk_origin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Risk Origin","description":"Risk origin"},"has_zero_tolerance_violation":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Zero Tolerance Violation","description":"Has zero-tolerance violation"},"deterministic_validator_changes":{"items":{},"type":"array","title":"Deterministic Validator Changes","description":"Deterministic validator changes","default":[]}},"additionalProperties":false,"type":"object","title":"RiskAuditAuditDecisionsV2"},"RiskAuditConversationScoresV2":{"properties":{"consolidated_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Consolidated Score","description":"Consolidated score"},"violation_density_per_min":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Violation Density Per Min","description":"Violation density/min"},"sentiment_trend":{"anyOf":[{},{"type":"null"}],"title":"Sentiment Trend","description":"Sentiment trend"},"pct_turns_with_violation":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pct Turns With Violation","description":"% turns with violation"},"most_critical_turn":{"anyOf":[{},{"type":"null"}],"title":"Most Critical Turn","description":"Most critical turn"},"positive_negative_ratio":{"anyOf":[{},{"type":"null"}],"title":"Positive Negative Ratio","description":"Positive:negative ratio"},"global_risk_severity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Global Risk Severity","description":"Global risk severity code"},"global_risk_severity_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Global Risk Severity Label","description":"Global risk severity label"},"global_risk_severity_color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Global Risk Severity Color","description":"Global risk severity color"},"risk_likelihood_avg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Risk Likelihood Avg","description":"Risk likelihood avg"},"risk_impact_avg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Risk Impact Avg","description":"Risk impact avg"}},"additionalProperties":false,"type":"object","title":"RiskAuditConversationScoresV2"},"RiskAuditDetectionItemV2":{"properties":{"turn":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Turn","description":"Turn number"},"interlocutor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Interlocutor","description":"Speaker"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role","description":"Role"},"timestamp_start_s":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Timestamp Start S","description":"Start (s)"},"timestamp_end_s":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Timestamp End S","description":"End (s)"},"timestamp_formatted":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timestamp Formatted","description":"Formatted timestamp"},"term_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Term Text","description":"Detected term"},"suggested_term_for_bank":{"anyOf":[{},{"type":"null"}],"title":"Suggested Term For Bank","description":"Suggested term for bank"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"Category code"},"category_label":{"type":"string","title":"Category Label","description":"Category label (i18n)"},"category_color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category Color","description":"Category color"},"category_icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category Icon","description":"Category icon"},"criticality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Criticality","description":"Criticality"},"category_threshold":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Category Threshold","description":"Category threshold"},"category_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category Type","description":"Category type"},"category_group":{"type":"string","title":"Category Group","description":"Category group label (i18n)"},"nature":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nature","description":"Nature"},"llm_confidence":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Llm Confidence","description":"LLM confidence"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"Reason"},"is_valid_context":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Valid Context","description":"Valid context"},"risk_probability":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Risk Probability","description":"Risk probability"},"risk_impact":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Risk Impact","description":"Risk impact"},"category_weight":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Category Weight","description":"Category weight"},"turn_sentiment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Turn Sentiment","description":"Turn sentiment"},"intensity":{"anyOf":[{},{"type":"null"}],"title":"Intensity","description":"Intensity"},"mod_applied":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mod Applied","description":"Total modifier applied"},"mac_applied":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mac Applied","description":"Audio modifier applied"},"mvad_applied":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mvad Applied","description":"Intensity modifier applied"},"mod_formula":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mod Formula","description":"Modifier formula"},"mac_details":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Mac Details","description":"MAC details","default":[]},"calibration_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calibration Reason","description":"Calibration reason"},"final_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Final Score","description":"Final score"},"final_score_formula":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Final Score Formula","description":"Final score formula"},"conversation_limit":{"anyOf":[{},{"type":"null"}],"title":"Conversation Limit","description":"Conversation limit"},"apply_saturation":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Apply Saturation","description":"Apply saturation"},"block_repetition":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Block Repetition","description":"Block repetition"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Status"},"effective_impact":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Effective Impact","description":"Effective impact"},"saturation_factor":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Saturation Factor","description":"Saturation factor"},"saturation_formula":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Saturation Formula","description":"Saturation formula"},"threshold_formula":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Threshold Formula","description":"Threshold formula"},"blocked_formula":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Blocked Formula","description":"Blocked formula"},"reconciliation_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reconciliation Note","description":"Reconciliation note"},"violated_frameworks":{"items":{},"type":"array","title":"Violated Frameworks","description":"Violated frameworks","default":[]},"citation_fidelity":{"type":"boolean","title":"Citation Fidelity","description":"Citation fidelity","default":true},"subcategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory","description":"Subcategory code"},"subcategory_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory Label","description":"Subcategory label (i18n)"}},"additionalProperties":false,"type":"object","required":["category_label","category_group"],"title":"RiskAuditDetectionItemV2"},"RiskAuditDetectionsV2":{"properties":{"violations":{"items":{"$ref":"#/components/schemas/RiskAuditDetectionItemV2"},"type":"array","title":"Violations","description":"Active violations","default":[]},"positives":{"items":{"$ref":"#/components/schemas/RiskAuditDetectionItemV2"},"type":"array","title":"Positives","description":"Active positives","default":[]},"client_risk_alerts":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Client Risk Alerts","description":"Client risk alerts","default":[]},"client_behavior_alerts":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Client Behavior Alerts","description":"Client behavior alerts","default":[]},"client_negatives":{"items":{"$ref":"#/components/schemas/RiskAuditDetectionItemV2"},"type":"array","title":"Client Negatives","description":"Client negatives","default":[]}},"additionalProperties":false,"type":"object","title":"RiskAuditDetectionsV2"},"RiskAuditIndexerV2":{"properties":{"suggested_terms_for_bank":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Suggested Terms For Bank","description":"Suggested terms for bank","default":[]}},"additionalProperties":false,"type":"object","title":"RiskAuditIndexerV2"},"RiskAuditMetaV2":{"properties":{"id":{"type":"string","title":"Id","description":"Analysis id"},"object":{"type":"string","title":"Object","description":"Object type","default":"risk_audit"},"call_duration_s":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Call Duration S","description":"Call duration (s)"},"analyzed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Analyzed At","description":"ISO 8601 analyzed timestamp"},"usage":{"$ref":"#/components/schemas/RiskAuditUsageV2","description":"Usage block"},"client_reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Reference Id","description":"Echoed client reference id"}},"additionalProperties":false,"type":"object","required":["id","usage"],"title":"RiskAuditMetaV2"},"RiskAuditParticipantV2":{"properties":{"interlocutor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Interlocutor","description":"Speaker label"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Participant name"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role","description":"Role (agent/client/bot/unknown)"},"confidence":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confidence","description":"Role inference confidence (high/medium/low)"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source","description":"Role source (input/inferred)"},"evidence":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Evidence","description":"Role inference evidence"}},"additionalProperties":false,"type":"object","title":"RiskAuditParticipantV2"},"RiskAuditParticipantsV2":{"properties":{"identified":{"items":{"$ref":"#/components/schemas/RiskAuditParticipantV2"},"type":"array","title":"Identified","description":"Identified participants","default":[]},"call_direction":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Direction","description":"inbound/outbound"},"role_inference_reliable":{"type":"boolean","title":"Role Inference Reliable","description":"Role inference reliability","default":true},"identification_status":{"type":"string","title":"Identification Status","description":"Identification status","default":"none"},"unidentified_items_count":{"type":"integer","title":"Unidentified Items Count","description":"Unidentified items count","default":0}},"additionalProperties":false,"type":"object","title":"RiskAuditParticipantsV2"},"RiskAuditRequest":{"properties":{"model":{"type":"string","title":"Model","description":"Analysis model. Always 'falaai-risk-audit-1'","default":"falaai-risk-audit-1"},"text":{"type":"string","maxLength":300000,"title":"Text","description":"Plain transcript (fallback if dialog is empty). At least one of 'dialog' or 'text' required. Max 300,000 characters","default":""},"dialog":{"type":"string","maxLength":300000,"title":"Dialog","description":"Diarized transcript with speaker turns. PRIMARY source. Speaker labels accepted (any case): 'Speaker N', 'Interlocutor N', 'Hablante N', 'Locutor N', 'Orador N' (space or underscore). Normalized internally to 'Speaker N' in the response. Max 300,000 characters","default":""},"audio_events":{"items":{"$ref":"#/components/schemas/DiagnosticAudioEvent"},"type":"array","maxItems":500,"title":"Audio Events","description":"Audio events with timestamps (correlated with turns when diarization is present)","default":[]},"duration_seconds":{"type":"number","minimum":1,"title":"Duration Seconds","description":"Total audio duration in seconds. Required. Max 3h (10800s)."},"language":{"type":"string","title":"Language","description":"Language of the transcript being analyzed. Must match the dialog/text language. Accepted: pt-BR, en-US, es-ES."},"response_language":{"type":"string","title":"Response Language","description":"Language for analysis results (labels, categories, levels, actions, HTML report). Can differ from 'language'. Accepted: pt-BR, en-US, es-ES."},"call_direction":{"anyOf":[{"type":"string","enum":["inbound","outbound"]},{"type":"null"}],"title":"Call Direction","description":"Who originated the call. inbound=client called, outbound=company called. If omitted, LLM infers from context."},"participants":{"anyOf":[{"items":{"$ref":"#/components/schemas/Participant"},"type":"array","maxItems":10},{"type":"null"}],"title":"Participants","description":"Explicit participant roles. If omitted, LLM infers from dialog (Lei 17). When provided, used as ground truth — no inference."},"response_format":{"type":"string","enum":["v2"],"title":"Response Format","description":"Response format version. Only 'v2' (structured EN-US blocks) is available today.","default":"v2"},"client_reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Reference Id","description":"Optional client-supplied ID echoed verbatim in the response. Use to correlate/sync with your system. Accepted charset: [A-Za-z0-9._:-], max 128 chars. Not idempotency."}},"additionalProperties":false,"type":"object","required":["duration_seconds","language","response_language"],"title":"RiskAuditRequest"},"RiskAuditScoresV2":{"properties":{"conversation":{"$ref":"#/components/schemas/RiskAuditConversationScoresV2","description":"Conversation scores"},"per_participant":{"additionalProperties":true,"type":"object","title":"Per Participant","description":"Per-participant KPIs","default":{}}},"additionalProperties":false,"type":"object","required":["conversation"],"title":"RiskAuditScoresV2"},"RiskAuditScoringExplanationV2":{"properties":{"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"Explanation summary"},"steps":{"items":{},"type":"array","title":"Steps","description":"Explanation steps","default":[]}},"additionalProperties":false,"type":"object","title":"RiskAuditScoringExplanationV2"},"RiskAuditSummaryV2":{"properties":{"total_turns":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Turns","description":"Total turns"},"total_calibrated":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Calibrated","description":"Total calibrated detections"},"active":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Active","description":"Active detections"},"tolerated":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tolerated","description":"Tolerated detections"},"blocked":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Blocked","description":"Blocked detections"},"audio_events_used":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Audio Events Used","description":"Audio events used"},"audio_events_aggravated":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Audio Events Aggravated","description":"Audio events aggravated"},"mac_audio_applied":{"anyOf":[{},{"type":"null"}],"title":"Mac Audio Applied","description":"MAC audio applied"},"mvad_applied":{"anyOf":[{},{"type":"null"}],"title":"Mvad Applied","description":"MVAD applied"},"total_participants":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Participants","description":"Total participants"},"total_agents":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Agents","description":"Total agents"},"total_clients":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Clients","description":"Total clients"},"total_bots":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Bots","description":"Total bots"},"total_unknown":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Unknown","description":"Total unknown"},"client_risk_alerts_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Client Risk Alerts Count","description":"Client risk alerts count"},"client_behavior_alerts_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Client Behavior Alerts Count","description":"Client behavior alerts count"}},"additionalProperties":false,"type":"object","title":"RiskAuditSummaryV2"},"RiskAuditTimelineV2":{"properties":{"turns_sentiment":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Turns Sentiment","description":"Per-turn sentiment","default":[]},"audio_events":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Audio Events","description":"Audio events (i18n)","default":[]},"audio_groups_found":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Audio Groups Found","description":"Audio groups found","default":[]}},"additionalProperties":false,"type":"object","title":"RiskAuditTimelineV2"},"RiskAuditUsageV2":{"properties":{"characters":{"type":"integer","title":"Characters","description":"Characters analyzed"},"credits_consumed":{"type":"integer","title":"Credits Consumed","description":"Credits consumed"},"processing_ms":{"type":"integer","title":"Processing Ms","description":"Processing time (ms)"}},"type":"object","required":["characters","credits_consumed","processing_ms"],"title":"RiskAuditUsageV2"},"RiskAuditV2":{"properties":{"meta":{"$ref":"#/components/schemas/RiskAuditMetaV2","description":"Identification + usage"},"participants":{"$ref":"#/components/schemas/RiskAuditParticipantsV2","description":"Participants/roles/direction"},"verdict":{"$ref":"#/components/schemas/RiskAuditVerdictV2","description":"Verdict + level + applied actions"},"scores":{"$ref":"#/components/schemas/RiskAuditScoresV2","description":"Consolidated + per-participant scores"},"detections":{"$ref":"#/components/schemas/RiskAuditDetectionsV2","description":"violations/positives/client alerts"},"analysis":{"$ref":"#/components/schemas/RiskAuditAnalysisV2","description":"global_metrics + final_analysis + frameworks"},"timeline":{"$ref":"#/components/schemas/RiskAuditTimelineV2","description":"turns_sentiment + audio_events + groups"},"audio_event_model":{"$ref":"#/components/schemas/RiskAuditAudioEventModelV2","description":"MAC audio event semantics"},"categories_summary":{"additionalProperties":true,"type":"object","title":"Categories Summary","description":"Per-category summary (keyed by category)"},"indexer":{"$ref":"#/components/schemas/RiskAuditIndexerV2","description":"Suggested terms for bank"},"summary":{"$ref":"#/components/schemas/RiskAuditSummaryV2","description":"Executive summary counts"},"actions_i18n":{"additionalProperties":true,"type":"object","title":"Actions I18N","description":"Used actions i18n catalog (keyed by action)"},"audit_decisions":{"$ref":"#/components/schemas/RiskAuditAuditDecisionsV2","description":"Risk origin + validator changes"},"scoring_explanation":{"$ref":"#/components/schemas/RiskAuditScoringExplanationV2","description":"Score composition explanation"},"html_report":{"type":"string","title":"Html Report","description":"HTML report (base64 gzip)"}},"additionalProperties":false,"type":"object","required":["meta","participants","verdict","scores","detections","analysis","timeline","audio_event_model","categories_summary","indexer","summary","actions_i18n","audit_decisions","scoring_explanation","html_report"],"title":"RiskAuditV2","description":"Response V2 (build_public_response_v2) — blocos logicos EN-US. Fonte: response_builder.py."},"RiskAuditV2Response":{"properties":{"response":{"$ref":"#/components/schemas/RiskAuditV2","description":"Public response V2 — always returned"}},"type":"object","required":["response"],"title":"RiskAuditV2Response"},"RiskAuditVerdictV2":{"properties":{"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"Human-readable verdict"},"level_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Level Code","description":"Classification level code"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color","description":"Level color"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon","description":"Level icon"},"risk_matrix":{"additionalProperties":true,"type":"object","title":"Risk Matrix","description":"Risk matrix","default":{}},"applied_actions":{"items":{"$ref":"#/components/schemas/RiskAuditAppliedActionV2"},"type":"array","title":"Applied Actions","description":"Applied actions","default":[]},"decision_details":{"anyOf":[{},{"type":"null"}],"title":"Decision Details","description":"Decision details"}},"additionalProperties":false,"type":"object","title":"RiskAuditVerdictV2"},"TranscriptionResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Unique transcription identifier. Prefix 'tr-' followed by UUID"},"object":{"type":"string","title":"Object","description":"Returned object type. Always 'transcription'"},"model":{"type":"string","title":"Model","description":"Model used for transcription. Ex: 'falaai-transcribe-1'"},"filename":{"type":"string","title":"Filename","description":"Original audio file name uploaded"},"processed_at":{"type":"string","title":"Processed At","description":"Processing datetime in ISO 8601 UTC format"},"usage":{"$ref":"#/components/schemas/TranscriptionUsage","description":"Usage and processing information"},"language":{"type":"string","title":"Language","description":"ISO 639-3 language code detected in audio. Ex: 'por' (Portuguese), 'eng' (English), 'spa' (Spanish)"},"language_confidence":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Language Confidence","description":"Language detection confidence level (0.0 to 1.0). Higher is more reliable"},"duration_seconds":{"type":"number","title":"Duration Seconds","description":"Total audio duration in seconds"},"text":{"type":"string","title":"Text","description":"Full transcription as plain text, including audio events in brackets"},"dialog":{"type":"string","title":"Dialog","description":"Turn-by-turn formatted transcript with speaker identification and start/end timestamps"},"audio_events":{"items":{"$ref":"#/components/schemas/AudioEvent"},"type":"array","title":"Audio Events","description":"List of detected audio events (laughs, sighs, pauses, etc) with timestamps and duration"},"event_types":{"items":{"type":"string"},"type":"array","title":"Event Types","description":"Unique audio event types found in transcription, alphabetically sorted"},"word_count":{"type":"integer","title":"Word Count","description":"Total number of recognized words in transcription"},"input":{"$ref":"#/components/schemas/AudioInputMeta","description":"Metadados do arquivo de audio enviado (duracao, formato, codec, sample rate, canais)"},"client_reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Reference Id","description":"Client-supplied ID echoed verbatim (if provided in request)"}},"type":"object","required":["id","object","model","filename","processed_at","usage","language","duration_seconds","text","dialog","audio_events","event_types","word_count","input"],"title":"TranscriptionResponse"},"TranscriptionUsage":{"properties":{"audio_seconds":{"type":"number","title":"Audio Seconds","description":"Actual audio duration processed in seconds"},"credits_consumed":{"type":"integer","title":"Credits Consumed","description":"Number of credits consumed in this request"},"processing_ms":{"type":"integer","title":"Processing Ms","description":"Total processing time in milliseconds"}},"type":"object","required":["audio_seconds","credits_consumed","processing_ms"],"title":"TranscriptionUsage"},"UpdateEmailAlertRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"events":{"anyOf":[{"items":{"$ref":"#/components/schemas/EmailEvent"},"type":"array"},{"type":"null"}],"title":"Events"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"}},"type":"object","title":"UpdateEmailAlertRequest"},"UpdateWebhookRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Nome identificador"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"URL HTTPS destino"},"events":{"anyOf":[{"items":{"$ref":"#/components/schemas/WebhookEvent"},"type":"array"},{"type":"null"}],"title":"Events","description":"Eventos subscritos"},"retry_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Retry Enabled","description":"Habilita retry exponencial"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active","description":"Ativa/desativa sem deletar"}},"type":"object","title":"UpdateWebhookRequest"},"UsageByKeyItem":{"properties":{"key_id":{"type":"string","title":"Key Id","description":"API key id"},"key_name":{"type":"string","title":"Key Name","description":"API key name"},"total_credits":{"type":"integer","title":"Total Credits","description":"Total credits consumed by the key"},"request_count":{"type":"integer","title":"Request Count","description":"Number of requests"},"last_used":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Used","description":"ISO 8601 of last use (null if never)"}},"type":"object","required":["key_id","key_name","total_credits","request_count"],"title":"UsageByKeyItem"},"UsageLogItem":{"properties":{"id":{"type":"string","title":"Id","description":"Usage log entry id"},"endpoint":{"type":"string","title":"Endpoint","description":"Endpoint called"},"credits_cost":{"type":"integer","title":"Credits Cost","description":"Credits consumed"},"status":{"type":"string","title":"Status","description":"Result status"},"errors_count":{"type":"integer","title":"Errors Count","description":"Errors count"},"created_at":{"type":"string","title":"Created At","description":"ISO 8601 timestamp"}},"type":"object","required":["id","endpoint","credits_cost","status","errors_count","created_at"],"title":"UsageLogItem"},"UsageLogResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/UsageLogItem"},"type":"array","title":"Data"},"page":{"type":"integer","title":"Page"},"limit":{"type":"integer","title":"Limit"}},"type":"object","required":["data","page","limit"],"title":"UsageLogResponse"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VersionResponse":{"properties":{"service":{"type":"string","title":"Service","description":"Service name"},"version":{"type":"string","title":"Version","description":"Current API version"},"deployDate":{"type":"string","title":"Deploydate","description":"Deploy timestamp"}},"type":"object","required":["service","version","deployDate"],"title":"VersionResponse"},"WebhookEvent":{"type":"string","enum":["subscription.created","avulso.completed","subscription.upgraded","subscription.downgraded","subscription.canceled","credits.low","credits.exhausted","subscription.renewed","subscription.expired","payment.failed"],"title":"WebhookEvent"},"WebhookItem":{"properties":{"id":{"type":"string","title":"Id","description":"Webhook id"},"user_id":{"type":"string","title":"User Id","description":"Owner user id"},"name":{"type":"string","title":"Name","description":"Webhook name"},"url":{"type":"string","title":"Url","description":"Destination URL"},"secret":{"type":"string","title":"Secret","description":"HMAC signing secret"},"events":{"items":{"type":"string"},"type":"array","title":"Events","description":"Subscribed events"},"active":{"type":"boolean","title":"Active","description":"Is active"},"retry_enabled":{"type":"boolean","title":"Retry Enabled","description":"Retry enabled"},"last_delivery_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Delivery At","description":"ISO 8601 of last delivery"},"last_status":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Last Status","description":"Last HTTP status delivered"},"failure_count":{"type":"integer","title":"Failure Count","description":"Consecutive failures","default":0},"created_at":{"type":"string","title":"Created At","description":"ISO 8601 created"},"updated_at":{"type":"string","title":"Updated At","description":"ISO 8601 updated"}},"type":"object","required":["id","user_id","name","url","secret","events","active","retry_enabled","created_at","updated_at"],"title":"WebhookItem"},"WebhookListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WebhookItem"},"type":"array","title":"Data"},"page":{"type":"integer","title":"Page"},"limit":{"type":"integer","title":"Limit"}},"type":"object","required":["data","page","limit"],"title":"WebhookListResponse"},"WhatsappConversation":{"properties":{"conversation_id":{"type":"string","title":"Conversation Id","description":"Conversation identifier in the batch"},"first_at":{"type":"string","title":"First At","description":"Real start (wall-clock, ISO)"},"last_at":{"type":"string","title":"Last At","description":"Real end (wall-clock, ISO)"},"duration_seconds":{"type":"number","title":"Duration Seconds","description":"(last - first) + last turn duration"},"speakers":{"items":{"$ref":"#/components/schemas/WhatsappSpeaker"},"type":"array","title":"Speakers","description":"Speakers of THIS conversation (dynamic)"},"dialog":{"type":"string","title":"Dialog","description":"Lines 'Speaker N: [HH:MM:SS.mmm - HH:MM:SS.mmm] text' (real offset)"},"message_count":{"type":"integer","title":"Message Count","description":"Number of messages"},"characters":{"type":"integer","title":"Characters","description":"Total characters of the conversation"}},"type":"object","required":["conversation_id","first_at","last_at","duration_seconds","speakers","dialog","message_count","characters"],"title":"WhatsappConversation"},"WhatsappConversationsResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier. Prefix 'wc-' + UUID"},"object":{"type":"string","title":"Object","description":"Object type. Always 'conversations'"},"usage":{"$ref":"#/components/schemas/WhatsappUsage","description":"Usage and processing information"},"conversations":{"items":{"$ref":"#/components/schemas/WhatsappConversation"},"type":"array","title":"Conversations","description":"Segmented conversations"},"client_reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Reference Id","description":"Client-supplied ID echoed verbatim (if provided)"},"meta":{"$ref":"#/components/schemas/WhatsappMeta","description":"Segmentation parameters and counts"}},"type":"object","required":["id","object","usage","conversations","meta"],"title":"WhatsappConversationsResponse"},"WhatsappMeta":{"properties":{"file":{"type":"string","title":"File","description":"Uploaded file name"},"chat_txt":{"type":"string","title":"Chat Txt","description":"chat.txt entry name inside the export"},"format":{"type":"string","title":"Format","description":"Detected format: Android | iOS"},"date_format":{"type":"string","title":"Date Format","description":"Date order used"},"timezone":{"type":"string","title":"Timezone","description":"Timezone informed"},"start":{"type":"string","title":"Start","description":"Window start (ISO)"},"end":{"type":"string","title":"End","description":"Window end (ISO)"},"gap_minutes":{"type":"number","title":"Gap Minutes","description":"Gap used to split conversations"},"min_messages":{"type":"integer","title":"Min Messages","description":"Minimum messages per conversation"},"chars_per_minute":{"type":"number","title":"Chars Per Minute","description":"Chars per minute used to estimate duration"},"turns":{"type":"integer","title":"Turns","description":"Total parsed turns"},"system_lines":{"type":"integer","title":"System Lines","description":"System lines ignored"},"conversations_total":{"type":"integer","title":"Conversations Total","description":"Conversations before window filter"},"conversations_in_window":{"type":"integer","title":"Conversations In Window","description":"Conversations overlapping the window"},"monologues_dropped":{"type":"integer","title":"Monologues Dropped","description":"Single-speaker conversations dropped"},"conversations_selected":{"type":"integer","title":"Conversations Selected","description":"Final conversations returned"}},"type":"object","required":["file","chat_txt","format","date_format","timezone","start","end","gap_minutes","min_messages","chars_per_minute","turns","system_lines","conversations_total","conversations_in_window","monologues_dropped","conversations_selected"],"title":"WhatsappMeta"},"WhatsappSpeaker":{"properties":{"label":{"type":"string","title":"Label","description":"Speaker label (e.g. 'Speaker 1')"},"name":{"type":"string","title":"Name","description":"Participant name from the export"}},"type":"object","required":["label","name"],"title":"WhatsappSpeaker"},"WhatsappUsage":{"properties":{"conversations":{"type":"integer","title":"Conversations","description":"Number of conversations returned"},"characters":{"type":"integer","title":"Characters","description":"Total characters across conversations"},"credits_consumed":{"type":"integer","title":"Credits Consumed","description":"Credits consumed (1 per conversation)"},"processing_ms":{"type":"integer","title":"Processing Ms","description":"Total processing time in milliseconds"}},"type":"object","required":["conversations","characters","credits_consumed","processing_ms"],"title":"WhatsappUsage"}},"securitySchemes":{"ApiKeyAuth":{"type":"http","scheme":"bearer","bearerFormat":"fai_xxx","description":"Enter your API Key (fai_...)"}}},"servers":[{"url":"https://api01-falaai.action.tec.br","description":"FalaAI API - producao"}],"security":[{"ApiKeyAuth":[]}]}},"searchIndex":{"store":["tag/speech","tag/speech/operation/create_transcription_v1_audio_transcriptions_post","tag/analysis","tag/analysis/operation/create_diagnostic_v1_analyze_diagnostic_post","tag/analysis/operation/create_risk_audit_v1_analyze_riskAudit_post","tag/usage","tag/usage/operation/get_usage_log_v1_usage_log_get","tag/usage/operation/get_usage_by_key_v1_usage_by_key_get","tag/webhooks","tag/webhooks/operation/list_webhooks_v1_webhooks_get","tag/webhooks/operation/create_webhook_v1_webhooks_post","tag/webhooks/operation/update_webhook_v1_webhooks__webhook_id__put","tag/webhooks/operation/delete_webhook_v1_webhooks__webhook_id__delete","tag/email-alerts","tag/email-alerts/operation/list_email_alerts_v1_email_alerts_get","tag/email-alerts/operation/create_email_alert_v1_email_alerts_post","tag/email-alerts/operation/update_email_alert_v1_email_alerts__alert_id__put","tag/email-alerts/operation/delete_email_alert_v1_email_alerts__alert_id__delete","tag/whatsapp","tag/whatsapp/operation/extract_conversations_v1_whatsapp_extractConversations_post","tag/version","tag/version/operation/get_version_api_version_get","tag/health","tag/health/operation/health_check","tag/health/operation/health_check_head"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,3.733]],["description/0",[]],["title/1",[1,2.568,2,2.568,3,2.568]],["description/1",[4,3.761]],["title/2",[5,3.064]],["description/2",[]],["title/3",[6,1.581,7,1.581,8,1.581,9,1.298,10,1.581,11,1.581,12,1.581]],["description/3",[13,3.761]],["title/4",[5,1.298,9,1.298,14,2.526,15,1.581,16,1.581,17,1.298]],["description/4",[18,3.761]],["title/5",[19,2.624]],["description/5",[]],["title/6",[19,2.139,20,3.042]],["description/6",[21,3.761]],["title/7",[19,2.139,22,3.042]],["description/7",[23,3.761]],["title/8",[24,1.627]],["description/8",[]],["title/9",[24,1.326,25,2.139]],["description/9",[24,0.4,25,0.646,26,0.918,27,0.918,28,0.646,29,0.4,30,0.918,31,0.918,32,0.918,33,0.918,34,0.754,35,0.918,36,0.918,37,0.918,38,0.754]],["title/10",[24,1.326,39,2.139]],["description/10",[28,0.508,29,0.565,34,0.594,38,0.594,39,0.508,40,0.594,41,0.594,42,0.723,43,0.723,44,0.723,45,0.723,46,0.723,47,0.723,48,0.723,49,0.723,50,0.723,51,0.723,52,0.723,53,0.723]],["title/11",[24,1.326,54,2.139]],["description/11",[28,1.038,29,0.643,41,1.212,54,1.038,55,1.476,56,1.476,57,1.476,58,1.212]],["title/12",[24,1.326,59,2.139]],["description/12",[24,0.87,40,1.639,58,1.639,59,1.403,60,1.996]],["title/13",[61,3.733]],["description/13",[]],["title/14",[25,1.805,29,1.119,62,1.579]],["description/14",[63,3.087]],["title/15",[29,1.119,39,1.805,62,1.579]],["description/15",[63,3.087]],["title/16",[29,1.119,54,1.805,62,1.579]],["description/16",[64,3.087]],["title/17",[29,1.119,59,1.805,62,1.579]],["description/17",[64,3.087]],["title/18",[65,3.064]],["description/18",[]],["title/19",[17,1.607,65,1.607,66,1.957,67,1.957,68,1.957]],["description/19",[69,3.761]],["title/20",[70,3.064]],["description/20",[]],["title/21",[70,3.064]],["description/21",[71,3.761]],["title/22",[72,2.624]],["description/22",[]],["title/23",[72,2.139,73,2.498]],["description/23",[74,3.087]],["title/24",[72,2.139,73,2.498]],["description/24",[74,3.087]]],"invertedIndex":[["",{"_index":9,"title":{"3":{},"4":{}},"description":{}}],["10",{"_index":28,"title":{},"description":{"9":{},"10":{},"11":{}}}],["5",{"_index":10,"title":{"3":{}},"description":{}}],["alert",{"_index":29,"title":{"14":{},"15":{},"16":{},"17":{}},"description":{"9":{},"10":{},"11":{}}}],["alway",{"_index":35,"title":{},"description":{"9":{}}}],["analys",{"_index":12,"title":{"3":{}},"description":{}}],["analysi",{"_index":5,"title":{"2":{},"4":{}},"description":{}}],["analyz",{"_index":6,"title":{"3":{}},"description":{}}],["api/vers",{"_index":71,"title":{},"description":{"21":{}}}],["audio",{"_index":2,"title":{"1":{}},"description":{}}],["audit",{"_index":16,"title":{"4":{}},"description":{}}],["authent",{"_index":26,"title":{},"description":{"9":{}}}],["call",{"_index":7,"title":{"3":{}},"description":{}}],["check",{"_index":73,"title":{"23":{},"24":{}},"description":{}}],["complianc",{"_index":14,"title":{"4":{}},"description":{}}],["convers",{"_index":17,"title":{"4":{},"19":{}},"description":{}}],["creat",{"_index":39,"title":{"10":{},"15":{}},"description":{"10":{}}}],["data",{"_index":45,"title":{},"description":{"10":{}}}],["delet",{"_index":59,"title":{"12":{},"17":{}},"description":{"12":{}}}],["deliv",{"_index":43,"title":{},"description":{"10":{}}}],["email",{"_index":62,"title":{"14":{},"15":{},"16":{},"17":{}},"description":{}}],["email-alert",{"_index":61,"title":{"13":{}},"description":{}}],["event",{"_index":41,"title":{},"description":{"10":{},"11":{}}}],["export",{"_index":68,"title":{"19":{}},"description":{}}],["extract",{"_index":66,"title":{"19":{}},"description":{}}],["falaai-signatur",{"_index":48,"title":{},"description":{"10":{}}}],["health",{"_index":72,"title":{"22":{},"23":{},"24":{}},"description":{}}],["hmac",{"_index":47,"title":{},"description":{"10":{}}}],["hmac-sha256",{"_index":52,"title":{},"description":{"10":{}}}],["id",{"_index":60,"title":{},"description":{"12":{}}}],["includ",{"_index":31,"title":{},"description":{"9":{}}}],["key",{"_index":22,"title":{"7":{}},"description":{}}],["list",{"_index":25,"title":{"9":{},"14":{}},"description":{"9":{}}}],["log",{"_index":20,"title":{"6":{}},"description":{}}],["name/url/events/retry_enabled/act",{"_index":56,"title":{},"description":{"11":{}}}],["origin",{"_index":50,"title":{},"description":{"10":{}}}],["owner",{"_index":37,"title":{},"description":{"9":{}}}],["pagin",{"_index":30,"title":{},"description":{"9":{}}}],["parallel",{"_index":11,"title":{"3":{}},"description":{}}],["payload",{"_index":42,"title":{},"description":{"10":{}}}],["recomput",{"_index":51,"title":{},"description":{"10":{}}}],["risk",{"_index":15,"title":{"4":{}},"description":{}}],["secret",{"_index":34,"title":{},"description":{"9":{},"10":{}}}],["segment",{"_index":67,"title":{"19":{}},"description":{}}],["signatur",{"_index":33,"title":{},"description":{"9":{}}}],["speech",{"_index":0,"title":{"0":{}},"description":{}}],["subscript",{"_index":40,"title":{},"description":{"10":{},"12":{}}}],["text",{"_index":3,"title":{"1":{}},"description":{}}],["timestamp",{"_index":46,"title":{},"description":{"10":{}}}],["timestamp.bodi",{"_index":53,"title":{},"description":{"10":{}}}],["transcrib",{"_index":1,"title":{"1":{}},"description":{}}],["transcript",{"_index":8,"title":{"3":{}},"description":{}}],["updat",{"_index":54,"title":{"11":{},"16":{}},"description":{"11":{}}}],["url",{"_index":32,"title":{},"description":{"9":{}}}],["usag",{"_index":19,"title":{"5":{},"6":{},"7":{}},"description":{}}],["user'",{"_index":27,"title":{},"description":{"9":{}}}],["v1/analyze/diagnost",{"_index":13,"title":{},"description":{"3":{}}}],["v1/analyze/riskaudit",{"_index":18,"title":{},"description":{"4":{}}}],["v1/audio/transcript",{"_index":4,"title":{},"description":{"1":{}}}],["v1/email-alert",{"_index":63,"title":{},"description":{"14":{},"15":{}}}],["v1/email-alerts/{alert_id",{"_index":64,"title":{},"description":{"16":{},"17":{}}}],["v1/health",{"_index":74,"title":{},"description":{"23":{},"24":{}}}],["v1/usage/by-key",{"_index":23,"title":{},"description":{"7":{}}}],["v1/usage/log",{"_index":21,"title":{},"description":{"6":{}}}],["v1/webhook",{"_index":38,"title":{},"description":{"9":{},"10":{}}}],["v1/webhooks/{webhook_id",{"_index":58,"title":{},"description":{"11":{},"12":{}}}],["v1/whatsapp/extractconvers",{"_index":69,"title":{},"description":{"19":{}}}],["valid",{"_index":57,"title":{},"description":{"11":{}}}],["verifi",{"_index":49,"title":{},"description":{"10":{}}}],["version",{"_index":70,"title":{"20":{},"21":{}},"description":{}}],["visibl",{"_index":36,"title":{},"description":{"9":{}}}],["webhook",{"_index":24,"title":{"8":{},"9":{},"10":{},"11":{},"12":{}},"description":{"9":{},"12":{}}}],["webhook'",{"_index":55,"title":{},"description":{"11":{}}}],["webhookpayload(ev",{"_index":44,"title":{},"description":{"10":{}}}],["whatsapp",{"_index":65,"title":{"18":{},"19":{}},"description":{}}]],"pipeline":[]}},"options":{"hideRequestPayloadSample":true}};
|
|
751
754
|
|
|
752
755
|
var container = document.getElementById('redoc');
|
|
753
756
|
Redoc.hydrate(__redoc_state, container);
|