Musik

Musikstatus abrufen

Ruft den Status und das Ergebnis einer Musikgenerierungsaufgabe ab

GET
/v1/tasks/{id}

GET /v1/music/generations/{id} ist ein Kompatibilitäts-Endpunkt. Er wird für bestehende Integrationen weiterhin unterstützt. Neue Integrationen sollten GET /v1/tasks/{id} abfragen; siehe Aufgabenstatus abrufen.

Rufen Sie GET /v1/tasks/{id} auf, um den Status Ihrer Musikgenerierungsaufgabe zu überprüfen.

id und task_id identifizieren dieselbe Aufgabe.

Eine abgelaufene oder nicht verfügbare öffentliche Aufgabe kann 404 async_task_not_found zurückgeben. Wenn die Aufgabeninhaberschaft für den aktuellen API-Key nicht festgestellt werden kann, lautet die Antwort 403 task_not_owned.

Pfad-Parameter

idstringpatherforderlich

Die ID der Musikgenerierungsaufgabe.

Antwort

idstring

Aufgaben-ID.

task_idstring

Alias derselben asynchronen Aufgaben-ID, sofern zurückgegeben.

poll_urlstring

Status-URL für diese Aufgabe. Fragen Sie GET /v1/tasks/{id} mit id ab.

statusstring

Aufgabenstatus: pending, processing, completed, failed oder timeout. Eine fehlgeschlagene Aufgabe gibt dennoch HTTP 200 zurück.

progressinteger

Optionaler Fortschrittswert. Wird nur zurückgegeben, wenn ein tatsächlicher Fortschrittswert verfügbar ist; verwenden Sie status, um den Abschluss zu bestimmen.

Die Ergebnisfelder hängen vom Vorgang ab. Musik kann audio_url und audio_id zurückgeben; Aufgaben, die nur Liedtexte betreffen, geben lyrics zurück; Trennungsvorgänge können mehrere Dateien in data zurückgeben. video_url, Titel, Fortschritt und andere Metadaten sind optional. Überprüfen Sie status auf Abschluss und lesen Sie die tatsächlich zurückgegebenen Felder.

audio_idstring

Optionale Quell-Audio-ID, verwendbar mit der ID dieser Aufgabe bei unterstützten Folgeoperationen.

dataarray

Optionales Ausgabe-Array, einschließlich getrennter Audiodateien mit audio_url oder url.

audio_urlstring

URL zum Herunterladen der Audiodatei (nach Abschluss). Ein TokenLab-Medien-Ergebnislink, der 30 Tage lang gültig bleibt.

video_urlstring

URL zur Videoversion mit Visualizer (nach Abschluss und sofern für das Modell verfügbar).

image_urlstring

URL des Cover-Bildes, wenn das Modell eines zurückgibt.

titlestring

Titel des generierten Songs.

lyricsstring

Generierte oder bereitgestellte Liedtexte.

errorstring | object

Fehlermeldung (bei Fehlschlag).

error_detailsobject

Details zum Fehler, wenn die Aufgabe fehlgeschlagen ist: status, message, type, code, retryable und param, wenn ein Anforderungsfeld fehlerhaft ist.

media_retentionobject

Speicherstatus der Ergebnislinks: days und items[] mit url, kind, status und expires_at. Kann fehlen; die Links funktionieren dennoch. Siehe Datenaufbewahrung.

Anfrage

curl --fail-with-body "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
  -H "Authorization: Bearer sk-your-api-key"

Antwort

Response (Completed)
{
  "id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "task_id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "poll_url": "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "status": "completed",
  "audio_url": "https://api.tokenlab.sh/v1/media-results/2d7e9a41-8c3b-4b6f-a1e5-7f0c3d9b8e26.mp3?token=…",
  "title": "Night Drive",
  "lyrics": "[Verse 1]\nDriving through the night...",
  "audio_id": "audio_abc123",
  "media_retention": {
    "days": 30,
    "items": [
      {
        "url": "https://api.tokenlab.sh/v1/media-results/2d7e9a41-8c3b-4b6f-a1e5-7f0c3d9b8e26.mp3?token=…",
        "kind": "audio",
        "content_type": "audio/mpeg",
        "status": "saved",
        "expires_at": "2024-02-22T08:54:20.000Z"
      }
    ]
  }
}

Autorisierung

BearerAuth
AuthorizationBearer <token>

API-Key-Authentifizierung. Erstellen oder verwalten Sie API-Keys unter Dashboard > API > API Keys.

Ort: header

Pfadparameter

id*string

Die asynchrone Task-ID, die über id / task_id zurückgegeben oder in poll_url eingebettet wird

Antwort

application/json

application/json

application/json

application/json

application/json

application/json

application/json