> ## Documentation Index > Fetch the complete documentation index at: https://docs.audivo.dev/llms.txt > Use this file to discover all available pages before exploring further. # Find shows by name > Free-text show search over Podcast Index: its exact-title search (`search/bytitle`) and its fuzzy term search (`search/byterm`) are issued together and merged, title hits first, each show once. The provider decides which shows match — no local fuzzy matcher — and the order is Audivo's, so the same name finds the same show every time: titles that match the query exactly come first, then titles that start with it, then titles that contain it as whole words, then the rest; within each of those, the show with the larger catalogue first, then a show with an Apple listing before one without, then the provider's own order. Titles are compared case-insensitively, ignoring punctuation and a leading "The", and a title is graded both whole and by the part before its subtitle (`Name: Subtitle`), taking the better. Every entry carries `music_led` and the basis for it: a music-led show the caller searched for by name is *marked*, never removed, because they named it; the boundary is applied when a chart-derived selection is quoted (`POST /v1/quotes`). A provider entry that carries no feed URL cannot be selected or identified and is reported in `excluded` rather than dropped. The provider does not page this call, so `next_cursor` is always `null` and no cursor parameter is accepted; `limit` is how many entries come back. The provider is asked for at least twenty so the ranking has something to choose from. ## OpenAPI ````yaml /openapi.yaml get /v1/search/shows openapi: 3.1.0 info: title: Audivo API version: 0.11.0 description: >- The Audivo API turns a public podcast episode into a clean, timed transcript. Name an episode by an Apple Podcasts link, by its RSS feed URL and GUID, or by the episode id an earlier answer gave you; get back structured, timed text — at once for an episode already transcribed, or as a job you poll for fresh audio. Two authentication schemes, and which an operation takes is part of what it is: `apiKeyBearer` — an `hk_live_` key sent as `Authorization: Bearer` — authenticates the public API, and `dashboardJwt` authenticates the dashboard's own operations. No operation that takes one accepts the other in its place. An API-key caller reads its balance and reservations from any quote response. Deferred on purpose, and absent from this document rather than hidden: webhooks, subscriptions, speaker labels beyond the frozen `diarized: false` shape, custom vocabulary, caller-selected engines, raw-audio URLs and uploads, SDKs, translation, and cross-corpus search. What changed in each version is on the documentation site's changelog. license: name: Proprietary url: https://docs.audivo.dev/legal/terms servers: - url: https://k8mfogcvz4.execute-api.us-east-1.amazonaws.com/prod description: Production API. Append the operation path, including /v1. security: [] tags: - name: Transcripts description: Create, poll, retrieve, and cancel transcription jobs. - name: Catalog description: >- Public podcast show/episode search, charts, detail, and resolution. Every metadata/search/list call in this tag costs 1 credit; no catalog response echoes `credits_charged`, so the charge is stated here rather than per-response. Not yet applied: the discovery operations shipped in 0.2.0 (`GET /v1/search/shows`, `GET /v1/charts`) are metered by request rate only and write no credit-bearing row; the per-call charge lands with the catalog reads that bill. - name: Quotes description: >- Price a selection before spending. A quote resolves every episode in it, records what it resolved under a short TTL, and reserves nothing; the confirm that follows is the operation that spends, and it answers with a job group. - name: Groups description: >- The job group: what one confirm created. A group holds N ≥ 1 members, each a transcription job or a settled cache read; a single-episode `POST /v1/transcripts` is a group of one. A caller reads a group's rollup, lists their own groups newest first, and cancels a group, which cancels every member not yet started and releases each reservation exactly once. - name: Session description: >- Dashboard-JWT session establishment. One operation, called by the dashboard's backend-for-frontend whenever it turns a Cognito sign-in into a Audivo session, and the one place a caller who does not yet have an account is served. - name: Account description: Usage, limits, and supported languages for the calling account. - name: API Keys description: Dashboard-JWT key lifecycle management. - name: Billing description: Dashboard-JWT Stripe Checkout, Customer Portal, invoices, and refunds. - name: Data description: Dashboard-JWT portable export and account deletion. paths: /v1/search/shows: get: tags: - Catalog summary: Find shows by name description: >- Free-text show search over Podcast Index: its exact-title search (`search/bytitle`) and its fuzzy term search (`search/byterm`) are issued together and merged, title hits first, each show once. The provider decides which shows match — no local fuzzy matcher — and the order is Audivo's, so the same name finds the same show every time: titles that match the query exactly come first, then titles that start with it, then titles that contain it as whole words, then the rest; within each of those, the show with the larger catalogue first, then a show with an Apple listing before one without, then the provider's own order. Titles are compared case-insensitively, ignoring punctuation and a leading "The", and a title is graded both whole and by the part before its subtitle (`Name: Subtitle`), taking the better. Every entry carries `music_led` and the basis for it: a music-led show the caller searched for by name is *marked*, never removed, because they named it; the boundary is applied when a chart-derived selection is quoted (`POST /v1/quotes`). A provider entry that carries no feed URL cannot be selected or identified and is reported in `excluded` rather than dropped. The provider does not page this call, so `next_cursor` is always `null` and no cursor parameter is accepted; `limit` is how many entries come back. The provider is asked for at least twenty so the ranking has something to choose from. operationId: searchShows parameters: - $ref: '#/components/parameters/SearchQueryParam' - $ref: '#/components/parameters/LimitQueryParam' responses: '200': description: The matching shows, ranked as described above. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' content: application/json: schema: $ref: '#/components/schemas/ShowSearchResponse' examples: results: $ref: '#/components/examples/ShowSearchPage' '400': $ref: '#/components/responses/BadRequestApiKey' '401': $ref: '#/components/responses/UnauthorizedApiKey' '429': $ref: '#/components/responses/TooManyRequestsApiKey' '500': $ref: '#/components/responses/InternalErrorApiKey' '503': $ref: '#/components/responses/DiscoveryUnavailableApiKey' security: - apiKeyBearer: [] components: parameters: SearchQueryParam: name: q in: query required: true description: Free-text show search query. schema: type: string minLength: 1 maxLength: 200 LimitQueryParam: name: limit in: query required: false description: Maximum number of items to return. schema: type: integer minimum: 1 maximum: 100 default: 20 headers: XRequestId: description: >- Echoed on every response, success or error. A refusal generated at the edge (401, 429, and the unmetered-key 500) carries API Gateway's own hyphenated request id after the `req_` prefix; a response from a function carries the same id without hyphens. schema: type: string pattern: ^req_[A-Za-z0-9-]+$ maxLength: 100 XRateLimitLimit: description: >- The caller's requests-per-minute ceiling for the current tier. Present on every response for a resolved caller, success and error alike; absent from `401 unauthenticated`, which has no account to report a ceiling for, and from the edge's own `429`, which is emitted before any function runs. schema: type: integer minimum: 0 RetryAfter: description: >- Seconds to wait before retrying. Sent with the edge's `rate_limited` throttle refusal. Not sent with `concurrency_limited`, which clears when one of the account's own jobs reaches a terminal state — a moment the API cannot put a number on. schema: type: integer minimum: 0 schemas: ShowSearchResponse: type: object additionalProperties: false required: - data - excluded - next_cursor properties: data: type: array maxItems: 100 items: $ref: '#/components/schemas/ShowSummary' excluded: type: array maxItems: 100 items: $ref: '#/components/schemas/DiscoveryExclusion' next_cursor: $ref: '#/components/schemas/NullableCursor' description: Always `null`; the provider does not page this call. ShowSummary: type: object additionalProperties: false required: - show_id - title - feed_url - itunes_id - author - categories - artwork_url - music_led - music_led_basis description: >- One show as a discovery surface returns it (search or chart), before any selection rule applies. `show_id` is derived from the provider's iTunes id when it carries one and from the feed URL otherwise, so it is stable across the two surfaces and the quote. `music_led` is the music-led marking: a coarse, show-level judgement from the provider's category labels — `music_led_basis` says which — that cannot see a music bed inside a talk show and over-excludes spoken commentary *about* music; the caller can opt back in when quoting. properties: show_id: $ref: '#/components/schemas/ShowId' title: type: string minLength: 1 maxLength: 300 feed_url: $ref: '#/components/schemas/FeedUrl' itunes_id: description: The iTunes collection ID, or `null` if the provider knows none. anyOf: - type: integer minimum: 1 - enum: - null author: description: The show's author as the provider carries it, or `null`. anyOf: - type: string maxLength: 300 - enum: - null categories: type: array maxItems: 50 items: type: string maxLength: 100 description: The provider's category names for the show, in provider order. artwork_url: $ref: '#/components/schemas/NullableUri' music_led: type: boolean description: Whether the show is music-led; see the schema description. music_led_basis: type: string minLength: 1 maxLength: 300 description: What `music_led` is based on, in words a caller can show. DiscoveryExclusion: type: object additionalProperties: false required: - title - reason - detail description: >- A provider entry a caller cannot act on, named rather than dropped: without a usable feed URL there is no `show_id` to derive and nothing to select. Present so a list never shrinks silently. properties: title: type: string minLength: 1 maxLength: 300 reason: type: string enum: - no_feed_url - invalid_feed_url detail: type: string minLength: 1 maxLength: 1000 NullableCursor: description: An opaque pagination cursor, or `null` when there is no next page. anyOf: - $ref: '#/components/schemas/Cursor' - enum: - null Error: type: object additionalProperties: false required: - error properties: error: $ref: '#/components/schemas/ErrorDetail' ShowId: type: string pattern: ^sh_[a-z2-7]{16}$ description: Canonical show identifier. FeedUrl: type: string format: uri minLength: 1 maxLength: 2048 description: An RSS/Atom feed URL. NullableUri: description: A URL, or `null`. anyOf: - type: string format: uri maxLength: 2048 - enum: - null Cursor: type: string pattern: ^[A-Za-z0-9_-]{1,512}$ description: An opaque pagination cursor. Callers must treat it as opaque. ErrorDetail: type: object additionalProperties: false required: - type - code - message - doc_url - request_id - retryable properties: type: $ref: '#/components/schemas/ErrorType' code: $ref: '#/components/schemas/ErrorCode' message: type: string minLength: 1 maxLength: 1000 doc_url: type: string format: uri maxLength: 300 request_id: $ref: '#/components/schemas/RequestId' retryable: type: boolean oneOf: - required: - code - type properties: code: enum: - invalid_request - invalid_url - source_not_supported - unsafe_source type: const: invalid_request - required: - code - type properties: code: enum: - duration_exceeded - size_exceeded - unsupported_codec - unsupported_language - credits_not_refundable type: const: unprocessable_input - required: - code - type properties: code: const: unauthenticated type: const: unauthenticated - required: - code - type properties: code: enum: - idempotency_conflict - job_not_completed - quote_expired - quote_mismatch - quote_unverified - expected_total_mismatch - request_in_progress - account_suspended - account_closed - account_not_found - api_key_limit_reached - tier_unchanged type: const: conflict - required: - code - type properties: code: enum: - feed_dead - episode_not_found - show_not_found - job_not_found - quote_not_found - group_not_found - api_key_not_found - credit_lot_not_found type: const: not_found - required: - code - type properties: code: const: content_blocked type: const: content_blocked - required: - code - type properties: code: const: payment_required type: const: payment_required - required: - code - type properties: code: enum: - rate_limited - concurrency_limited type: const: rate_limited - required: - code - type properties: code: enum: - engine_unavailable - processing_failed - discovery_unavailable - internal_error type: const: unavailable - required: - code - type properties: code: const: nothing_to_quote type: const: unprocessable_input ErrorType: type: string enum: - invalid_request - unprocessable_input - unauthenticated - conflict - not_found - content_blocked - payment_required - rate_limited - unavailable description: >- The family an error belongs to, for handling; `code` is the precise reason. `invalid_request`: something in the request is wrong — fix the integration. `unprocessable_input`: the request is well-formed but the episode or resource is outside published support. `unauthenticated`: missing, malformed, revoked or expired credential. `payment_required`: the account's credits cannot cover the ceiling. `conflict`: the resource's or the account's state refuses this request as sent — a lapsed quote, a reused idempotency key, a held account. `not_found`: the job, quote, group or key the request named does not exist for this account. `rate_limited`: over a plan limit; wait and retry. `unavailable`: a failure on our side or at a provider; retry, and quote `request_id` if it persists. ErrorCode: type: string enum: - invalid_request - invalid_url - unauthenticated - idempotency_conflict - job_not_completed - source_not_supported - feed_dead - episode_not_found - show_not_found - unsafe_source - unsupported_codec - unsupported_language - duration_exceeded - size_exceeded - content_blocked - payment_required - rate_limited - concurrency_limited - job_not_found - api_key_not_found - api_key_limit_reached - credit_lot_not_found - credits_not_refundable - engine_unavailable - processing_failed - discovery_unavailable - nothing_to_quote - internal_error - quote_not_found - group_not_found - quote_expired - quote_mismatch - quote_unverified - expected_total_mismatch - request_in_progress - account_suspended - account_closed - account_not_found - tier_unchanged description: >- Every code the API returns, and the HTTP status it comes with. `invalid_request`, `invalid_url` → 400. `unauthenticated` → 401. `payment_required` → 402. `job_not_found`, `quote_not_found`, `group_not_found`, `api_key_not_found`, `credit_lot_not_found` → 404. `idempotency_conflict`, `request_in_progress`, `job_not_completed`, `quote_expired`, `quote_mismatch`, `quote_unverified`, `expected_total_mismatch`, `account_suspended`, `account_closed`, `account_not_found`, `api_key_limit_reached`, `tier_unchanged` → 409. `source_not_supported`, `feed_dead`, `episode_not_found`, `show_not_found`, `unsafe_source`, `unsupported_codec`, `unsupported_language`, `duration_exceeded`, `size_exceeded`, `nothing_to_quote`, `credits_not_refundable` → 422. `content_blocked` → 451. `rate_limited`, `concurrency_limited` → 429. `internal_error`, `processing_failed` → 500. `discovery_unavailable`, `engine_unavailable` → 503. `processing_failed` also appears inside a failed job's `error` field rather than as a live status. Each code has a heading on the documentation site's errors page, which is what `doc_url` links to. RequestId: type: string pattern: ^req_[A-Za-z0-9-]+$ maxLength: 100 examples: ShowSearchPage: summary: Show search results, one of them music-led value: data: - show_id: sh_k4n7qzvw2mtxyabc title: The Vergecast feed_url: https://feeds.example.com/vergecast.xml itunes_id: 430333725 author: The Verge categories: - Technology - Tech News artwork_url: https://cdn.example.com/art/vergecast.jpg music_led: false music_led_basis: no music category is on the show - show_id: sh_q7zmxbv2ctkn4yaf title: Song Exploder feed_url: https://feeds.example.com/songexploder.xml itunes_id: null author: Hrishikesh Hirway categories: - Music - Music Commentary artwork_url: null music_led: true music_led_basis: the show is categorized Music, Music Commentary excluded: - title: An Unlisted Feed reason: no_feed_url detail: >- the discovery provider carried no feed URL for this show, so it cannot be selected next_cursor: null responses: BadRequestApiKey: description: >- Invalid request shape or an unrecognized pointer. Codes: `invalid_request`, `invalid_url`. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' content: application/json: schema: $ref: '#/components/schemas/Error' UnauthorizedApiKey: description: >- Code `unauthenticated` — the API key is missing, malformed, revoked, or does not exist. Every operation in this document is authenticated, so this is the most common error path a client will hit; it is declared on all of them rather than left implicit. The response never distinguishes "no such key" from "revoked key". Unlike every other API-key response it carries no `X-RateLimit-Limit`: that is a per-account figure, and an unauthenticated request has no resolved account to report one for. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/json: schema: $ref: '#/components/schemas/Error' TooManyRequestsApiKey: description: >- Codes `rate_limited` or `concurrency_limited`, from two different limits and two different places. `rate_limited` is the per-account request rate, refused at the edge before the operation runs: it carries `Retry-After` and no `X-RateLimit-Limit`, because nothing that knows the caller's tier has run yet. `concurrency_limited` is the cap on jobs open at once, refused by the operation itself: it carries `X-RateLimit-Limit` like every other answered response, and no `Retry-After`, because it clears when one of the account's own jobs finishes rather than after a fixed wait. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/Error' InternalErrorApiKey: description: >- Code `internal_error` — a failure on our side that no other code describes. The message is fixed text and says nothing about the cause; `request_id` is what identifies it in our logs. Retryable. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' content: application/json: schema: $ref: '#/components/schemas/Error' DiscoveryUnavailableApiKey: description: >- Code `discovery_unavailable` — the show directory (Podcast Index) could not be reached, refused the request, or answered something this API cannot read as a show list. Retryable; a directory outage is never answered with an empty list, because an empty list is a valid answer to "shows in this category" and a caller would believe it. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: apiKeyBearer: type: http scheme: bearer bearerFormat: hk_live_... or hk_test_... description: >- `Authorization: Bearer hk_live_...` for live keys or `Authorization: Bearer hk_test_...` for test-mode keys. `hk_test_` keys resolve real public catalog metadata but return deterministic committed fixtures, never call inference, and never mutate live credits. This is the *only* transport for the credential: the `x-api-key` alias once documented was removed in 0.2.0, because the edge authorizer reads `Authorization` as its single identity source and a request on any other header is refused before it is authenticated. Never accepted on a `dashboardJwt` operation, and there are no exceptions. `GET /v1/usage` and `GET /v1/limits` briefly declared both schemes (0.8.0); that was withdrawn in 0.8.1 because no deployed route could honor it — both operations are served by the control-plane API, whose authorizer verifies a Cognito token and refuses an `hk_live_` credential on shape, and the customer API does not route either path. An API-key holder reads its balance and reservation from `QuoteResponse`, which carries `balance_credits` and `reserved_credits` on every quote. Every operation in this document takes one scheme or the other and refuses the wrong one as `unauthenticated`. ````