Pereiti prie turinio
DikoAPI
API raktai

Gauti importą

Atverti Markdown

Grąžina vieno importo dabartinę būseną.

GET/library/imports/{import_id}
Reikalingas leidimas
library:read
Autentifikacija
Authorization: Bearer
Ribų politika
readaccount

Kol importas nepasiekė galutinės būsenos, atsakyme yra Retry-After: 3. Tikrinkite ne dažniau.

Parametrai

Parametrai
PavadinimasVietaTipasPrivalomasNumatytoji reikšmėApribojimaiAprašas
import_idpathstringprivalomas–26–26 simbolių · pattern: ^imp_[0-9A-Za-z]{22}$Viešas importo ID (priešdėlis imp_).

Atsakymas

200

Importas.

  • 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į.
  • Retry-After Kiek sekundžių palaukti prieš kitą užklausą.
  • 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 "https://api.diko.app/api/v1/library/imports/imp_7Qw3eR5tY8uI1oP4aS6dFg" \
  -H "Authorization: Bearer $DIKO_API_KEY"

Atsakymo pavyzdys · 200 · application/json

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

Klaidos

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

HTTPKodasReikšmėKartoti?
401missing_api_keyUžklausoje nėra antraštės `Authorization`.ne
401invalid_api_keyAntraš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
401api_key_expiredRakto galiojimas pasibaigė.ne
401api_key_revokedRaktas atšauktas: rankiniu būdu, pasibaigus rotacijos persidengimui, dėl nutekėjimo arba išjungus paskyrą.ne
401api_key_disabledRaktas laikinai išjungtas.ne
402subscription_requiredPaskyra neturi aktyvios apmokėtos prieigos.ne
403ip_not_allowedRaktas turi IP apribojimą, o užklausos IP nėra sąraše arba jo nepavyksta nustatyti patikimai.ne
403account_disabledPaskyra išjungta.ne
403email_not_verifiedPaskyros el. paštas nepatvirtintas.ne
403api_access_suspendedDiko administratorius sustabdė šios paskyros API prieigą.ne
403plan_requiredPlanas neapima API. `error.details.required_plans` yra `verslas`.ne
403insufficient_scopeRaktas neturi endpointui reikalingo leidimo. `error.details` turi `required_scopes` ir `granted_scopes`.ne
404not_foundResurso nėra, jis nepriklauso jūsų paskyrai arba ID užkoduotas neteisingai.ne
429rate_limit_exceededViršyta ribų politika. `error.details.policy` nurodo, kuri.taip, po Retry-After
500internal_errorVidinė serverio klaida.sąlygiškai
503service_unavailablePaslauga laikinai užimta, pavyzdžiui, dėl duomenų bazės apkrovos.taip, po Retry-After

Ieškokite temos, endpointo ar klaidos kodo.

Paieška visuose dokumentacijos puslapiuoseesc uždaryti