Library

Check transcript coverage for a channel or playlist

Authenticated source-caption coverage for exactly one channel or playlist. Costs 0 credits. Allows 200 requests per free key per UTC day or 2,000 per paid key, including valid warm snapshots. The allowance is checked before upstream work; exhaustion returns 429 QuotaExceeded with Retry-After until 00:00 UTC. The normal key request rate also applies. A cold first enumeration page consumes the separate normal enumeration allowance and Data API capacity; further contiguous warm pages extend the snapshot without additional cold enumeration. Missing IDs and the create_job cold selection are capped at 500. snapshot_complete is false while source enumeration is truncated; next_offset identifies the next enumeration page. Display metadata is refreshed only when the original listing snapshot changes; repeated warm calls do not rewrite unchanged fields or extend their original 30-day freshness deadline. Indexing preserves newer listing metadata. Required counts.uncaptioned counts known non-indexed videos recorded as no_captions or unavailable; they are excluded from missing and cold selections. An existing searchable index takes precedence. complete is true only for a complete source snapshot with nothing indexable missing, and may be true while counts.uncaptioned is positive. This does not promise captions for every known video.

get/v1/library

Request

  • Base URL: https://api.scripthaul.com
  • URL: https://api.scripthaul.com/v1/library
  • Auth: HTTP bearer

Query parameters

channelstring

Exactly one of channel or playlist. Channel handle, URL, or UC ID.

playliststring

Exactly one of channel or playlist. Public playlist ID or URL.

Response

Source-caption coverage, cold estimate, and uncaptioned count. A complete snapshot can have complete=true with uncaptioned videos when nothing indexable is missing.

okunknown required
channelstring nullable required
playliststring nullable required
videos_knowninteger required
indexedinteger required
missingstring[] required

Known video IDs absent from the searchable index, excluding known no_captions or unavailable outcomes. Capped at 500.

completeboolean required

True only when the source snapshot is complete and nothing indexable is missing. May be true with counts.uncaptioned greater than zero; does not promise captions for every known video.

snapshot_completeboolean required
next_offsetinteger nullable

Changes

No recorded changes to this operation across all 1 revision of this API.