Lingara Lingara ドキュメント 学習ガイド API ライブラリ アプリ 作成 ウェブ版
言語: 日本語

このドキュメントを取得

API バージョン 2026-10-affable-towhee

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

リクエストに応答する API バージョンについて、このAPIの説明を JSON で返します。Lingara-Version で指定したバージョン、指定がなければ現行バージョンです。トークンは不要です。

スコープ 認証は不要です

パラメーター

Lingara-Versionheaderstring任意
このリクエストに応答する API バージョン。指定がない場合、アクセストークンはそのクライアントに固定されたバージョンを、トークンのないリクエストは現行バージョンを受け取ります。開発中のバージョンには、ここで指定した場合にのみアクセスできます。不明なバージョンにはコード api_version_unknown とともに 400 を返します。GET /v1/versions でバージョンを一覧できます。

レスポンス

200 OpenAPI ドキュメント

エラー

410application/json
このリクエストに応答する API バージョンは提供を終了しました。Lingara-Version でサポート対象のバージョンを送るか、クライアントを別のバージョンに固定し直してください。
4XXapplication/json
リクエストは拒否されました。code が理由を示し、error がそれを文章で説明します。
503application/json · text/plain
サービスは一時的に利用できません。Retry-After に示された秒数が経過してから再試行してください。メンテナンス中は、本文はエラーエンベロープではなくプレーンテキストになります。
codestring必須

リクエストが拒否された理由を、分岐に使える安定したコードで示します。例:insufficient_scope(403)、rate_limited(429)、従量課金クライアントの場合は spend_cap_reached(402)と metered_billing_inactive(402)。

errorstring必須

例

コード例の言語

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());

Go

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";

ライブラリを使いたい場合は、ライブラリのセクションをご覧ください。

翻訳と英語版リファレンスの内容が異なる場合は、英語版リファレンスが正しいものとします。