Build with music notation

Embed interactive sheet music, automate scores over the REST API, turn PDFs into editable music, and plug Flat into your LMS.

index.html

<div id="embed"></div>
<script src="https://prod.flat-cdn.com/embed-js/v2.12.1/embed.min.js"></script>
<script>
  const embed = new Flat.Embed('embed', {
    score: '56ae21579a127715a02901a6',
    embedParams: { appId: 'YOUR_APP_ID', mode: 'edit' }
  });
  embed.play();
</script>

Pick the parts you need

Each brick works on its own and shares one account. Embed and OMR are the paid pair, covered by a single Developer plan.

Embed

Usage-based · Developer plan

Put interactive, playable sheet music in your own site or app.

Viewer or editor mode
JavaScript/TypeScript SDK, with usage analytics in the console

Docs JavaScript SDK Product page

OMR

Usage-based · Developer plan

Turn PDFs and photos of sheet music into editable scores.

PDFs and photos in
MusicXML or MIDI out

The playground runs in the console; an account is required.

Docs Credits Playground

REST API

Free

Read and write Flat accounts and scores from your own code.

Scores, collections and comments
Personal tokens or OAuth2

Docs API reference SDKs

Import API

Free

An "Edit on Flat" link that imports any score into a Flat account.

A single link, nothing to configure
Works with any score on the web

Docs

LTI

Flat for Education

Connect Flat for Education to your school's LMS.

Certified LTI 1.3 Advantage and 1.1 provider
Deep linking, grades and rosters

LTI is included with a Flat for Education subscription.

Docs LTI 1.3 Flat for Education

Try the API in 5 minutes

Create an app for your script or project.
In the left menu, open Flat API > Personal Tokens, then choose a name and the authorization scopes for your first token.
Send the token in the Authorization header of your requests:

terminal

bash

curl -H 'Authorization: Bearer <my_api_personal_access_token>' https://api.flat.io/v2/me

That is enough to work with your own account. When you want other Flat or Flat for Education users to connect their account to your app, for example to open their scores or to run the OMR API behind your own product, you will need OAuth2 credentials. Read the authentication guide for the scopes, the OAuth2 flows, and how to request credentials.

Going further

SDKs: official clients for JavaScript, Python, PHP and more.
Rate limits and errors: what to expect when your app grows.
Flat for Education API: manage organizations, classes and assignments.
Instrument IDs: the catalog used when creating scores and correcting OMR parts.
The developer changelog: every REST API and Embed SDK version.

Reading these docs with an AI agent? The whole site is available as plain text at llms.txt and llms-full.txt.

Questions, feedback or feature requests? Email developers@flat.io.