RecoupGet a Free AuditFree Audit

API REFERENCE

Validate Artist

On this page
GET/api/content/validate

Check whether an artist has all the required files to run the content creation pipeline. Returns a structured report of each required and recommended file with its status. Required files must be present or the pipeline will fail. Recommended files improve output quality but are not strictly necessary. Provide artist_account_id as a query parameter.

Authentication

x-api-key in header

bearerAuth bearer

Request

cURL
curl --request GET \
  --url 'https://api.recoupable.dev/api/content/validate?artist_account_id=1873859c-dd37-4e9a-9bac-80d3558527a9' \
  --header 'x-api-key: YOUR_API_KEY'

Replace the YOUR_ placeholders with your values. Required query parameters are included; optional parameters are listed below.

Parameters

Query parameters

artist_account_idstringrequired

UUID of the artist account to validate. Use GET /api/artists to find artist account IDs.

Responses

200Validation completed. Check the ready field to determine if the artist can run the pipeline.

application/json

readybooleanrequired

true if the artist has all required files and the pipeline can run. false if required files are missing.

artist_account_idstringrequired

UUID of the artist account that was validated

format: uuid

songsinteger

Number of songs found in the artist's songs/ directory

templatesarray<string>

Available templates that can be used with this artist

Item properties for templates

string

checksobject

Per-file validation results. Only present when ready is true.

Properties for checks
face_guideobject

Status of a single validation check.

Properties for face_guide
statusstring · enumrequired

Whether the file was found

Values: "ok", "missing", "warning"

artist_contextobject

Status of a single validation check.

Properties for artist_context
statusstring · enumrequired

Whether the file was found

Values: "ok", "missing", "warning"

audience_contextobject

Status of a single validation check.

Properties for audience_context
statusstring · enumrequired

Whether the file was found

Values: "ok", "missing", "warning"

songsall of
Properties for songs
allOf · ContentValidationCheck 1

Status of a single validation check.

statusstring · enumrequired

Whether the file was found

Values: "ok", "missing", "warning"

allOf · object 2
countinteger

Number of songs found

missingarray<ContentMissingFile>

List of missing files with severity and fix instructions. Only present when ready is false.

Item properties for missing
filestringrequired

Relative path of the missing file within the artist directory

severitystring · enumrequired

required means the pipeline will fail without this file. recommended means the pipeline will run but output quality is degraded.

Values: "required", "recommended"

descriptionstringrequired

What this file is used for in the pipeline

fixstringrequired

Actionable instructions for creating or adding the missing file

400Bad request — artist_account_id is required

application/json

errorstringrequired

Error message describing what went wrong

401Unauthorized — invalid or missing API key

application/json

errorstringrequired

Error message describing what went wrong

404Artist not found — the provided artist_account_id does not match any artist

application/json

errorstringrequired

Error message describing what went wrong

Full specification

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

Download content.json
View operation source
json
{
  "description": "Check whether an artist has all the required files to run the content creation pipeline. Returns a structured report of each required and recommended file with its status. Required files must be present or the pipeline will fail. Recommended files improve output quality but are not strictly necessary. Provide `artist_account_id` as a query parameter.",
  "security": [
    {
      "apiKeyAuth": []
    },
    {
      "bearerAuth": []
    }
  ],
  "parameters": [
    {
      "name": "artist_account_id",
      "in": "query",
      "description": "UUID of the artist account to validate. Use [GET /api/artists](/api-reference/artists/list) to find artist account IDs.",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid",
        "example": "1873859c-dd37-4e9a-9bac-80d3558527a9"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Validation completed. Check the `ready` field to determine if the artist can run the pipeline.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ContentValidateResponse"
          }
        }
      }
    },
    "400": {
      "description": "Bad request — artist_account_id is required",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ContentErrorResponse"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized — invalid or missing API key",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ContentErrorResponse"
          }
        }
      }
    },
    "404": {
      "description": "Artist not found — the provided artist_account_id does not match any artist",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ContentErrorResponse"
          }
        }
      }
    }
  }
}