Instrukcja integracji · API

Instrukcja integracji · API · TelkNet

Wywołuj narzędzia przez HTTPS przy użyciu osobistego klucza. Wykonuj przykłady kolejno, aby oddzielić wokal z MP3. Przed zmianą narzędzia sprawdź parametry i limity.

Wymaga Bash, curl 7.76+ i jq. Używaj tego samego terminala.

Bash / curl ↓PowerShell 7 ↓Python 3 ↓

01Przygotowanie i uwierzytelnianie

Utwórz klucz Odczyt i wykonanie i wyślij Authorization: Bearer. Cookie logowania, CSRF i odnawianie sesji przeglądarki nie są potrzebne.

Puste listy narzędzi i IP zezwalają na wszystkie; zasady konta nadal obowiązują. Limity według UTC. Przerwane transfery zachowują przydział. Nowy klucz zachowuje uprawnienia i datę wygaśnięcia. Zaktualizuj skrypty w ciągu maksymalnie pięciu minut okresu przejściowego.

Utwórz klucz →

Bash / curl

jq() { command jq "$@" | tr -d '\r'; }
read -rsp 'TELKNET_API_KEY: ' TELKNET_API_KEY; printf '\n'
export TELKNET_API_KEY
BASE="${TELKNET_BASE_URL:-https://telknet.cc}"
TOOL="${TELKNET_TOOL:-music-vocal-split}"
FILE="${TELKNET_FILE:-sample.mp3}"
curl --connect-timeout 10 --max-time 60 --fail-with-body "$BASE/api/v1/credits/balance" \
  -H "Authorization: Bearer $TELKNET_API_KEY"

02Wyślij plik

Uzyskaj podpisany URL i wyślij oryginał przez PUT. Podaj rzeczywistą liczbę bajtów oraz identyczny Content-Type.

Bash / curl

curl --connect-timeout 10 --max-time 60 --fail-with-body "$BASE/api/v1/tools/$TOOL/upload" \
  -H "Authorization: Bearer $TELKNET_API_KEY" \
  -H 'Content-Type: application/json' \
  -d "$(jq -n --arg filename "$(basename "$FILE")" \
    --argjson size "$(wc -c < "$FILE")" \
    '{filename:$filename,content_type:"audio/mpeg",file_size:$size}')" \
  -o upload.json || { cat upload.json >&2; exit 1; }
curl --connect-timeout 10 --max-time 1800 --fail-with-body --request PUT \
  -H 'Content-Type: audio/mpeg' --upload-file "$FILE" \
  "$(jq -r '.data.upload_url' upload.json)"

URL zwykle ważny jest 15 minut. Nie wysyłaj klucza do PUT. Przykład używa pojedynczego PUT; dla multipart_supported=true wyślij parts i wywołaj upload/multipart/complete lub abort przy błędzie.

03Potwierdź cenę i zleć

Pobierz cenę bazową narzędzia/modelu, wyślij bez zmian w pricing i zapisz task_id. Liczba i przetwarzanie wstępne podlegają taryfie narzędzia; trening RVC wymaga analizy i wyceny treningu.

Bash / curl

printf '{}' > params.json
curl --connect-timeout 10 --max-time 60 --fail-with-body "$BASE/api/v1/tools/$TOOL/quote" \
  -H "Authorization: Bearer $TELKNET_API_KEY" \
  -H 'Content-Type: application/json' \
  -d "$(jq -n --slurpfile params params.json '{params:$params[0]}')" \
  -o quote.json || { cat quote.json >&2; exit 1; }
jq -n --arg tool "$TOOL" --arg key "$(jq -r '.data.s3_key' upload.json)" \
  --slurpfile params params.json --slurpfile quote quote.json \
  '{tool_id:$tool,file_key:$key,params:$params[0],pricing:$quote[0].data}' > request.json
REQUEST_KEY="$(date +%s)-$(od -An -N16 -tx1 /dev/urandom | tr -d ' \n')"
printf '%s' "$REQUEST_KEY" > request-key.txt
curl --connect-timeout 10 --max-time 60 --fail-with-body "$BASE/api/v1/tools/$TOOL/tasks" \
  -H "Authorization: Bearer $TELKNET_API_KEY" \
  -H "Idempotency-Key: $REQUEST_KEY" \
  -H 'Content-Type: application/json' --data-binary @request.json -o task.json || { cat task.json >&2; exit 1; }
TASK=$(jq -r '.data.task_id' task.json)

Wycena nie rezerwuje kredytów. Przy 409 PRICE_CHANGED pobierz i potwierdź nową cenę. Generowanie muzyki i cover z referencją wymagają parametrów wybranych modeli.

Zachowaj request-key.txt i request.json. To samo konto, Idempotency-Key i identyczna treść zwracają pierwotne zadanie. Nowe zadanie wymaga nowego klucza; najpierw wyjaśnij wysyłkę o nieznanym wyniku.

04Sprawdź postęp

Sprawdzaj co 3 sekundy. Pobieraj po completed; failed, timeout i cancelled kończą zadanie. Po dwóch godzinach kończy się oczekiwanie, nie zadanie.

Bash / curl

deadline=$((SECONDS + 7200))
while (( SECONDS < deadline )); do
  curl --connect-timeout 10 --max-time 60 --fail-with-body "$BASE/api/v1/tasks/$TASK" \
    -H "Authorization: Bearer $TELKNET_API_KEY" -o status.json || { cat status.json >&2; exit 1; }
  status=$(jq -r '.data.status' status.json)
  case "$status" in
    completed) break ;;
    failed|timeout|cancelled) cat status.json >&2; exit 1 ;;
    pending|processing) sleep 3 ;;
    *) cat status.json >&2; exit 1 ;;
  esac
done
test "$(jq -r '.data.status' status.json)" = completed

05Pobierz wyniki

Zakoduj s3_key z output_files dla URL i użyj jako fileId. proxy=true przesyła oryginał z tego samego źródła z kontrolą własności.

Bash / curl

mkdir -p results
jq -r '.data.output_files | to_entries[] | .key' status.json | while read -r INDEX; do
  FILE_ID=$(jq -r --argjson i "$INDEX" '.data.output_files[$i].s3_key | @uri' status.json)
  NAME=$(basename "$(jq -r --argjson i "$INDEX" '.data.output_files[$i].name' status.json)")
  curl --connect-timeout 10 --max-time 7200 --fail-with-body "$BASE/api/v1/tasks/$TASK/files/$FILE_ID?proxy=true" \
    -H "Authorization: Bearer $TELKNET_API_KEY" \
    --output "results/$INDEX-$NAME.part" || exit 1
  EXPECTED=$(jq -r --argjson i "$INDEX" '.data.output_files[$i].size_bytes' status.json)
  test "$(wc -c < "results/$INDEX-$NAME.part")" -eq "$EXPECTED" || exit 1
  mv "results/$INDEX-$NAME.part" "results/$INDEX-$NAME"
done

Żądania Bearer do /api/v1/tasks/{taskId}/download zwracają bezpośrednio oryginał lub ZIP. Obowiązuje okres przechowywania; klucz API nie trafia do magazynu obiektowego.

Błędy i wznowienie

Sprawdź status HTTP oraz oryginalne error.code, message, details. Nie polegaj wyłącznie na tekście i nie zapisuj błędu jako wyniku.

400	Sprawdź plik, parametry i JSON.
401	Brak klucza lub klucz nieprawidłowy, wygasły, unieważniony.
402	Za mało kredytów; sprawdź saldo.
403	Tylko odczyt lub brak dostępu.
404	Brak zasobu albo inny właściciel.
409	Zmiana ceny lub stanu; odczytaj kod.
413	Plik przekracza limit narzędzia.
429	Za dużo żądań; odczekaj Retry-After.
503	Konserwacja lub chwilowa awaria; zachowaj błąd i sprawdź później.

Przy 429 odczekaj Retry-After lub stosuj ograniczone opóźnienia. Powtarzaj tylko bezpieczne odczyty. Po przekroczeniu czasu POST najpierw sprawdź wynik pierwotnego żądania, zamiast tworzyć kolejne zadanie.

JSON

{
  "ok": false,
  "error": {
    "code": "API_KEY_SCOPE",
    "message": "Ten klucz API nie pozwala na tę operację.",
    "details": []
  }
}

Bash / curl

HTTP_CODE=$(curl --connect-timeout 10 --max-time 60 --silent --show-error \
  -H "Authorization: Bearer $TELKNET_API_KEY" \
  --output response.json --dump-header response.headers --write-out '%{http_code}' \
  "$BASE/api/v1/tasks/$TASK")
if [[ "$HTTP_CODE" != 2* ]]; then
  cat response.json >&2
  if [[ "$HTTP_CODE" == 429 ]]; then
    awk 'tolower($1)=="retry-after:" {print $2}' response.headers
  fi
  exit 1
fi

Zachowaj task_id w task.json i wznów sprawdzanie statusu. Sprawdź ostatnie zgłoszenia na liście; cancel wywołuj tylko przy zamiarze zatrzymania.

Opis API

Ścieżki używają /api/v1 tej samej witryny. Klucze dają dostęp tylko do własnych zasobów, bez zarządzania kontem, tworzenia kluczy, admina i wewnętrznych callbacków.

GET	`/api/v1/tools`	Katalog narzędzi
GET	`/api/v1/tools/{toolId}`	Parametry i limity
GET	`/api/v1/credits/balance`	Saldo kredytów
POST	`/api/v1/tools/{toolId}/quote`	Aktualna cena
POST	`/api/v1/tools/{toolId}/upload`	Wyślij plik
POST	`/api/v1/tools/{toolId}/tasks`	Potwierdź cenę i zleć
GET	`/api/v1/tasks/{taskId}`	Sprawdź postęp
GET	`/api/v1/tasks`	Twoje zadania
GET	`/api/v1/tasks/{taskId}/files/{fileId}?proxy=true`	Pobierz wyniki
POST	`/api/v1/tasks/{taskId}/cancel`	Anuluj własne zadanie

midi-converter i midi-lyrics działają w przeglądarce bez API wysyłania i wykonania na serwerze. Szczegóły innych narzędzi określają dostępność, formaty, rozmiary i parametry.

Katalog narzędzi

music-yourmt3, music-yourmt3-ymt3-plus, music-yourmt3-yptf-single-nops, music-yourmt3-yptf-multi-ps, music-yourmt3-yptf-moe-multi-ps, music-miros, music-vocal-harmony-split, music-dry-vocal, music-vocal-split, music-four-stem, music-six-stem, music-drum-split, music-drum-split-drumsep-mdx23c-6, music-mega-53-stem, music-eight-stem, music-restoration, music-custom-stem, music-piano-transkun, music-piano-transkun-standard, music-piano-transkun-v2-aug, music-piano-aria, music-piano-bytedance-pedal, ai-rvc, zonos2-tts, midi-converter, midi-lyrics,