> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lymo.jp/llms.txt
> Use this file to discover all available pages before exploring further.

# Lymo Platform API

> Lymo の外部 REST API — 動画分析、案件スコアリング、Webhook

Platform API は、Lymo のプロダクト UI の外から Lymo と連携するための、バージョン管理された公開 REST API です。CLI、パートナー連携、外部向けの自動化スクリプトは、すべてここに記載のエンドポイントを呼び出します。

## ベース URL

API は `https://platform.lymo.jp` で提供されます。バージョン付きのエンドポイントはすべて `/v1` 配下にあり（例: `GET /v1/members/me`）、ヘルスチェックだけはバージョンなしの `/health` で提供されます。

現時点では一次提供の SDK はありません。REST API を直接呼び出すか、[CLI](/guides/cli) もしくは同梱の MCP サーバ経由でエージェント連携を行ってください。

## レスポンスエンベロープ

成功・失敗にかかわらず、すべてのレスポンスは同じ形状を持ちます。

```json theme={null}
{
  "data": { ... },
  "meta": { "request_id": "req_xxxxx" }
}
```

エラー時は `data` が `error` に置き換わります。

```json theme={null}
{
  "error": { "code": "not_found", "message": "Video not found" },
  "meta": { "request_id": "req_xxxxx" }
}
```

ページネーション対応のエンドポイントでは、`meta` に `next_cursor` と `has_more` が追加されます。すべてのコレクションがページネーションされるわけではありません。対象エンドポイントは [ページネーション](/guides/pagination) を参照してください。

`meta.request_id` はすべてのレスポンスに含まれます。問題を報告する際に添えていただくと、サーバ側で該当リクエストを正確に追跡できます。

## 認証

すべてのリクエストで `Authorization` ヘッダーに API キーを指定します。

```bash theme={null}
curl https://platform.lymo.jp/v1/members/me \
  -H "Authorization: Bearer lymo_xxxxxxxxxxxxxxxx"
```

キーは Lymo Web アプリの **設定 → Platform** から発行できます。各キーは 1 つの組織にひも付き、読み取り専用または読み書きのスコープを持ちます。

## 次のステップ

<CardGroup cols={2}>
  <Card title="クイックスタート" icon="rocket" href="/ja/guides/quickstart">
    curl で最初のリクエストを送るまでを数分で。
  </Card>

  <Card title="CLI" icon="terminal" href="/ja/guides/cli">
    CLI のインストール、ターミナル操作、MCP エージェント連携。
  </Card>

  <Card title="非同期パターン" icon="arrows-rotate" href="/ja/guides/async-pattern">
    動画分析・案件スコアリングのライフサイクルとポーリング。
  </Card>

  <Card title="Webhook" icon="webhook" href="/ja/guides/webhooks">
    処理完了イベントを受け取るための登録と署名検証。
  </Card>

  <Card title="ページネーション" icon="list" href="/ja/guides/pagination">
    カーソル形式、`limit` の範囲、対象エンドポイント一覧。
  </Card>

  <Card title="エラー" icon="triangle-exclamation" href="/ja/guides/errors">
    全エラーコードの意味と推奨対応。
  </Card>
</CardGroup>

各エンドポイントの完全なリファレンス（パス、パラメータ、レスポンススキーマ）は、サイト上部の **APIリファレンス** タブにあります（OpenAPI 仕様から自動生成）。