GET/api/v1/me

Obtiene informacion del usuario autenticado, incluyendo creditos disponibles, suscripcion activa y estadisticas de uso de la API Key.

Ejemplo de Request

curl https://gen.zui.es/api/v1/me \
-H "Authorization: Bearer YOUR_API_KEY"

Response

200 OKjson
{
"user": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"email": "usuario@ejemplo.com",
"name": "Juan Garcia"
},
"credits": {
"balance": 500,
"used_this_key": 150
},
"subscription": {
"status": "active",
"plan": "Pro",
"credits_per_month": 1000,
"billing_interval": "month",
"current_period_end": "2025-02-01T00:00:00Z",
"cancel_at_period_end": false
},
"api_key": {
"id": "key_abc123",
"name": "Production Key",
"requests_count": 542
}
}

Campos de Respuesta

Objeto User

CampoTipoDescripcion
idstringUUID del usuario
emailstringEmail del usuario
namestring | nullNombre completo del usuario

Objeto Credits

CampoTipoDescripcion
balancenumberCreditos disponibles actualmente
used_this_keynumberCreditos consumidos con esta API Key

Objeto Subscription

CampoTipoDescripcion
statusstring"active", "canceled", "past_due"
planstringNombre del plan (Starter, Pro, Enterprise)
credits_per_monthnumberCreditos incluidos en el plan mensualmente
billing_intervalstring"month" o "year"
current_period_endstringFecha de fin del periodo actual (ISO 8601)
cancel_at_period_endbooleanSi esta programada la cancelacion

Objeto API Key

CampoTipoDescripcion
idstringID de la API Key usada
namestringNombre asignado a la API Key
requests_countnumberTotal de peticiones realizadas con esta key

Casos de Uso

  • Verificar que tu API Key es valida
  • Mostrar el saldo de creditos al usuario
  • Comprobar el estado de la suscripcion
  • Monitorizar el uso de la API Key

Nota

Si el usuario no tiene una suscripcion activa, el campo subscription sera null. En este caso, no podra realizar generaciones hasta activar un plan.