Audio
Richie Audio API Endpoints
Descriptions of endpoints for audio metadata
GET /books/feeds/v3/{tenant_name}/podcast_episode/{episode_uuid}.json
Get metadata of a podcast episode. Does not need authentication.
Example response
Schema of "data"
"data"
follows the schema for a podcast episode, with some article compatibility fields left empty.
Property | Description | Value |
---|---|---|
kind | Kind (type) of the resource. | "podcast_episode" |
source_type | Origin of the episode. | "rss", "manual" or "article" |
guid | Identifier of the episode. | UUID |
series_title | Title of the series episode belongs to. | String |
series_guid | Identifier of the series episode belongs to. | UUID |
author | Episode author. | String |
original_article_url | Original article URL. Empty for actual podcast episodes. | String |
title | Episode title. | String |
description | Episode description. | String |
publication_date | Episode's first publication date. | String (a date) |
last_modified | Last time the metadata was updated. | String (a date). |
cover_url | URL for a cover picture. | String (an HTTPS URL). |
photo_author | Author of the related photo. Empty for actual podcast episodes. | String |
square_cover_url | URL for a cover picture, guaranteed to be square. Empty for actual podcast episodes. | String (an HTTPS URL) or null. |
square_photo_author | URL for a cover picture, guaranteed to be square. Empty for actual podcast episodes. | String or null. |
audio_url | Playback URL for the main audio. | String (an HTTPS URL). |
audio_duration | Duration of audio in seconds. 0 and null mean duration is unknown. | Integer (incl. 0) or null. |
audio_length | Content length of audio file, in bytes. 0 means unknown length. | Integer (incl. 0). |
audio_sample | Details of a free sample version for audio. Not available for all episodes. | Object or null. |
audio_sample.audio_url | Playback URL for the sample version. | String (an HTTPS URL) if audio_sample is an object. |
audio_sample.audio_duration | Duration of audio in seconds. 0 and null mean duration is unknown. | Integer (incl. 0) or null if audio_sample is an object.. |
audio_sample.audio_length | Content length of audio file, in bytes. 0 means unknown length. | Integer (incl. 0) if audio_sample is an object.. |
audio_pkgs | Richie-managed alternative format audio packages. Details agreed with integrators. | Object, possibly empty. |
availability_periods | Time frames during which the episode is available in given products. | Array of objects (availability period objects). |
availability_periods[n].product | Product slug. | String or null. |
availability_periods[n].product | Type of the product (free or paid). | "free" or "paid". |
availability_periods[n].product | Start of episode's inclusion in the product. | String (a date). |
availability_periods[n].end_date | End of episode's inclusion in the product. | String (a date). |
rankings | Popularity rankings for the episode. | Object |
rankings.daily | Daily popularity for the episode, if applicable. Lower number means more popular. | Integer or null. |
rankings.weekly | Weekly popularity for the episode, if applicable. Lower number means more popular. | Integer or null. |
rankings.monthly | Monthly popularity for the episode, if applicable. Lower number means more popular. | Integer or null. |
series_tags | Tenant-specific values agreed with the tenant, for the series episode belongs to. | Array of strings. |
tags | Tenant-specific values agreed with the tenant, for the episode. | Array of strings. |
analytics_data | Tenant-specific data carried for analytics purposes. Actual fields agreed with the tenant. | Object or null. |
ad_tags | Tenant-specific data carried for ad purposes. Actual fields agreed with the tenant. | Object or null. |
h | Internal hash code over the payload, not always set. | String or null. |