Skip to content
Other

flat.io

Flat sandbox and mock API

The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following: * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar and MuseScore files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing edu Writes persist, data moves on a schedule and every change can fire a signed webhook.

Operations
81
Collections
-
Event types
-
example request
curl https://your-flat.slurry.io/v2/classes \
  -H "Authorization: Bearer slurry_sim_..."

Your simulation gets its own hostname, key and IP allow-list. Built from API version 2.13.0.

What gets simulated

Collections, relationships and state machines are worked out from the spec when you start the simulation.

  • State. Creates, updates and deletes persist and show up in later reads.
  • Behaviour. Records move through their states on a schedule you control, and you can fast-forward up to 30 days.
  • Webhooks. Every change emits a signed, retried event.
  • Failure. Per-endpoint errors, latency and chaos rules, on demand.

Operations

First 12 of 81.

  • GET/classes
  • POST/classes
  • POST/classes/enroll/{enrollmentCode}
  • GET/classes/{class}
  • PUT/classes/{class}
  • POST/classes/{class}/activate
  • POST/classes/{class}/archive
  • DELETE/classes/{class}/archive
  • GET/classes/{class}/assignments
  • POST/classes/{class}/assignments
  • POST/classes/{class}/assignments/{assignment}/archive
  • DELETE/classes/{class}/assignments/{assignment}/archive