Skip to main content
The Platform API is the stable, versioned surface for integrating with Lymo from outside the product UI. The CLI, partner integrations, and custom automations all call the same endpoints documented here.

​
Base URL

The API is served at https://platform.lymo.jp. All versioned endpoints are under /v1 (e.g. GET /v1/members/me); the unversioned /health probe lives at the base URL. There is no first-party SDK today. Use the REST API directly, the CLI, or the bundled MCP server for agent integrations.

​
Response envelope

Every response — success or error — uses the same shape: 
{
  "data": { ... },
  "meta": { "request_id": "req_xxxxx" }
}
Errors replace data with error: 
{
  "error": { "code": "not_found", "message": "Video not found" },
  "meta": { "request_id": "req_xxxxx" }
}
Paginated endpoints additionally include next_cursor and has_more in meta. Not every collection is paginated — see Pagination for the full list and cursor semantics. The meta.request_id is present on every response. Include it when reporting issues — it lets us trace the exact request server-side.

​
Authentication

Every request requires an API key in the Authorization header: 
curl https://platform.lymo.jp/v1/members/me \
  -H "Authorization: Bearer lymo_xxxxxxxxxxxxxxxx"
Issue keys from the Lymo web app under Settings → Platform. Each key is scoped to one organization and carries a set of scopes (read-only or read + write).

​
What’s next

Quickstart

Send your first authenticated request in a few curl commands.

CLI

Install the CLI for terminal workflows and MCP agent integration.

Async pattern

Polling, idempotency, and webhooks for video analyses and deal scorings.

Webhooks

Register endpoints, verify signatures, and subscribe to completion events.

Pagination

Cursor format, limit bounds, and which endpoints paginate.

Errors

Every error code, what it means, and recommended client-side handling.
The full endpoint reference — every path, parameter, and response schema — lives in the API Reference tab at the top of this site, auto-generated from our OpenAPI spec.