API reference

Renders

1 operation. Base URL https://api.scarleta.ai. Select an operation to see its parameters, samples and errors.

Jump to an operation

GET/v1/audio/{fileId}/children

List the files made from a file

Free and paid accounts

API key required
Free and paid accounts
No token cost

Returns the files that were made from one of your files: crops, effects, noise-reduced versions and stems (the "renders" of a take), newest first. Archived renders are left out. Each entry has the audio_url to use when analysing it. A file with no renders, a file that does not exist and a file that is not yours all answer an empty list; the route never reveals another account's files. On success this route answers { data, meta }, and meta carries counts but no request_id. If the database is briefly unavailable the route answers 503 db_unavailable; retry after a short wait.

Cost. Free of charge.

FILEID="YOUR_FILEID"
curl "https://api.scarleta.ai/v1/audio/$FILEID/children" \
  -H "Authorization: Bearer $SCARLETA_API_KEY"

Parameters

Name	Type	Required	Description
fileIdpath	string	Required	The `audio_id` of one of your files. A trailing media extension such as `.wav` is ignored.

Response fields

Field	Type	Description
[].audio_id	string	Registry identifier of the derived file; it starts with `audio_`.
[].name	string \| null	Display name of the derived file, or null.
[].relationship_type	string \| null	How it was made from the parent, for example `crop`, `effect`, `stem` or `noise_reduction`.
[].derived_role	string \| null	For a stem, which part it is (for example `vocals`); null for the other kinds.
[].format	string \| null	File format, for example `wav`, when known.
[].file_size_bytes	number \| null	Size in bytes, when known.
[].duration_seconds	number \| null	Length of the audio, when known.
[].uploaded	number \| null	When the file was created, in milliseconds since the Unix epoch.
[].analyzed_categories	array<string>	Analysis categories this file already has results for.
[].audio_url	string \| null	URL to pass as `audio_url` when running an analysis on this file.
[].playback_url	string \| null	Link for playing the file in a browser; the same as `audio_url` where that link is signed.

Errors

Status	Code	Description
401	invalid_key	Missing, malformed, unknown or revoked API key.
429	rate_limit_exceeded	Over the account request budget or the per-minute cap of this route. Wait for the `Retry-After` header, then retry.
503	auth_unavailable	Temporary platform condition; retry shortly.

Example responses

{
  "data": [
    {
      "audio_id": "audio_a81e5c40d7f2",
      "name": "Stem: vocals",
      "relationship_type": "stem",
      "derived_role": "vocals",
      "format": "wav",
      "file_size_bytes": 5290044,
      "duration_seconds": 30.2,
      "uploaded": 1791333870854,
      "analyzed_categories": [],
      "audio_url": "https://api.scarleta.ai/v1/audio/media/9b2c7d1e-5a40-4f83-b6c9-0d1e2f3a4b5c.wav",
      "playback_url": "https://api.scarleta.ai/v1/audio/media/9b2c7d1e-5a40-4f83-b6c9-0d1e2f3a4b5c.wav"
    }
  ],
  "meta": {
    "count": 1
  }
}

200 The renders of the file, newest first.
401 Missing, malformed, unknown or revoked API key.
429 Over the account request budget or the per-minute cap of this route. Wait for the `Retry-After` header, then retry.
503 Temporary platform condition; retry shortly.

Try it

Sends this request from your browser to https://api.scarleta.ai with your own key. The key stays in this page only (never saved or put in the address) and is cleared when you leave. Revoke any key you have shared.

Other error codes this operation can return: db_unavailable, invalid_auth_format, invalid_key_format, missing_api_key, missing_auth, rate_limit_unavailable, unauthorized.