GET /v1/sound-effects
List your sound effects
Retrieve a paginated list of your sound effects, sorted by most recent first.
GET https://pub.finetuning.ai/v1/sound-effects
| Header | Type | Required | Description |
|---|
X-API-Key | string | Yes | Your API key |
| Parameter | Type | Default | Description |
|---|
limit | number | 20 | Number of results (1–100) |
offset | number | 0 | Pagination offset |
status | string | — | Filter by status: pending, processing, completed, failed |
curl "https://pub.finetuning.ai/v1/sound-effects?limit=10&status=completed" \
-H "X-API-Key: ft_live_your_key_here"
{
"data": {
"soundEffects": [
{
"id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"status": "completed",
"prompt": "thunderclap with heavy rain",
"requestedDuration": 5,
"audioUrl": "https://media.finetuning.ai/sfx/a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d/0.mp3",
"duration": 5.0,
"webhook": null,
"errorMessage": null,
"createdAt": "2025-01-15 10:30:00",
"completedAt": "2025-01-15T10:30:06.184Z"
},
{
"id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
"status": "completed",
"prompt": "sci-fi laser zap",
"requestedDuration": 2,
"audioUrl": "https://media.finetuning.ai/sfx/b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e/0.mp3",
"duration": 2.0,
"webhook": null,
"errorMessage": null,
"createdAt": "2025-01-14 14:20:00",
"completedAt": "2025-01-14T14:20:03.512Z"
}
],
"hasMore": true,
"nextOffset": 10
}
}
| Field | Type | Description |
|---|
data.soundEffects | array | Array of sound-effect objects |
data.soundEffects[].id | string | Unique sound-effect ID (UUID) |
data.soundEffects[].status | string | pending, processing, completed, failed |
data.soundEffects[].prompt | string | The prompt used |
data.soundEffects[].requestedDuration | number | Requested duration in seconds |
data.soundEffects[].audioUrl | string | null | Audio download URL (available when completed) |
data.soundEffects[].duration | number | null | Actual length of the rendered clip in seconds |
data.soundEffects[].webhook | string | null | Webhook URL set at create time, or null if none |
data.soundEffects[].errorMessage | string | null | Error details if generation failed |
data.soundEffects[].createdAt | string | Creation timestamp |
data.soundEffects[].completedAt | string | null | Completion timestamp (ISO 8601) |
data.hasMore | boolean | Whether more results are available |
data.nextOffset | number | null | Offset to use for the next page, or null if none |
| Code | Status | Description |
|---|
MISSING_API_KEY | 401 | X-API-Key header was not provided |
INVALID_API_KEY | 401 | API key is malformed, revoked, or does not exist |
INTERNAL_ERROR | 500 | Unexpected server error |
