Obtener tu cuota restante

Parámetros

Lingara-Versionheaderstringopcional

La versión de la API con la que se responde a esta solicitud. Sin ella, un token de acceso recibe la versión a la que está vinculado su cliente, y una solicitud sin token recibe la versión actual. La versión aún en desarrollo solo se alcanza nombrándola aquí. Una versión desconocida responde 400 con el código api_version_unknown. GET /v1/versions enumera las versiones.

Respuestas

200 Tu cuota

allowancearray of AllowanceRowobligatorio

featurestringobligatorio

windowstringobligatorio

limitintegerobligatorio

usedintegerobligatorio

remainingintegerobligatorio

reset_atinteger | nullopcional

ledgerUsageLedger | nullopcional

Las llamadas y unidades de este cliente desde la medianoche UTC del primer día del mes. Solo aparece en un cliente con facturación por uso, cuyas llamadas no gastan cuota. Puede ir hasta cinco segundos por detrás de tu última llamada.

sincestringobligatorio

callsintegerobligatorio

unitsintegerobligatorio

Errores

410application/json

La versión de la API con la que se responde a esta solicitud se ha retirado. Envía una versión admitida en Lingara-Version o vincula el cliente a otra versión.

4XXapplication/json

La solicitud fue rechazada. code indica el motivo y error lo explica con palabras.

503application/json · text/plain

El servicio no está disponible temporalmente; vuelve a intentarlo tras el número de segundos indicado en Retry-After. Durante el mantenimiento, el cuerpo es texto sin formato en lugar del sobre de error.

5XXapplication/json

La solicitud fue rechazada. code indica el motivo y error lo explica con palabras.

codestringobligatorio

Por qué se rechazó la solicitud, como un código estable con el que ramificar: por ejemplo insufficient_scope (403), rate_limited (429) y, para un cliente con facturación por uso, spend_cap_reached (402) y metered_billing_inactive (402).

errorstringobligatorio

Ejemplo

curl "https://api.getlingara.com/v1/usage" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

const usage = await client.getUsage();
for (const row of usage.allowance) {
  console.log(row.feature, row.window, `${row.remaining} of ${row.limit} left`);
}

let usage = client.get_usage().await?;
for row in &usage.allowance {
    println!("{} {}: {} of {} left", row.feature, row.window, row.remaining, row.limit);
}

usage, err := client.GetUsage(ctx)
if err != nil {
	return err
}
for _, row := range usage.Value.Allowance {
	fmt.Printf("%s (%s): %d of %d left\n", row.Feature, row.Window, row.Remaining, row.Limit)
}

import com.getlingara.client.model.AllowanceRow;
import com.getlingara.client.model.Usage;

Usage usage = client.getUsage().body();
for (AllowanceRow row : usage.getAllowance()) {
  System.out.println(
      row.getFeature()
          + " ("
          + row.getWindow()
          + "): "
          + row.getRemaining()
          + " of "
          + row.getLimit()
          + " left");
}

val usage = client.getUsage().body
for (row in usage.allowance) {
    println("${row.feature} (${row.window}): ${row.remaining} of ${row.limit} left")
}

usage = client.get_usage.value
usage.allowance.each { |row| puts "#{row.feature} (#{row.window}): #{row.remaining} of #{row.limit} left" }
puts "#{usage.ledger.calls} calls this month" if usage.ledger

foreach ($client->getUsage()->value->getAllowance() as $row) {
    echo $row->getFeature(), ': ', $row->getRemaining(), ' of ', $row->getLimit(), ' left this ', $row->getWindow(), "\n";
}

¿Prefieres una biblioteca? Consulta la sección Bibliotecas.