API quickstart

TelkNet exposes the same REST API used by the web app, the GPU bridge, and the generated SDK. Browser sessions authenticate with the telknet_session cookie. User-managed personal API keys are not part of the current product.

Read the tool catalog

curl http://127.0.0.1:13000/api/v1/tools

Current tool IDs include music and audio tools music-vocal-harmony-split, music-dry-vocal, music-vocal-split, music-four-stem, music-six-stem, music-drum-split, music-mega-53-stem, music-eight-stem, music-yourmt3, music-miros, 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, and midi-lyrics, plus image tools chordedit, ideogram-v4, and krea-2. The GPU-backed SOTA tools are cataloged under music-muscriptor, music-piano-d3rm, music-piano-video-midi, music-lyrics-guided-vocal-midi, music-audio-to-lead-sheet, midi-to-score, music-instrument-midi, music-vocal-midi, music-beat-tracking, music-general-midi, music-drum-midi, music-guitar-tab, music-chord-analysis, music-audio-alignment, and audio-dnr-separation.

midi-converter is cataloged for the Web app only: conversion runs locally in the browser, and the upload and task submission APIs are not supported.

midi-lyrics also runs entirely in the browser: it combines an existing MIDI file with timestamped LRC lyrics and never uploads either file.

Upload input

Create a presigned upload URL for a selected tool:

curl -X POST http://127.0.0.1:13000/api/v1/tools/music-vocal-split/upload \
  -H "Cookie: telknet_session=YOUR_SESSION_COOKIE; telknet_csrf=YOUR_CSRF_TOKEN" \
  -H "X-CSRF-Token: YOUR_CSRF_TOKEN" \
  -H "X-Requested-With: XMLHttpRequest" \
  -H "Origin: http://127.0.0.1:13001" \
  -H "Content-Type: application/json" \
  -d '{"filename":"sample.mp3","content_type":"audio/mpeg","file_size":1234567}'

Use the returned URL to upload the file, then submit the returned file_key.

Submit a task

curl -X POST http://127.0.0.1:13000/api/v1/tools/music-vocal-split/tasks \
  -H "Cookie: telknet_session=YOUR_SESSION_COOKIE; telknet_csrf=YOUR_CSRF_TOKEN" \
  -H "X-CSRF-Token: YOUR_CSRF_TOKEN" \
  -H "X-Requested-With: XMLHttpRequest" \
  -H "Origin: http://127.0.0.1:13001" \
  -H "Content-Type: application/json" \
  -d '{"tool_id":"music-vocal-split","file_key":"uploads/example.mp3","params":{}}'

The response returns a task id. Poll GET /api/v1/tasks/:taskId until the task finishes, then use GET /api/v1/tasks/:taskId/download or GET /api/v1/tasks/:taskId/files/:fileId for results.