Authorization: Bearer <your key>, and
uses the base URL the API Reference declares. Replace hk_live_... with a key
from your dashboard. Set the API base URL before running the examples:
1
Find the show
feed_url and itunes_id, and a show_id.
Publisher-written titles are shown but never needed as input.2
Pick an episode (optional)
A quote takes a show’s newest episodes by default. To reach an older one,
list the show’s episodes and note its The feed URL travels with the request because a
episode_id:show_id is a one-way
derivation and cannot be turned back into a feed.3
Price it
estimated_credits and
quote_ceiling_credits — the estimate plus 25%, rounded up, which is the
most that episode can settle for — plus total_ceiling_credits for the
whole selection and a quote_id. An episode that is already transcribed
comes back is_cached: true at the cached-read price. Nothing is
reserved by a quote.4
Confirm it
total_ceiling_credits; a different number is refused
and nothing is spent. The Idempotency-Key makes a retry safe: the same
key returns the same group instead of spending twice. The response is a
job group: cached episodes appear as cached_read members with a
read_id, everything else as job members holding their reservation.5
Poll the group
member_counts tells you how many jobs are queued, transcribing or
completed; credits_reserved, credits_settled and credits_released
tell you what the group has cost so far. A typical hour of audio finishes
in a few minutes.6
Read the transcript
format is one of json, text, srt, vtt or md. The JSON form
carries segments with start and end times, word timings where the engine
produced them, the detected language, and the source the text came from.
Reading a transcript you already paid for costs nothing.Where the money goes
Balance and reservations are on every quote response as
balance_credits
and reserved_credits, which is how an API-key caller reads what it has left.
