API REFERENCE

List Analyze Presets

On this page

GET/api/songs/analyze/presets

Lists all available music analysis presets. Each preset is a curated prompt with optimized generation parameters for a specific use case (e.g. catalog metadata enrichment, sync licensing analysis, audience profiling). Requires authentication via API key or Bearer token.

Authentication

x-api-key in header

bearerAuth bearer

Request

cURL

curl --request GET \
  --url 'https://api.recoupable.dev/api/songs/analyze/presets' \
  --header 'x-api-key: YOUR_API_KEY'

Responses

200Presets listed successfully

application/json

statusstring · enum

Values: "success"

presetsarray<object>

Item properties

namestring

Preset identifier to pass in the analyze request

labelstring

Human-readable preset name

descriptionstring

What this preset does

requiresAudioboolean

Always true: every analyze request requires audio_url, whichever preset or prompt it uses. Kept on the response for compatibility.

responseFormatstring · enum

Expected response format

Values: "json", "text"

401Unauthorized — invalid or missing API key / Bearer token

application/json

statusstring · enum

Error status

Values: "error"

missing_fieldsarray<string>

Path to the first invalid or missing field when validation fails

Item properties

string

errorstring

Error message describing what went wrong

Full specification

Download the OpenAPI file for complete schemas, constraints, and examples.

Download releases.json

View operation source

json

{
  "description": "Lists all available music analysis presets. Each preset is a curated prompt with optimized generation parameters for a specific use case (e.g. catalog metadata enrichment, sync licensing analysis, audience profiling). Requires authentication via API key or Bearer token.",
  "security": [
    {
      "apiKeyAuth": []
    },
    {
      "bearerAuth": []
    }
  ],
  "responses": {
    "200": {
      "description": "Presets listed successfully",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "success"
                ]
              },
              "presets": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Preset identifier to pass in the analyze request"
                    },
                    "label": {
                      "type": "string",
                      "description": "Human-readable preset name"
                    },
                    "description": {
                      "type": "string",
                      "description": "What this preset does"
                    },
                    "requiresAudio": {
                      "type": "boolean",
                      "description": "Always `true`: every analyze request requires `audio_url`, whichever preset or prompt it uses. Kept on the response for compatibility.",
                      "example": true
                    },
                    "responseFormat": {
                      "type": "string",
                      "enum": [
                        "json",
                        "text"
                      ],
                      "description": "Expected response format"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized — invalid or missing API key / Bearer token",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SongAnalyzeErrorResponse"
          }
        }
      }
    }
  }
}