Log S2S Session Duration

curl --request POST \
  --url https://secureai.hiperai.ai/api/external/speech/s2s/log-session \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "durationMs": 42624,
  "user_id": "60a7c8f5e8b4f5001f7a8c23"
}
'

import requests

url = "https://secureai.hiperai.ai/api/external/speech/s2s/log-session"

payload = {
    "durationMs": 42624,
    "user_id": "60a7c8f5e8b4f5001f7a8c23"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({durationMs: 42624, user_id: '60a7c8f5e8b4f5001f7a8c23'})
};

fetch('https://secureai.hiperai.ai/api/external/speech/s2s/log-session', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "message": "S2S session logged successfully",
  "request_id": "3fb8d444-2242-4764-9202-8e9e72464192"
}

{
  "success": false,
  "error": "Invalid user_id",
  "message": "The specified user_id does not exist",
  "request_id": "3fb8d444-2242-4764-9202-8e9e72464192"
}

{
  "success": false,
  "error": "Failed to log S2S session",
  "message": "An error occurred while logging the session",
  "request_id": "3fb8d444-2242-4764-9202-8e9e72464192"
}

Modelos y Generación AI

Registrar Sesión Speech-to-Speech

Log the duration of a completed Speech-to-Speech session and deduct the time from the user’s S2S time quota. This should be called after a session ends to track usage accurately.

Usage Tracking:

Duration is specified in milliseconds
Automatically converted to minutes and deducted from user’s quota
Time is tracked per-user based on license tier
Activity logs are created for audit purposes

POST

speech

s2s

log-session

Log S2S Session Duration

curl --request POST \
  --url https://secureai.hiperai.ai/api/external/speech/s2s/log-session \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "durationMs": 42624,
  "user_id": "60a7c8f5e8b4f5001f7a8c23"
}
'

import requests

url = "https://secureai.hiperai.ai/api/external/speech/s2s/log-session"

payload = {
    "durationMs": 42624,
    "user_id": "60a7c8f5e8b4f5001f7a8c23"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({durationMs: 42624, user_id: '60a7c8f5e8b4f5001f7a8c23'})
};

fetch('https://secureai.hiperai.ai/api/external/speech/s2s/log-session', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "message": "S2S session logged successfully",
  "request_id": "3fb8d444-2242-4764-9202-8e9e72464192"
}

{
  "success": false,
  "error": "Invalid user_id",
  "message": "The specified user_id does not exist",
  "request_id": "3fb8d444-2242-4764-9202-8e9e72464192"
}

{
  "success": false,
  "error": "Failed to log S2S session",
  "message": "An error occurred while logging the session",
  "request_id": "3fb8d444-2242-4764-9202-8e9e72464192"
}

Registrar duración de la sesión S2S

Registre la duración de una sesión de voz a voz completa y deduzca el tiempo de la cuota de tiempo S2S del usuario.

Endpoint

POST /speech/s2s/log-session

Descripción

Registre la duración de una sesión de voz a voz completa y deduzca el tiempo de la cuota de tiempo S2S del usuario. Esto debe llamarse después de que finalice una sesión para realizar un seguimiento del uso con precisión.

Seguimiento de uso

La duración se especifica en milisegundos.
Convertido automáticamente a minutos y deducido de la cuota del usuario.
El tiempo se rastrea por usuario según el nivel de licencia
Los registros de actividad se crean con fines de auditoría.

Autenticación

Requerido: Clave API

Authorization: Bearer sk-your-api-key-here

Cuerpo de solicitud

Parámetro	Tipo	Requerido	Descripción
`durationMs`	entero	Sí	Duración de la sesión en milisegundos (mínimo: 0)
`user_id`	cadena	No	ID de usuario al que facturar esta sesión (el valor predeterminado es el propietario de la clave API)

Ejemplo de solicitud

curl -X POST "https://{customer.name}.hiperai.ai/api/external/speech/s2s/log-session" \
  -H "Authorization: Bearer sk-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "durationMs": 42624,
    "user_id": "60a7c8f5e8b4f5001f7a8c23"
  }'

JavaScript/Node.js

// Calculate session duration in milliseconds
const sessionStartTime = Date.now();
// ... session happens ...
const sessionEndTime = Date.now();
const durationMs = sessionEndTime - sessionStartTime;

const response = await fetch('https://{customer.name}.hiperai.ai/api/external/speech/s2s/log-session', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk-your-api-key-here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    durationMs: durationMs,
    user_id: '60a7c8f5e8b4f5001f7a8c23'
  })
});

const data = await response.json();
console.log('Session logged:', data.message);

Pitón

import requests
import time

# Calculate session duration
session_start = time.time() * 1000  # Convert to milliseconds
# ... session happens ...
session_end = time.time() * 1000
duration_ms = int(session_end - session_start)

url = "https://{customer.name}.hiperai.ai/api/external/speech/s2s/log-session"
headers = {
    "Authorization": "Bearer sk-your-api-key-here",
    "Content-Type": "application/json"
}
data = {
    "durationMs": duration_ms,
    "user_id": "60a7c8f5e8b4f5001f7a8c23"
}

response = requests.post(url, headers=headers, json=data)
result = response.json()
print('Session logged:', result['message'])

Respuesta

Respuesta exitosa (200)

{
  "success": true,
  "message": "S2S session logged successfully",
  "request_id": "3fb8d444-2242-4764-9202-8e9e72464192"
}

Campos de respuesta

Campo	Tipo	Descripción
`success`	booleano	Siempre es cierto para solicitudes exitosas
`message`	cadena	Mensaje de éxito
`request_id`	cadena	Solicitar ID para seguimiento

Respuestas de error

400 Solicitud incorrecta

{
  "success": false,
  "error": "Invalid user_id",
  "message": "The specified user_id does not exist",
  "request_id": "3fb8d444-2242-4764-9202-8e9e72464192"
}

401 No autorizado

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked"
}

500 Error interno del servidor

{
  "success": false,
  "error": "Failed to log S2S session",
  "message": "An error occurred while logging the session",
  "request_id": "3fb8d444-2242-4764-9202-8e9e72464192"
}

Notas

Llame a este endpoint después de que finalice cada sesión S2S para realizar un seguimiento preciso del uso.
La duración debe calcularse desde que se establece la conexión WebRTC hasta que se cierra
El tiempo se convierte automáticamente de milisegundos a minutos y se deduce de la cuota del usuario.
El parámetro user_id permite facturar a una cuenta de usuario diferente
Los registros de actividad se crean automáticamente con fines de auditoría.
Asegúrese de tener suficiente tiempo restante antes de iniciar una sesión (consulte con /speech/s2s/status)

Autorizaciones

Authorization

string

header

requerido

API key authentication using Bearer token format. Example: Authorization: Bearer sk-your-api-key-here

Cuerpo

application/json

durationMs

integer

Session duration in milliseconds

Rango requerido: x >= 0

Ejemplo:

42624

user_id

string

Optional user ID to bill this session to (defaults to API key owner)

Ejemplo:

"60a7c8f5e8b4f5001f7a8c23"

Respuesta

Session logged successfully

success

boolean

Ejemplo:

true

message

string

Ejemplo:

"S2S session logged successfully"

request_id

string

Request ID for tracking

Ejemplo:

"3fb8d444-2242-4764-9202-8e9e72464192"

Primeros Pasos y Configuración

Modelos y Generación AI

Knowledge Base y RAG

Seguridad, Guardrails y Auditoría

Usuarios y Acceso (IAM)

Facturación, Cuotas y Webhooks

Registrar Sesión Speech-to-Speech

Registrar duración de la sesión S2S

Endpoint

Descripción

Seguimiento de uso

Autenticación

Cuerpo de solicitud

Ejemplo de solicitud

JavaScript/Node.js

Pitón

Respuesta

Respuesta exitosa (200)

Campos de respuesta

Respuestas de error

400 Solicitud incorrecta

401 No autorizado

500 Error interno del servidor

Notas

Autorizaciones

Cuerpo

Respuesta

​Registrar duración de la sesión S2S

​Endpoint

​Descripción

​Seguimiento de uso

​Autenticación

​Cuerpo de solicitud

​Ejemplo de solicitud

​JavaScript/Node.js

​Pitón

​Respuesta

​Respuesta exitosa (200)

​Campos de respuesta

​Respuestas de error

​400 Solicitud incorrecta

​401 No autorizado

​500 Error interno del servidor

​Notas

Autorizaciones

Cuerpo

Respuesta

Registrar duración de la sesión S2S

Endpoint

Descripción

Seguimiento de uso

Autenticación

Cuerpo de solicitud

Ejemplo de solicitud

JavaScript/Node.js

Pitón

Respuesta

Respuesta exitosa (200)

Campos de respuesta

Respuestas de error

400 Solicitud incorrecta

401 No autorizado

500 Error interno del servidor

Notas