podcasts

List Podcasts by Publication URL

View as Markdown

This endpoint returns a paginated list of podcasts. For GET requests, it returns the base podcast list. For POST requests, if the JSON body contains a ‘url’ parameter (representing the publication’s custom URL), the view will filter the podcasts to return only those whose ‘owner’ matches the Publication owner’s user. If the ‘url’ parameter is omitted, the full list is returned.

Request

This endpoint expects an object.
urlstringOptional
The custom URL of the publication used to filter the podcasts.

Response

A paginated list of podcasts. If a 'url' is provided in the POST body, only podcasts created by the corresponding Publication owner are returned.
idintegerRead-only
uidstringRead-onlyformat: "uuid"
titlestring<=255 characters
created_atdatetimeRead-only
updated_atdatetimeRead-only
duration_displaystringRead-only
category_namestringRead-only
subcategory_namestringRead-only
ownerobject
Simple user serializer with profile picture from associated IAMUserDetail. Fields: - id, email, full_name, username, is_verified (from IAMUser) - profile_picture (from first related IAMUserDetail if present)
owner_usernamestringRead-only
publicationsstringRead-only
rag_document_countstringRead-only
metricsstringRead-only
workspace_idintegerRead-only
descriptionstring or null
languageenum or any or null
Language for the podcast content (for future use) * `en` - English * `es` - Spanish * `fr` - French * `de` - German * `it` - Italian * `pt` - Portuguese * `zh` - Chinese * `ja` - Japanese * `ko` - Korean * `ar` - Arabic * `ru` - Russian * `hi` - Hindi
lengthinteger or null-2147483648-2147483647
Target podcast length in minutes
knowledge_levelenum
Target knowledge level for the podcast audience * `beginner` - Beginner * `intermediate` - Intermediate * `advanced` - Advanced * `expert` - Expert
Allowed values:
generation_statusenum
Current status of podcast generation process * `not_started` - Not Started * `generating_script` - Generating Script * `script_generated` - Script Generated * `generating_audio` - Generating Audio * `completed` - Completed * `failed` - Failed
visibilityenum
* `public` - Public * `private` - Private * `team` - Team * `org` - Organization
Allowed values:
is_draftboolean
Whether this podcast is a draft
cover_imagestring or nullformat: "uri"
Cover image for the podcast

Errors

400
Bad Request Error
401
Unauthorized Error