Atšaukti importą

Atšaukia importą.

POST/library/imports/{import_id}/cancel

Reikalingas leidimas: library:write
Autentifikacija: Authorization: Bearer
Ribų politika: writeaccount

queued importas iškart tampa canceled. Vykdomas importas tampa canceling ir baigiasi kaip canceled, kai darbas sustoja. Jau gauta ar baigiama transkripcija vis tiek patenka į jūsų biblioteką ir apmokestinama kaip įprasta. Jau canceling ar canceled importas grąžinamas nepakeistas. succeeded ar failed importas gauna 409 import_not_cancelable.

Parametrai

Parametrai
Pavadinimas	Vieta	Tipas	Privalomas	Numatytoji reikšmė	Apribojimai	Aprašas
`import_id`	path	`string`	privalomas	–	26–26 simbolių · pattern: ^imp_[0-9A-Za-z]{22}$	Viešas importo ID (priešdėlis `imp_`).
`Idempotency-Key`	header	`string`	ne	–	8–255 simbolių · pattern: ^[A-Za-z0-9_\-:.]{8,255}$	Padaro pakartojimą saugų: tas pats raktas su ta pačia užklausa grąžina pirmąjį atsakymą (`Idempotent-Replayed: true`); kita užklausa su tuo pačiu raktu atmetama su 422 `idempotency_key_reused`. 8–255 simboliai iš A-Z a-z 0-9 _ - : . Saugomas 24 val.

Atsakymas

200

Importas po atšaukimo užklausos.

Idempotent-Replayed true, kai atsakymas yra ankstesnės užklausos su tuo pačiu Idempotency-Key pakartojimas.
RateLimit Labiausiai ribojanti taikyta politika: "pavadinimas";r=<liko užklausų>;t=<sekundės>. t – sekundės iki kitos leidžiamos užklausos (0, kai talpa pilna). Nesiunčiama, kai užklausai ribotuvas netaikytas.
RateLimit-Policy Užklausai taikytos ribų politikos, po vieną elementą "pavadinimas";q=<pradinė talpa>;w=<sekundės> kiekvienai, pavyzdžiui, "read";q=10;w=2, "account";q=20;w=2: q – pradinė talpa, w – sekundės, per kurias tuščia talpa vėl prisipildo. Siunčiama su kiekvienu autentifikuotu atsakymu; nesiunčiama, kai užklausai ribotuvas netaikytas, pavyzdžiui, kai ji atmesta dar nepatikrinus rakto.
Request-Id Šios užklausos ID (priešdėlis req_), toks pat kaip request_id klaidos atsakyme. Siunčiamas ir kaip X-Request-ID. Kreipdamiesi pagalbos nurodykite jį.
X-Client-Request-Id Jūsų siųsta užklausos antraštė X-Client-Request-Id, grąžinta atgal. Grąžinama tik tada, kai jūsų reikšmė turi 1–128 simbolius iš A-Z a-z 0-9 . _ : -.
X-RateLimit-Limit Labiausiai ribojančios politikos pradinė talpa (q antraštėje RateLimit-Policy). Nesiunčiama, kai užklausai ribotuvas netaikytas.
X-RateLimit-Remaining Labiausiai ribojančioje politikoje likusios užklausos (r antraštėje RateLimit). Nesiunčiama, kai užklausai ribotuvas netaikytas.
X-RateLimit-Reset Sekundės iki kitos leidžiamos užklausos labiausiai ribojančioje politikoje (t antraštėje RateLimit; 0, kai talpa pilna). Tai sekundžių skaičius, o ne laiko žyma. Nesiunčiama, kai užklausai ribotuvas netaikytas.

Turinio tipas: application/json

idstringprivalomas
Viešas importo ID (priešdėlis imp_).
26–26 simbolių · pattern: ^imp_[0-9A-Za-z]{22}$
objectstringprivalomas
Visada library_import.
statusstringprivalomas
Importo būsena.
Galimos reikšmės: queuedprocessingcancelingsucceededfailedcanceled
stagestring | nullprivalomas
Dabartinis etapas; tik kai processing.
Galimos reikšmės: captionswaitingdownloadingtranscribingsummarizing
queue_positioninteger | nullprivalomas
Vieta tarp jūsų eilėje esančių importų (1 = kitas); null, kai importas nėra queued.
1–2147483647 · format: int32
urlstringprivalomas
Kanoninis YouTube URL.
format: uri
youtube_video_idstringprivalomas
YouTube vaizdo įrašo ID.
languagestring | nullprivalomas
Išsiųsta kalbos užuomina arba null.
Galimos reikšmės: lten
reusedbooleanprivalomas
true, kai vaizdo įrašas jau buvo jūsų bibliotekoje arba bendroje Diko talpykloje, todėl kreditai nenaudoti.
transcript_idstring | nullprivalomas
Bibliotekos transkripcijos ID (priešdėlis trn_), kai importas succeeded; kitaip null.
6–64 simbolių · pattern: ^trn_[A-Za-z0-9_-]+$
errorobject | nullprivalomas
Klaidos duomenys, kai importas failed; kitaip null.
2 laukai
- codestringprivalomas
  Stabilus klaidos kodas. Nežinomi vidiniai kodai pateikiami kaip internal_error.
  Galimos reikšmės: video_unavailablevideo_privateage_restrictedvideo_too_longvideo_duration_unknowncaptions_unavailabledownload_failedtranscription_failedtranscription_timeoutprovider_limitinsufficient_creditsinternal_error
- messagestringprivalomas
  Paaiškinimas Accept-Language kalba.
created_atstringprivalomas
Kada importas sukurtas.
≤ 24 simbolių · format: date-time
updated_atstringprivalomas
Kada importas paskutinį kartą pasikeitė.
≤ 24 simbolių · format: date-time
completed_atstring | nullprivalomas
Kada importas pasiekė galutinę būseną; kitaip null.
≤ 24 simbolių · format: date-time

Pavyzdžiai

Užklausa

cURL

curl -X POST "https://api.diko.app/api/v1/library/imports/imp_7Qw3eR5tY8uI1oP4aS6dFg/cancel" \
  -H "Authorization: Bearer $DIKO_API_KEY"

Python

import os

import requests

response = requests.post(
    "https://api.diko.app/api/v1/library/imports/imp_7Qw3eR5tY8uI1oP4aS6dFg/cancel",
    headers={"Authorization": f"Bearer {os.environ['DIKO_API_KEY']}"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

TypeScript

const response = await fetch("https://api.diko.app/api/v1/library/imports/imp_7Qw3eR5tY8uI1oP4aS6dFg/cancel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.DIKO_API_KEY}`,
  },
})
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`)
console.log(await response.json())

Atsakymo pavyzdys · 200 · application/json

JSON

{
  "id": "imp_6Mfj7Oxm4MfxGGmZRhiUQf",
  "object": "library_import",
  "status": "canceling",
  "stage": "downloading",
  "queue_position": null,
  "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
  "youtube_video_id": "dQw4w9WgXcQ",
  "language": "lt",
  "reused": false,
  "transcript_id": null,
  "error": null,
  "created_at": "2026-10-11T09:30:00.000Z",
  "updated_at": "2026-10-11T09:30:00.100Z",
  "completed_at": null
}

Klaidos

Šis endpointas gali grąžinti šias klaidas. Visų kodų aprašai yra klaidų kataloge.

HTTP	Kodas	Reikšmė	Kartoti?
400	`idempotency_key_invalid`	`Idempotency-Key` netinkamas: reikia 8–255 simbolių iš aibės `A-Z a-z 0-9 _ - : .`.	ne
401	`missing_api_key`	Užklausoje nėra antraštės `Authorization`.	ne
401	`invalid_api_key`	Antraštė netinkama (ne `Bearer` schema, tuščias raktas arba kelios antraštės `Authorization`) arba raktas nežinomas ar blogo formato (neatitinka struktūros ar kontrolinės sumos). Atsakymas visais šiais atvejais vienodas.	ne
401	`api_key_expired`	Rakto galiojimas pasibaigė.	ne
401	`api_key_revoked`	Raktas atšauktas: rankiniu būdu, pasibaigus rotacijos persidengimui, dėl nutekėjimo arba išjungus paskyrą.	ne
401	`api_key_disabled`	Raktas laikinai išjungtas.	ne
402	`subscription_required`	Paskyra neturi aktyvios apmokėtos prieigos.	ne
403	`ip_not_allowed`	Raktas turi IP apribojimą, o užklausos IP nėra sąraše arba jo nepavyksta nustatyti patikimai.	ne
403	`account_disabled`	Paskyra išjungta.	ne
403	`email_not_verified`	Paskyros el. paštas nepatvirtintas.	ne
403	`api_access_suspended`	Diko administratorius sustabdė šios paskyros API prieigą.	ne
403	`plan_required`	Planas neapima API. `error.details.required_plans` yra `verslas`.	ne
403	`insufficient_scope`	Raktas neturi endpointui reikalingo leidimo. `error.details` turi `required_scopes` ir `granted_scopes`.	ne
404	`not_found`	Resurso nėra, jis nepriklauso jūsų paskyrai arba ID užkoduotas neteisingai.	ne
409	`import_not_cancelable`	Importas jau baigtas (`succeeded` arba `failed`) ir nebegali būti atšauktas.	ne
409	`idempotency_in_progress`	Ta pati užklausa su tuo pačiu `Idempotency-Key` dar vykdoma.	taip, po Retry-After
422	`idempotency_key_reused`	Tas pats `Idempotency-Key` panaudotas su kitu metodu, keliu ar turiniu.	ne
429	`rate_limit_exceeded`	Viršyta ribų politika. `error.details.policy` nurodo, kuri.	taip, po Retry-After
500	`internal_error`	Vidinė serverio klaida.	sąlygiškai
503	`writes_disabled`	Rašymo operacijos laikinai išjungtos platformos pusėje. Skaitymas veikia.	taip, po Retry-After
503	`service_unavailable`	Paslauga laikinai užimta, pavyzdžiui, dėl duomenų bazės apkrovos.	taip, po Retry-After