Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Flat (BYOK) — connector documentation

  • MCP endpoint: https://byok-flat.connectorbay.com/mcp
  • REST API: POST https://byok-flat.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-flat.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Flat Flat personal access token, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-flat.connectorbay.com/health · Tool schemas: https://byok-flat.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-flat · agent@connectorbay.com

What Flat (BYOK) is for

Flat (BYOK) lets an AI assistant read your own Flat data through the Flat API with a key you supply (Flat personal access token). Read-only: 11 tools (get_me, get_user, list_user_scores, list_liked_scores, get_score, list_collections, get_collection, list_collection_scores, list_score_revisions, list_score_comments, list_score_tracks). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.flat.io. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Flat. Flat and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which Flat account is my token connected to and how many followers do I have?"
  • "How many public scores and followers does the Flat user 'me' have?"
  • "What public scores has this Flat user published?"
  • "Which scores did I like on Flat?"
  • "What are the details of this Flat score?"
  • "What collections do I have on Flat?"

What it does

  • get_me: Show the Flat account the token belongs to: username, display name, profile link, join date and public counters (scores, followers, likes, plays). Needs the account.public_profile scope.
  • get_user: Get the public profile of a Flat user: name, bio, join date and counters for scores, followers, likes and plays.
  • list_user_scores: List the public scores owned by a Flat user with title, composer, instruments, dates and like, view, play and comment totals.
  • list_liked_scores: List the scores a Flat user has liked, with title, composer and popularity totals.
  • get_score: Get one score's metadata: title, composer, description, tags, license, tempo, key signature, length and popularity totals.
  • list_collections: List the Flat collections (folders) of the token's account, including virtual ones such as allScores and likes, with privacy and score counts.
  • get_collection: Get one collection's title, type, privacy, dates and number of scores.
  • list_collection_scores: List the scores inside a collection with title, composer, dates and popularity totals.
  • list_score_revisions: List the saved revisions of a score, newest first, with author id, date, event and whether the revision was an autosave.
  • list_score_comments: List the comments on a score, optionally only document-level or inline ones, with author id, date, text and resolved flag.
  • list_score_tracks: List the audio or video tracks linked to a score (recordings on SoundCloud, YouTube, Vimeo or uploaded audio) with title, type and state.

BYOK key

You bring your own Flat Flat personal access token (https://flat.io/developers/apps). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.flat.io over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Flat API (api.flat.io) with a BYOK key; documentation: https://flat.io/developers/docs/api/. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Flat. Flat and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Flat account.

Built for: Worldwide. Languages: English.