The Flat API allows you to easily extend the abilities of the Flat Platform, with a wide range of use cases including the following:

• Creating and importing new music scores using MusicXML or MIDI files
• Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI)
• Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments.

You can find the API reference including code samples and our OpenAPI Specification at the following url: https://flat.io/developers/api/reference.

To request some API credentials, please visit https://flat.io/developers.

Python >= 3.7

pip install flat_api

or install from this repository

pip install git+https://github.com/FlatIO/api-client-python.git

Then import the package:

import flat_api

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import flat_api

Please follow the installation procedure and then run the following:

from pprint import pprint
import flat_api
from flat_api.api import account_api

configuration = flat_api.Configuration(
    access_token = 'YOUR_ACCESS_TOKEN'
)

# Enter a context with an instance of the API client
with flat_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = account_api.AccountApi(api_client)

    try:
        # Get current user account
        api_response = api_instance.get_authenticated_user()
        pprint(api_response)
    except flat_api.ApiException as e:
        print("Exception when calling AccountApi->get_authenticated_user: %s\n" % e)

All URIs are relative to https://api.flat.io/v2

• ApiAccessToken
• AppScopes
• Assignment
• AssignmentCopy
• AssignmentCopyResponse
• AssignmentCopyResponseCapabilities
• AssignmentCopyResponseCapabilitiesCanPublishInClassError
• AssignmentSubmission
• AssignmentSubmissionComment
• AssignmentSubmissionCommentCreation
• AssignmentSubmissionHistory
• AssignmentSubmissionHistoryAttachment
• AssignmentSubmissionHistoryState
• AssignmentSubmissionState
• AssignmentSubmissionUpdate
• AssignmentSubmissionUpdateComments
• AssignmentType
• AssignmentUpdate
• ClassAssignment
• ClassAssignmentCanvas
• ClassAssignmentLti
• ClassAssignmentMfc
• ClassAssignmentUpdate
• ClassAssignmentUpdateGoogleClassroom
• ClassAssignmentUpdateMicrosoftGraph
• ClassAttachmentCreation
• ClassCreation
• ClassDetails
• ClassDetailsCanvas
• ClassDetailsClever
• ClassDetailsGoogleClassroom
• ClassDetailsGoogleDrive
• ClassDetailsIssues
• ClassDetailsIssuesSyncInner
• ClassDetailsLti
• ClassDetailsMfc
• ClassDetailsMicrosoftGraph
• ClassGradeLevel
• ClassRoles
• ClassState
• ClassUpdate
• Collection
• CollectionApp
• CollectionCapabilities
• CollectionCreation
• CollectionModification
• CollectionPrivacy
• CollectionType
• EduLibrary
• EduResource
• EduResourceCapabilities
• EduResourceCopy
• EduResourceCreation
• EduResourceMove
• EduResourcePrivacy
• EduResourceResource
• EduResourceType
• EduResourceUpdate
• EduResourceUseInClass
• EduSkillsFocused
• FlatErrorResponse
• FlatLocales
• GoogleClassroomCoursework
• GoogleClassroomSubmission
• Group
• GroupDetails
• GroupType
• LicenseMode
• LicenseSources
• LmsName
• LtiCredentials
• LtiCredentialsCreation
• MediaAttachment
• MediaScoreSharingMode
• MicrosoftGraphAssignment
• MicrosoftGraphSubmission
• OrganizationInvitation
• OrganizationInvitationCreation
• OrganizationRoles
• OrganizationUserAccessTokenCreation
• ResourceCollaborator
• ResourceCollaboratorCreation
• ResourceRights
• ScoreComment
• ScoreCommentContext
• ScoreCommentCreation
• ScoreCommentModeration
• ScoreCommentUpdate
• ScoreCommentsCounts
• ScoreCreation
• ScoreCreationBuilderData
• ScoreCreationBuilderDataLayoutData
• ScoreCreationBuilderDataScoreData
• ScoreCreationBuilderDataScoreDataInstrumentsInner
• ScoreCreationType
• ScoreDetails
• ScoreFork
• ScoreLicense
• ScoreLikesCounts
• ScoreModification
• ScorePlaysCounts
• ScorePrivacy
• ScoreRevision
• ScoreRevisionCreation
• ScoreRevisionStatistics
• ScoreSource
• ScoreTrack
• ScoreTrackCreation
• ScoreTrackPoint
• ScoreTrackState
• ScoreTrackType
• ScoreTrackUpdate
• ScoreViewsCounts
• Task
• TaskExportOptions
• TaskProgress
• TaskResult
• UserAdminUpdate
• UserAzureDetails
• UserCommunityProfileLinks
• UserCreation
• UserDetails
• UserDetailsAdmin
• UserDetailsAdminLicense
• UserPublic
• UserPublicSummary
• UserSigninLink
• UserSigninLinkCreation

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://flat.io/auth/oauth
• Scopes:
• account.public_profile: Provides access to the basic person's public profile. Education profiles may be anonymized with this scope, you can request the scope education_profile to access to the a basic education account profile.
• account.email: Provices access to the person's email.
• account.education_profile: Provides access to the basic person's education profile and public organization information.
• scores.readonly: Allows read-only access to all a user's scores. You won't need this scope to read public scores.
• scores.social: Allow to post comments and like scores
• scores: Full, permissive scope to access all of a user's scores.
• collections.readonly: Allow read-only access to a user's collections.
• collections.add_scores: Allow to add scores to a user's collections.
• collections: Full, permissive scope to access all of a user's collections.
• edu.resources: Read-write access to the resource library.
• edu.resources.readonly: Read-only access to the resource library.
• edu.classes: Full, permissive scope to manage the classes.
• edu.classes.readonly: Read-only access to the classes.
• edu.assignments: Read-write access to the assignments and submissions.
• edu.assignments.readonly: Read-only access to the assignments and submissions.
• edu.admin: Full, permissive scope to manage all the admin of an organization.
• edu.admin.lti: Access and manage the LTI Credentials for an organization.
• edu.admin.lti.readonly: Read-only access to the LTI Credentials of an organization.
• edu.admin.users: Access and manage the users and invitations of the organization.
• edu.admin.users.readonly: Read-only access to the users and invitations of the organization.
• tasks.readonly: Read-only access to export tasks created by this account.

developers@flat.io

If the OpenAPI document is large, imports in flat_api.apis and flat_api.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

• from flat_api.api.default_api import DefaultApi
• from flat_api.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import flat_api
from flat_api.apis import *
from flat_api.models import *