Guía de integración · API

Guía de integración · API · TelkNet

Llama a las herramientas por HTTPS con una clave personal. Ejecuta estos ejemplos en orden para separar voces de un MP3. Consulta parámetros y límites antes de cambiar de herramienta.

Requiere Bash, curl 7.76+ y jq. Ejecuta en el mismo terminal.

Bash / curl ↓PowerShell 7 ↓Python 3 ↓

01Preparación y autenticación

Crea una clave de Lectura y ejecución y envía Authorization: Bearer. No necesitas Cookie de sesión, CSRF ni renovar la sesión del navegador.

Las listas vacías permiten todas las herramientas e IP; se mantiene la política de cuenta. Presupuestos en UTC. Las transferencias interrumpidas conservan su asignación. La nueva clave conserva permisos y vencimiento. Actualiza los scripts durante los cinco minutos de transición como máximo.

Crear clave →

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"

02Subir archivo

Solicita una URL firmada y envía el original con PUT. Usa el tamaño real en bytes y el mismo 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)"

Las URL suelen durar 15 minutos. No envíes la clave al PUT. El ejemplo usa un PUT; con multipart_supported=true, sube parts y llama a upload/multipart/complete, o abort si falla.

03Confirmar precio y enviar

Consulta el precio base del modelo o herramienta, envíalo sin cambios en pricing y guarda task_id. Cantidad y preprocesamiento siguen las tarifas de la herramienta; RVC necesita primero análisis y presupuesto de entrenamiento.

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)

El presupuesto no reserva créditos. Ante 409 PRICE_CHANGED, consulta y confirma el nuevo precio. Generación musical y versiones de referencia requieren parámetros de los modelos elegidos.

Conserva request-key.txt y request.json. La misma cuenta, Idempotency-Key y contenido idéntico devuelven la tarea original. Usa una clave nueva para otra tarea y comprueba los envíos de resultado incierto antes de repetirlos.

04Consultar progreso

Consulta cada 3 segundos. Descarga tras completed; failed, timeout y cancelled son finales. El ejemplo deja de esperar a las dos horas sin cancelar la tarea.

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

05Descargar resultados

Codifica s3_key de output_files para URL y úsalo como fileId. proxy=true transmite el original desde el mismo origen y comprueba la propiedad.

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

Las solicitudes Bearer a /api/v1/tasks/{taskId}/download devuelven el original o un ZIP directamente. Se aplica la retención de archivos; la clave API nunca se envía al almacenamiento.

Errores y recuperación

Revisa el estado HTTP y los error.code, message, details originales. No dependas solo del texto ni guardes errores como archivos de resultado.

400	Comprueba archivo, parámetros y JSON.
401	Clave ausente, inválida, caducada o revocada.
402	Créditos insuficientes; revisa el saldo.
403	Solo lectura o acceso denegado.
404	Recurso inexistente o de otra cuenta.
409	Precio o estado cambiado; revisa el código.
413	Archivo superior al límite de la herramienta.
429	Demasiadas solicitudes; respeta Retry-After.
503	Mantenimiento o fallo temporal; guarda el error y consulta después.

Ante 429 espera Retry-After o aplica espera progresiva limitada. Reintenta solo lecturas seguras. Si un POST de subida o tarea agota el tiempo, verifica su resultado antes de crear otra tarea.

JSON

{
  "ok": false,
  "error": {
    "code": "API_KEY_SCOPE",
    "message": "Esta clave API no permite esta operación.",
    "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

Conserva task_id en task.json y retoma las consultas. Comprueba envíos recientes en la lista; llama a cancel solo si quieres detener la tarea.

Referencia API

Todos los caminos usan /api/v1 del mismo sitio. Las claves solo acceden a tus recursos, no a cuentas, creación de claves, administración ni callbacks internos.

GET	`/api/v1/tools`	Catálogo de herramientas
GET	`/api/v1/tools/{toolId}`	Parámetros y límites
GET	`/api/v1/credits/balance`	Saldo de créditos
POST	`/api/v1/tools/{toolId}/quote`	Precio actual
POST	`/api/v1/tools/{toolId}/upload`	Subir archivo
POST	`/api/v1/tools/{toolId}/tasks`	Confirmar precio y enviar
GET	`/api/v1/tasks/{taskId}`	Consultar progreso
GET	`/api/v1/tasks`	Tus tareas
GET	`/api/v1/tasks/{taskId}/files/{fileId}?proxy=true`	Descargar resultados
POST	`/api/v1/tasks/{taskId}/cancel`	Cancelar tu tarea

midi-converter y midi-lyrics funcionan en el navegador sin API de subida ni ejecución en servidor. Los detalles de otras herramientas definen disponibilidad, formatos, tamaño y parámetros.

Catálogo de herramientas

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,