メインコンテンツへスキップ
Lnar API を使用すると、リポジトリの管理、コード分析の実行、コードの実行、インテグレーションの設定をプログラムで行うことができます。すべてのエンドポイントは HTTPS 上の JSON を使用します。

ベース URL

https://api.lnar.dev

バージョニング

すべてのリソースエンドポイントには /v1 プレフィックスが付きます。OAuth およびディスカバリーエンドポイントにはバージョンが付きません。

認証

ほとんどのエンドポイントには Bearer トークンが必要です。Authorization ヘッダーに指定してください:
curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.lnar.dev/v1/repositories
API キーはダッシュボードまたは API キーエンドポイントから作成・管理できます。

レスポンス形式

すべてのレスポンスは JSON を返します。成功したレスポンスには標準の HTTP ステータスコードが使用されます:
コード意味
200成功
201リソースが作成されました
204成功(レスポンスボディなし)
422バリデーションエラー

エラーレスポンス

バリデーションエラーは 422 ステータスを返し、どのフィールドが失敗したかの詳細が含まれます:
{
  "detail": [
    {
      "loc": ["body", "field_name"],
      "msg": "description of the error",
      "type": "error_type"
    }
  ]
}

エンドポイントグループ

サイドバーを使用して、グループ別に整理されたすべての利用可能なエンドポイントを参照できます:
  • リポジトリ — リポジトリの登録、一覧表示、管理
  • リポジトリファイル — リポジトリ内のファイルを参照
  • コード分析 — コード分析の開始、監視、管理
  • コード実行 — コードの実行と実行結果の取得
  • ラン ストリーミング — SSE を介したリアルタイムの stdout/stderr ログのストリーミング
  • API キー — API キーの作成と取り消し
  • 環境変数 — 実行用の環境変数の管理
  • GitHub インテグレーション — GitHub リポジトリの接続と管理
  • OAuth 2.0 — 認可、トークン、クライアント登録