Ottieni questo documento

Versione API 2026-10-affable-towhee

get https://api.getlingara.com/v1/openapi.json

Restituisce questa descrizione dell'API in JSON, per la versione dell'API con cui si risponde alla richiesta: quella indicata in Lingara-Version, altrimenti la versione corrente. Non serve alcun token.

Scope Nessuna autenticazione richiesta

Parametri

Lingara-Versionheaderstringfacoltativo: La versione dell'API con cui rispondere a questa richiesta. Senza di essa, un token di accesso riceve la versione a cui è associato il suo client e una richiesta senza token riceve la versione corrente. La versione ancora in sviluppo si raggiunge solo indicandola qui. Una versione sconosciuta risponde 400 con il codice api_version_unknown. GET /v1/versions elenca le versioni.

Risposte

200 Il documento OpenAPI

Errori

410application/json: La versione dell'API con cui si risponde a questa richiesta è stata dismessa. Invia una versione supportata in Lingara-Version, oppure associa il client a un'altra versione.
4XXapplication/json: La richiesta è stata rifiutata. code dice il motivo, e error lo spiega a parole.
503application/json · text/plain: Il servizio è temporaneamente non disponibile; riprova dopo il numero di secondi indicato in Retry-After. Durante la manutenzione il corpo è testo semplice anziché l'envelope di errore.

codestringobbligatorio: Perché la richiesta è stata rifiutata, come codice stabile su cui diramare la logica: per esempio insufficient_scope (403), rate_limited (429) e, per un client con fatturazione a consumo, spend_cap_reached (402) e metered_billing_inactive (402).
errorstringobbligatorio

Esempio

curlTypeScriptRustGoJavaKotlinRubyPHP

curl

curl "https://api.getlingara.com/v1/openapi.json"

TypeScript

const document = await client.getOpenApiDocument();
console.log(document.servedVersion, Object.keys(document));

Rust

let document = client.get_open_api_document().await?;
let keys: Vec<&String> = document.as_object().map(|o| o.keys().collect()).unwrap_or_default();
println!("{:?} {keys:?}", document.served_version());

doc, err := client.GetOpenAPIDocument(ctx)
if err != nil {
	return err
}
fmt.Println(doc.Value["openapi"], doc.ServedVersion)

Java

import com.fasterxml.jackson.databind.JsonNode;
import com.getlingara.client.LingaraClient;

JsonNode document = client.getOpenApiDocument().body();
System.out.println(document.path("info").path("version").asText());

Kotlin

import com.getlingara.kotlin.LingaraClient
import kotlinx.serialization.json.jsonObject
import kotlinx.serialization.json.jsonPrimitive

val document = client.getOpenApiDocument().body
println(
    document
        .getValue("info")
        .jsonObject
        .getValue("version")
        .jsonPrimitive.content,
)

Ruby

document = client.get_open_api_document
puts "#{document.value["openapi"]} #{document.served_version}"

PHP

// Needs no token: a client built without credentials can call it.
$document = $client->getOpenApiDocument()->value;
echo $document->info->title, ' ', $document->info->version, "\n";

Preferisci una libreria? Vedi la sezione Librerie.

In caso di discrepanza tra una traduzione e il riferimento in inglese, fa fede il riferimento in inglese.