# Lymo Platform API

> External REST API for Lymo — video analysis, deal scoring, webhooks.

## Docs

- [Create a video analysis](https://docs.lymo.jp/api-reference/analyses/create-a-video-analysis.md): Enqueues an analysis workflow for the video. Returns the analysis resource with status "processing". Poll GET /v1/videos/{id}/analyses/{analysis_id} for completion.
- [Get analysis status and result](https://docs.lymo.jp/api-reference/analyses/get-analysis-status-and-result.md)
- [List video analyses](https://docs.lymo.jp/api-reference/analyses/list-video-analyses.md)
- [Get deal activity feed](https://docs.lymo.jp/api-reference/deals/get-deal-activity-feed.md)
- [Get deal detail with scores](https://docs.lymo.jp/api-reference/deals/get-deal-detail-with-scores.md)
- [List deals](https://docs.lymo.jp/api-reference/deals/list-deals.md)
- [Revoke the current API key](https://docs.lymo.jp/api-reference/keys/revoke-the-current-api-key.md): Revokes the API key used to authenticate this request. After revocation, subsequent requests with this key will return 401. Used by CLI logout flow.
- [Get the member associated with this API key](https://docs.lymo.jp/api-reference/members/get-the-member-associated-with-this-api-key.md)
- [List organization members](https://docs.lymo.jp/api-reference/members/list-organization-members.md)
- [Create a deal scoring](https://docs.lymo.jp/api-reference/scorings/create-a-deal-scoring.md): Enqueues a scoring workflow for the deal. Returns the scoring resource with status "processing". Poll GET /v1/deals/{id}/scorings/{scoring_id} for completion.
- [Get scoring status and result](https://docs.lymo.jp/api-reference/scorings/get-scoring-status-and-result.md)
- [List deal scorings](https://docs.lymo.jp/api-reference/scorings/list-deal-scorings.md)
- [Search transcripts across videos](https://docs.lymo.jp/api-reference/search/search-transcripts-across-videos.md): Case-insensitive substring search across transcript segments in the caller's organization. Filters compose (AND): pass `video_id` to limit to one video, `deal_id` to limit to a deal's videos, or both (segment must satisfy every filter). Results ordered by video creation time (newest first), then by…
- [Health check](https://docs.lymo.jp/api-reference/system/health-check.md)
- [Get video checklist evaluation](https://docs.lymo.jp/api-reference/videos/get-video-checklist-evaluation.md)
- [Get video detail](https://docs.lymo.jp/api-reference/videos/get-video-detail.md)
- [Get video sales events](https://docs.lymo.jp/api-reference/videos/get-video-sales-events.md)
- [Get video summary](https://docs.lymo.jp/api-reference/videos/get-video-summary.md)
- [Get video transcript](https://docs.lymo.jp/api-reference/videos/get-video-transcript.md)
- [List videos](https://docs.lymo.jp/api-reference/videos/list-videos.md)
- [Search video transcript](https://docs.lymo.jp/api-reference/videos/search-video-transcript.md)
- [Delete a webhook endpoint](https://docs.lymo.jp/api-reference/webhooks/delete-a-webhook-endpoint.md)
- [Delivered when a deal scoring job completes successfully](https://docs.lymo.jp/api-reference/webhooks/delivered-when-a-deal-scoring-job-completes-successfully.md)
- [Delivered when a deal scoring job fails permanently](https://docs.lymo.jp/api-reference/webhooks/delivered-when-a-deal-scoring-job-fails-permanently.md)
- [Delivered when a video analysis job completes successfully](https://docs.lymo.jp/api-reference/webhooks/delivered-when-a-video-analysis-job-completes-successfully.md)
- [Delivered when a video analysis job fails permanently](https://docs.lymo.jp/api-reference/webhooks/delivered-when-a-video-analysis-job-fails-permanently.md)
- [Delivered when a video finishes processing and is ready for analysis](https://docs.lymo.jp/api-reference/webhooks/delivered-when-a-video-finishes-processing-and-is-ready-for-analysis.md)
- [List registered webhook endpoints](https://docs.lymo.jp/api-reference/webhooks/list-registered-webhook-endpoints.md)
- [Register a webhook endpoint](https://docs.lymo.jp/api-reference/webhooks/register-a-webhook-endpoint.md)
- [非同期パターン](https://docs.lymo.jp/guides/async-pattern.md): analyses / scorings のライフサイクル
- [CLI](https://docs.lymo.jp/guides/cli.md): Lymo CLI のインストールと使い方 — ターミナル操作とエージェント連携
- [エラー](https://docs.lymo.jp/guides/errors.md): 全エラーコードの意味と対処法
- [ページネーション](https://docs.lymo.jp/guides/pagination.md): カーソル形式・limit 範囲・対象エンドポイント
- [クイックスタート](https://docs.lymo.jp/guides/quickstart.md): 認証付きリクエストを最初に送るまで
- [Webhook](https://docs.lymo.jp/guides/webhooks.md): 処理完了時にイベントを受け取る
- [Lymo Platform API](https://docs.lymo.jp/index.md): Lymo の外部 REST API — 動画分析、案件スコアリング、Webhook

## OpenAPI Specs

- [openapi](https://docs.lymo.jp/openapi.yaml)