Solfa Streams handbook

API access

Short, practical help designed for lookup: follow the procedure, then compare the result in your score.

Convert a MusicXML file to an engraved PDF from your own code, server-side, using an API key instead of signing in.

Create an API key

Procedure

Open Dashboard → API keys.
Select Create API key and give it a name that identifies where it will be used.
Copy the generated key immediately. For your security, it's shown only once.

Convert a score to PDF

Send a multipart/form-data request with your MusicXML file in a file field and your key as a bearer token.

bash

curl -X POST "https://api.solfastream.com/v1/score-export" \
  -H "Authorization: Bearer sk_live_..." \
  -F "file=@score.musicxml" \
  -o score.pdf

Result

A successful request returns the PDF as the response body with Content-Type: application/pdf and Content-Disposition: attachment. One credit is deducted from the key owner's account only after the PDF is generated. If the score didn't fit the page size, the response also includes X-Score-Fits: false.

Request limits

Accepted formats: .xml, .musicxml, and compressed .mxl.
Maximum upload size: 8 MB.
Rate limit: 10 requests per hour per API key, and 30 requests per hour per IP address.
Cost: 1 credit per successful conversion.

Errors

Status	Meaning
400	No file was attached, or the account doesn't have enough credits.
401	The API key is missing, malformed, or has been revoked.
413	The upload is larger than the 8 MB limit.
415	The file extension isn't supported, or its content doesn't match the extension.
422	The file parsed as XML or MXL, but the score inside couldn't be converted.
429	Too many requests for this key or IP address in the current hour.