Get a library import

The current state of one import.

GET/library/imports/{import_id}

Required scope: library:read
Authentication: Authorization: Bearer
Rate-limit policy: readaccount

While it is not final the response carries Retry-After: 3; poll no faster than that.

Parameters

Parameters
Name	In	Type	Required	Default	Constraints	Description
`import_id`	path	`string`	required	–	26–26 characters · pattern: ^imp_[0-9A-Za-z]{22}$	Public import ID (`imp_` prefix).

Response

200

The import.

RateLimit The most restrictive policy that applied: "name";r=<requests left>;t=<seconds>, where t is the number of seconds until one more request is allowed (0 when the quota is full). Absent when no rate limiter ran for the request.
RateLimit-Policy The rate-limit policies that applied to the request, one "name";q=<burst>;w=<seconds> item per policy, for example "read";q=10;w=2, "account";q=20;w=2: q is the burst quota and w the seconds in which an empty quota refills. Sent on every authenticated response; absent when no rate limiter ran for the request, for example when it was rejected before the key was checked.
Request-Id ID of this request (req_ prefix), the same as request_id in an error body. It is also sent as X-Request-ID. Quote it when you contact support.
Retry-After Seconds to wait before the next request.
X-Client-Request-Id Your own X-Client-Request-Id request header, echoed back. It is sent only when the value you sent has 1-128 characters from A-Z a-z 0-9 . _ : -.
X-RateLimit-Limit Burst quota of the most restrictive policy (q in RateLimit-Policy). Absent when no rate limiter ran.
X-RateLimit-Remaining Requests left in the most restrictive policy (r in RateLimit). Absent when no rate limiter ran.
X-RateLimit-Reset Seconds until one more request is allowed in the most restrictive policy (t in RateLimit; 0 when the quota is full). It is a number of seconds, not a timestamp. Absent when no rate limiter ran.

Content type: application/json

idstringrequired
Public import ID (imp_ prefix).
26–26 characters · pattern: ^imp_[0-9A-Za-z]{22}$
objectstringrequired
Always library_import.
statusstringrequired
Import status.
Allowed values: queuedprocessingcancelingsucceededfailedcanceled
stagestring | nullrequired
Current stage; only while processing.
Allowed values: captionswaitingdownloadingtranscribingsummarizing
queue_positioninteger | nullrequired
Position among your queued imports (1 = next); null when the import is not queued.
1–2147483647 · format: int32
urlstringrequired
Canonical YouTube URL.
format: uri
youtube_video_idstringrequired
YouTube video ID.
languagestring | nullrequired
Language hint that was sent, or null.
Allowed values: lten
reusedbooleanrequired
True when the video was already in your library or in Diko's shared cache, so no credits were used.
transcript_idstring | nullrequired
ID (trn_ prefix) of the library transcript once the import has succeeded; otherwise null.
6–64 characters · pattern: ^trn_[A-Za-z0-9_-]+$
errorobject | nullrequired
Error details when the import failed; otherwise null.
2 fields
- codestringrequired
  Stable error code. Unknown internal codes are reported as internal_error.
  Allowed values: video_unavailablevideo_privateage_restrictedvideo_too_longvideo_duration_unknowncaptions_unavailabledownload_failedtranscription_failedtranscription_timeoutprovider_limitinsufficient_creditsinternal_error
- messagestringrequired
  Explanation in the language of Accept-Language.
created_atstringrequired
When the import was created.
≤ 24 characters · format: date-time
updated_atstringrequired
When the import last changed.
≤ 24 characters · format: date-time
completed_atstring | nullrequired
When the import reached a final status; otherwise null.
≤ 24 characters · format: date-time

Examples

Request

cURL

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

Python

import os

import requests

response = requests.get(
    "https://api.diko.app/api/v1/library/imports/imp_7Qw3eR5tY8uI1oP4aS6dFg",
    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", {
  headers: {
    Authorization: `Bearer ${process.env.DIKO_API_KEY}`,
  },
})
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`)
console.log(await response.json())

Example response · 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"
}

Errors

This endpoint can return these errors. Every code is described in the error catalog.

HTTP	Code	Meaning	Retry?
401	`missing_api_key`	The request has no `Authorization` header.	no
401	`invalid_api_key`	The header is unusable (a scheme other than `Bearer`, an empty key or more than one `Authorization` header) or the key is unknown or malformed (wrong structure or checksum). The response is identical in all these cases.	no
401	`api_key_expired`	The key has expired.	no
401	`api_key_revoked`	The key was revoked: manually, after a rotation grace period ended, because of a leak or because the account was disabled.	no
401	`api_key_disabled`	The key is temporarily disabled.	no
402	`subscription_required`	The account has no active paid access.	no
403	`ip_not_allowed`	The key has an IP allowlist and the request IP is not on it, or it cannot be determined reliably.	no
403	`account_disabled`	The account is disabled.	no
403	`email_not_verified`	The account e-mail address is not verified.	no
403	`api_access_suspended`	A Diko administrator suspended API access for this account.	no
403	`plan_required`	The plan does not include the API. `error.details.required_plans` lists `verslas`.	no
403	`insufficient_scope`	The key lacks the scope this endpoint needs. `error.details` contains `required_scopes` and `granted_scopes`.	no
404	`not_found`	The resource does not exist, does not belong to your account or its ID is encoded incorrectly.	no
429	`rate_limit_exceeded`	A rate-limit policy was exceeded. `error.details.policy` names it.	yes, after Retry-After
500	`internal_error`	An internal server error.	conditionally
503	`service_unavailable`	The service is temporarily busy, for example because of database load.	yes, after Retry-After