> ## 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. # Resolve a podcast pointer to canonical IDs without creating a job > Resolves an Apple Podcasts episode URL, or an RSS `feed_url` plus `guid`, to canonical `episode_id`/`show_id` without creating a job. Exactly one of `url` or (`feed_url` and `guid`) must be supplied; OpenAPI parameter schemas cannot express that cross-parameter rule, so a request supplying neither, both, or a partial pair is rejected at runtime with `400 invalid_request` (out of scope for this document per its "runtime request validation middleware" exclusion). Spotify, YouTube, and raw-audio inputs return `422 source_not_supported`. ## OpenAPI ````yaml /openapi.yaml get /v1/resolve 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/resolve: get: tags: - Catalog summary: Resolve a podcast pointer to canonical IDs without creating a job description: >- Resolves an Apple Podcasts episode URL, or an RSS `feed_url` plus `guid`, to canonical `episode_id`/`show_id` without creating a job. Exactly one of `url` or (`feed_url` and `guid`) must be supplied; OpenAPI parameter schemas cannot express that cross-parameter rule, so a request supplying neither, both, or a partial pair is rejected at runtime with `400 invalid_request` (out of scope for this document per its "runtime request validation middleware" exclusion). Spotify, YouTube, and raw-audio inputs return `422 source_not_supported`. operationId: resolvePointer parameters: - $ref: '#/components/parameters/ResolveUrlQueryParam' - $ref: '#/components/parameters/ResolveFeedUrlQueryParam' - $ref: '#/components/parameters/ResolveGuidQueryParam' responses: '200': description: Resolved canonical identity plus cache/quote hints. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' content: application/json: schema: $ref: '#/components/schemas/ResolveResult' examples: resolved: $ref: '#/components/examples/ResolveResultExample' '400': $ref: '#/components/responses/BadRequestApiKey' '401': $ref: '#/components/responses/UnauthorizedApiKey' '404': $ref: '#/components/responses/NotFoundApiKey' '422': $ref: '#/components/responses/UnprocessableApiKey' '429': $ref: '#/components/responses/TooManyRequestsApiKey' '500': $ref: '#/components/responses/InternalErrorApiKey' security: - apiKeyBearer: [] components: parameters: ResolveUrlQueryParam: name: url in: query required: false description: >- An Apple Podcasts episode URL. Mutually exclusive with `feed_url`/`guid`. schema: $ref: '#/components/schemas/PodcastUrl' ResolveFeedUrlQueryParam: name: feed_url in: query required: false description: An RSS feed URL. Requires `guid`. Mutually exclusive with `url`. schema: $ref: '#/components/schemas/FeedUrl' ResolveGuidQueryParam: name: guid in: query required: false description: An episode GUID from the feed named by `feed_url`. schema: $ref: '#/components/schemas/EpisodeGuid' 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: ResolveResult: type: object additionalProperties: false required: - episode_id - show_id - is_cached description: Resolves a pointer to canonical IDs without creating a job. properties: episode_id: $ref: '#/components/schemas/EpisodeId' show_id: $ref: '#/components/schemas/ShowId' is_cached: type: boolean estimated_credits: anyOf: - $ref: '#/components/schemas/CreditAmount' - enum: - null quote_basis: anyOf: - $ref: '#/components/schemas/QuoteBasis' - enum: - null estimated_seconds: description: >- Estimated wall-clock processing seconds, or `null` when the pointer resolved but nothing has been estimated yet (e.g. the episode is already cached, so no fresh work would be scheduled). anyOf: - $ref: '#/components/schemas/EstimatedProcessingSeconds' - enum: - null PodcastUrl: type: string format: uri minLength: 1 maxLength: 2048 description: An Apple Podcasts episode URL. FeedUrl: type: string format: uri minLength: 1 maxLength: 2048 description: An RSS/Atom feed URL. EpisodeGuid: type: string minLength: 1 maxLength: 512 description: >- An episode GUID as published in the feed's `` element. Used verbatim — GUIDs are case- and whitespace-significant. EpisodeId: type: string pattern: ^ep_[a-z2-7]{16}$ description: Canonical episode identifier. ShowId: type: string pattern: ^sh_[a-z2-7]{16}$ description: Canonical show identifier. CreditAmount: type: integer minimum: 0 maximum: 9007199254740991 description: >- A non-negative JavaScript-safe integer credit amount. The upper bound matches `Number.MAX_SAFE_INTEGER`, which is enforced by the domain ledger so arithmetic and JSON round-trips cannot silently lose cents worth of credit precision. QuoteBasis: type: string enum: - feed_metadata - probed description: >- `feed_metadata` when the estimate is derived from feed-published duration; `probed` when a bounded enclosure probe measured it. EstimatedProcessingSeconds: type: integer minimum: 0 maximum: 72000 description: >- Estimated **wall-clock** seconds until the job reaches a terminal state — intended for choosing a poll interval. This is *not* audio duration: audio duration has its own field (`duration_sec` on the transcript, `duration_sec` on `EpisodeSummary`), and conflating the two silently misprices everything a caller derives from it. The committed examples only make sense under this reading: `estimated_seconds: 420` alongside `estimated_credits: 268` cannot be audio seconds, because 7 audio minutes bills 7 credits at `CREDITS_PER_AUDIO_MINUTE`, while 268 credits is about 4.5 hours of audio. The bound is derived from that meaning rather than copied from the audio cap: twice the published 10-hour `max_audio_duration_seconds` ceiling, an end-to-end envelope that still holds at a pathological 1× realtime factor. The real hard per-job timeout is duration-scaled and much shorter. Error: type: object additionalProperties: false required: - error properties: error: $ref: '#/components/schemas/ErrorDetail' 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: ResolveResultExample: summary: Resolved canonical identity value: episode_id: ep_a3urk6fzq2mvbxyc show_id: sh_k4n7qzvw2mtxyabc is_cached: true estimated_credits: 1 quote_basis: null estimated_seconds: 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' NotFoundApiKey: description: >- Codes: `feed_dead`, `episode_not_found`, `show_not_found`, or `job_not_found` (the job does not exist or belongs to another account — cross-account access is indistinguishable from nonexistence). headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' content: application/json: schema: $ref: '#/components/schemas/Error' UnprocessableApiKey: description: >- The request was well-formed but cannot be fulfilled. Codes: `source_not_supported`, `feed_dead`, `episode_not_found`, `show_not_found`, `unsafe_source`, `unsupported_codec`, `unsupported_language`, `duration_exceeded`, `size_exceeded`. These carry three different `error.type` values, not two: `invalid_request` for `source_not_supported`/`unsafe_source` (fix your integration), `unprocessable_input` for `unsupported_codec`/`unsupported_language`/`duration_exceeded`/ `size_exceeded` (this episode is outside published launch support), and `not_found` for `feed_dead`/`episode_not_found`/`show_not_found` (resolution failed with a typed catalog reason — the same three codes `NotFoundApiKey` carries at 404 for operations where the same failure is a lookup miss instead of an unprocessable request). A client branching on `type` must handle all three, not assume every code documented here is one of two things. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' 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' 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`. ````