Get S2S Time Status

curl --request GET \
  --url https://secureai.hiperai.ai/api/external/speech/s2s/status \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

{
  "success": true,
  "remaining_minutes": 38.2896,
  "total_minutes": 45,
  "used_minutes": 6.7104,
  "has_time_remaining": true,
  "next_renewal_date": "2025-12-01T12:55:35.721Z",
  "non_renewable": false,
  "request_id": "a8c307b4-c0c9-4b30-98db-5aced06c1cfe"
}

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

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

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

GET

speech

s2s

status

Get S2S Time Status

curl --request GET \
  --url https://secureai.hiperai.ai/api/external/speech/s2s/status \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

{
  "success": true,
  "remaining_minutes": 38.2896,
  "total_minutes": 45,
  "used_minutes": 6.7104,
  "has_time_remaining": true,
  "next_renewal_date": "2025-12-01T12:55:35.721Z",
  "non_renewable": false,
  "request_id": "a8c307b4-c0c9-4b30-98db-5aced06c1cfe"
}

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

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

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

Obtener estado de tiempo S2S

Recupere el estado de tiempo actual de voz a voz (S2S) para el usuario de facturación.

Endpoint

GET /speech/s2s/status

Descripción

Recupere el estado actual del tiempo de Voz a Voz (S2S) para el usuario de facturación, incluido el tiempo restante, el límite mensual total, el tiempo utilizado y la información de renovación.

Cuotas de tiempo S2S

Las cuotas se basan en el nivel de licencia del usuario.
El tiempo se restablece mensualmente según la fecha de asignación de la licencia.
Las licencias de prueba no renovables no se restablecen automáticamente

Autenticación

Requerido: Clave API

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

Parámetros de consulta

Parámetro	Tipo	Requerido	Descripción
`user_id`	cadena	No	ID de usuario para verificar el estado (el valor predeterminado es el propietario de la clave API)

Ejemplo de solicitud

curl -X GET "https://{customer.name}.hiperai.ai/api/external/speech/s2s/status?user_id=60a7c8f5e8b4f5001f7a8c23" \
  -H "Authorization: Bearer sk-your-api-key-here"

JavaScript/Node.js

const response = await fetch('https://{customer.name}.hiperai.ai/api/external/speech/s2s/status?user_id=60a7c8f5e8b4f5001f7a8c23', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer sk-your-api-key-here'
  }
});

const data = await response.json();
console.log('Remaining minutes:', data.remaining_minutes);
console.log('Total minutes:', data.total_minutes);
console.log('Used minutes:', data.used_minutes);

Pitón

import requests

url = "https://{customer.name}.hiperai.ai/api/external/speech/s2s/status"
headers = {
    "Authorization": "Bearer sk-your-api-key-here"
}
params = {
    "user_id": "60a7c8f5e8b4f5001f7a8c23"
}

response = requests.get(url, headers=headers, params=params)
result = response.json()
print('Remaining minutes:', result['remaining_minutes'])
print('Total minutes:', result['total_minutes'])
print('Used minutes:', result['used_minutes'])

Respuesta

Respuesta exitosa (200)

{
  "success": true,
  "remaining_minutes": 38.2896,
  "total_minutes": 45,
  "used_minutes": 6.7104,
  "has_time_remaining": true,
  "next_renewal_date": "2025-12-01T12:55:35.721Z",
  "non_renewable": false,
  "request_id": "a8c307b4-c0c9-4b30-98db-5aced06c1cfe"
}

Campos de respuesta

Campo	Tipo	Descripción
`success`	booleano	Siempre es cierto para solicitudes exitosas
`remaining_minutes`	número	Tiempo restante de S2S en minutos
`total_minutes`	número	Límite de tiempo total mensual S2S
`used_minutes`	número	Tiempo S2S usado este mes
`has_time_remaining`	booleano	Si al usuario le queda tiempo S2S
`next_renewal_date`	cadena\|nulo	Cuándo se restablecerá la cuota de tiempo S2S (nula para licencias no renovables)
`non_renewable`	booleano	Si se trata de una licencia de prueba no renovable
`request_id`	cadena	Solicitar ID para seguimiento

Respuestas de error

400 Solicitud incorrecta

{
  "success": false,
  "error": "Invalid user_id",
  "message": "The specified user_id is invalid"
}

401 No autorizado

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

404 no encontrado

{
  "success": false,
  "error": "User not found",
  "message": "The specified user_id does not exist"
}

500 Error interno del servidor

{
  "success": false,
  "error": "Internal server error",
  "message": "An unexpected error occurred"
}

Notas

Verifique este endpoint antes de iniciar sesiones S2S para garantizar que haya suficiente tiempo disponible
El parámetro user_id permite verificar el estado de un usuario diferente (el valor predeterminado es el propietario de la clave API)
Las cuotas de tiempo se basan en el nivel de licencia del usuario.
Las licencias de prueba no renovables tendrán non_renewable: true y next_renewal_date: null

Autorizaciones

Authorization

string

header

requerido

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

Parámetros de consulta

user_id

string

Optional user ID to check status for (defaults to API key owner)

Ejemplo:

"60a7c8f5e8b4f5001f7a8c23"

Respuesta

S2S time status

success

boolean

Ejemplo:

true

remaining_minutes

number

Remaining S2S time in minutes

Ejemplo:

38.2896

total_minutes

number

Total monthly S2S time limit

Ejemplo:

45

used_minutes

number

Used S2S time this month

Ejemplo:

6.7104

has_time_remaining

boolean

Whether user has any remaining S2S time

Ejemplo:

true

next_renewal_date

string<date-time>

When the S2S time quota will reset (null for non-renewable licenses)

Ejemplo:

"2025-12-01T12:55:35.721Z"

non_renewable

boolean

Whether this is a non-renewable trial license

Ejemplo:

false

request_id

string

Request ID for tracking

Ejemplo:

"a8c307b4-c0c9-4b30-98db-5aced06c1cfe"

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

Estado de Sesión Speech-to-Speech

Obtener estado de tiempo S2S

Endpoint

Descripción

Cuotas de tiempo S2S

Autenticación

Parámetros de consulta

Ejemplo de solicitud

JavaScript/Node.js

Pitón

Respuesta

Respuesta exitosa (200)

Campos de respuesta

Respuestas de error

400 Solicitud incorrecta

401 No autorizado

404 no encontrado

500 Error interno del servidor

Notas

Autorizaciones

Parámetros de consulta

Respuesta

​Obtener estado de tiempo S2S

​Endpoint

​Descripción

​Cuotas de tiempo S2S

​Autenticación

​Parámetros de consulta

​Ejemplo de solicitud

​JavaScript/Node.js

​Pitón

​Respuesta

​Respuesta exitosa (200)

​Campos de respuesta

​Respuestas de error

​400 Solicitud incorrecta

​401 No autorizado

​404 no encontrado

​500 Error interno del servidor

​Notas

Autorizaciones

Parámetros de consulta

Respuesta

Obtener estado de tiempo S2S

Endpoint

Descripción

Cuotas de tiempo S2S

Autenticación

Parámetros de consulta

Ejemplo de solicitud

JavaScript/Node.js

Pitón

Respuesta

Respuesta exitosa (200)

Campos de respuesta

Respuestas de error

400 Solicitud incorrecta

401 No autorizado

404 no encontrado

500 Error interno del servidor

Notas