Data models & schemas
The structure (schema) of API request and response objects.
Published models
| Model | Purpose | Where to find it |
|---|---|---|
IngestCreateRequest |
Request body for creating an album ingest — releaseId (required), xmlUrl (required), xmlUrlExpiresAt, providerKey |
Create an album ingest → Request body |
Ingest |
Ingest object — ingestId, releaseId, status, receivedAt, completedAt, resources, error |
Create an album ingest 201, Get ingest status 200 |
IngestStatus |
Ingest status enum — processing → completed / failed |
Same as above |
IngestResourceProgress |
Resource file loading progress — total, completed, failed |
Ingest.resources |
IngestError |
Ingest failure reason — code, message (only when status: failed) |
Ingest.error, ingest failure reason codes |
Error |
Common error response — error.code, error.message, error.requestId, error.details (optional) |
Every 4xx/5xx response, Error codes |
Common rules
- Field names use camelCase.
- Dates and timestamps use ISO 8601 (
2026-08-06T10:38:00+09:00). - Treat identifiers such as
ingestIdas opaque strings — their format may change. - New fields may be added to responses. Write your parser to ignore unknown fields.
- Enum values (
status,error.code) may also be added. Fall back to generic handling for unknown values.