API-Dokumentation

Open Platform API-Dokumentation (v1)

Dieses Dokument beschreibt die Verwendung der YinziAI Open Platform API. Entwickler können die API verwenden, um Bestellungen zu erstellen, den Status abzufragen und mehr.

Authentifizierung (Authentication)

Alle Schnittstellen erfordern eine Authentifizierung über apiKey. Das System identifiziert den Benutzer anhand des apiKey, ohne auf Session oder Token angewiesen zu sein. Sie erhalten Ihren Schlüssel im "Benutzerzentrum" -> "API Key".

Es werden zwei Authentifizierungsmethoden unterstützt:

1. Header-Authentifizierung (Empfohlen)

   Authorization: Bearer <your_api_key>
   

2. Query-Parameter-Authentifizierung

   ?apiKey=<your_api_key>
   

Basis-URL

https://api.yinziai.com

---

Schnittstellenliste

1. Bestellung erstellen (Create Order)

Erstellt eine asynchrone Verarbeitungsbestellung. Das System generiert automatisch eine Bestellnummer und gibt diese zurück.

• URL: /api/open/v1/order/create
• Method: POST
• Content-Type: application/json

Anfrageparameter

Parametername	Typ	Erforderlich	Beschreibung
orderType	string	Ja	Bestelltyp, siehe Aufzählung unten
stuff	object	Ja	Materialinformationen
stuff.pathKey	string	Ja	Ressourcenadresse (unterstützt HTTP-Link)

Anfragebeispiele

Spurtrennung (track-separation)

Trennt Audio in Gesangs- und Begleitspuren.

{
  "orderType": "track-separation",
  "stuff": {
    "pathKey": "https://example.com/audio.mp3"
  }
}

Stimmenextraktion (extract-voice)

Extrahiert den Gesangsteil aus dem Audio.

{
  "orderType": "extract-voice",
  "stuff": {
    "pathKey": "https://example.com/audio.mp3"
  }
}

Begleitungsextraktion (extract-music)

Extrahiert den Begleit-/Hintergrundmusikteil aus dem Audio.

{
  "orderType": "extract-music",
  "stuff": {
    "pathKey": "https://example.com/audio.mp3"
  }
}

Textextraktion (extract-text)

Extrahiert Textinhalte aus Video oder Audio.

{
  "orderType": "extract-text",
  "stuff": {
    "pathKey": "https://example.com/video.mp4"
  }
}

Antwortbeispiel

{
  "code": 0,
  "data": {
    "orderNo": "abc123XYZ789defGHI",
    "orderType": "track-separation",
    "orderStatus": "processing",
    "payStatus": "waiting",
    "messageId": "task-id-123"
  },
  "msg": "success"
}

Antwortfeld-Beschreibung

Feld	Typ	Beschreibung
orderNo	string	Bestellnummer, für spätere Abfragen
orderType	string	Bestelltyp
orderStatus	string	Bestellstatus
payStatus	string	Zahlungsstatus
messageId	string	Aufgaben-Nachrichten-ID

---

2. Bestellung abfragen (Query Order)

Fragt den Verarbeitungsstatus und das Ergebnis der Bestellung ab. Nach Abschluss der Verarbeitung wird der Download-Link für das Ergebnis zurückgegeben.

Hinweis: Bei der ersten Abfrage nach Abschluss der Bestellung werden automatisch Credits abgezogen.

• URL: /api/open/v1/order/query
• Method: GET

Anfrageparameter

Parametername	Typ	Erforderlich	Beschreibung
orderNo	string	Ja	Bestellnummer

Anfragebeispiel

GET /api/open/v1/order/query?orderNo=abc123XYZ789defGHI
Authorization: Bearer <your_api_key>

Antwortbeispiel (Verarbeitung)

{
  "code": 0,
  "data": {
    "orderNo": "abc123XYZ789defGHI",
    "orderType": "track-separation",
    "status": "processing",
    "cost": 0,
    "reason": null,
    "stuffs": [],
    "balance": 1000
  },
  "msg": "success"
}

Antwortbeispiel (Fertig)

{
  "code": 0,
  "data": {
    "orderNo": "abc123XYZ789defGHI",
    "orderType": "track-separation",
    "status": "finish",
    "cost": 10,
    "reason": null,
    "stuffs": [
      {
        "name": "vocals.mp3",
        "business": "vocals",
        "url": "https://cdn.example.com/result/vocals.mp3"
      },
      {
        "name": "accompaniment.mp3",
        "business": "accompaniment",
        "url": "https://cdn.example.com/result/accompaniment.mp3"
      }
    ],
    "balance": 990
  },
  "msg": "success"
}

Antwortfeld-Beschreibung

Feld	Typ	Beschreibung
orderNo	string	Bestellnummer
orderType	string	Bestelltyp
status	string	Bestellstatus
cost	number	Verbrauchte Credits
reason	string	Fehlergrund (nur bei Fehler)
stuffs	array	Ergebnisliste
stuffs[].name	string	Dateiname
stuffs[].business	string	Geschäftstyp (vocals/accompaniment/caption usw.)
stuffs[].url	string	Download-Link (1 Stunde gültig)
balance	number	Aktuelles Benutzerguthaben

---

3. Kurzvideo-Analyse (Short Video Analyze)

Echtzeitanalyse von Kurzvideo-Teilungslinks, um Videoinformationen und wasserzeichenfreie Download-Adressen zu erhalten.

Hinweis: Diese Schnittstelle ist eine Echtzeit-Schnittstelle, bei der sofort Credits abgezogen und das Ergebnis zurückgegeben wird.

• URL: /api/open/v1/short-video/analyze
• Method: POST
• Content-Type: application/json

Anfrageparameter

Parametername	Typ	Erforderlich	Beschreibung
link	string	Ja	Kurzvideo-Teilungslink

Anfragebeispiel

{
  "link": "https://v.douyin.com/ixxxxxx/"
}

Antwortbeispiel

{
  "code": 0,
  "data": {
    "title": "Videotitel",
    "author": "Autoren-Nickname",
    "cover": "https://cdn.example.com/cover.jpg",
    "videoUrl": "https://cdn.example.com/video.mp4",
    "musicUrl": "https://cdn.example.com/music.mp3",
    "balance": 990
  },
  "msg": "success"
}

Antwortfeld-Beschreibung

Feld	Typ	Beschreibung
title	string	Videotitel
author	string	Autoren-Nickname
cover	string	Cover-Bildadresse
videoUrl	string	Wasserzeichenfreie Video-Download-Adresse
musicUrl	string	Hintergrundmusik-Download-Adresse (falls vorhanden)
balance	number	Aktuelles Benutzerguthaben

---

Fehlercode-Beschreibung

Fehlercode	Beschreibung
0	Erfolg
400	Anfrageparameterfehler
401	Authentifizierung fehlgeschlagen (API Key ungültig oder fehlt)
500	Interner Serverfehler

Häufige Fehlermeldungen

Fehlermeldung	Beschreibung
API Key is required	API Key ist erforderlich
Invalid API Key	API Key ist ungültig
pathKey is required	Ressourcenadresse ist erforderlich
Order not found	Bestellung existiert nicht oder gehört nicht zum aktuellen Benutzer
ErrorCode.USER_BLANCE_NOT_ENOUGH	Unzureichendes Credit-Guthaben

---

Anhang

OrderType (Bestelltyp)

Wert	Beschreibung
track-separation	Spurtrennung (Gesang und Begleitung trennen)
extract-voice	Stimmenextraktion
extract-music	Begleitungsextraktion
extract-text	Textextraktion

OrderStatus (Bestellstatus)

Wert	Beschreibung
pending	Wartend
processing	In Bearbeitung
finish	Abgeschlossen
failed	Fehlgeschlagen
timeout	Zeitüberschreitung

Unterstützte Kurzvideo-Plattformen

• Douyin
• Kuaishou
• Xiaohongshu
• Weibo
• Und andere Mainstream-Kurzvideo-Plattformen