podcasts

Create Podcast

View as Markdown

Create a new podcast with optional file uploads for RAG documents. Supports multipart/form-data for file uploads. When creating a podcast, the script will be automatically generated for preview.

Request

This endpoint expects a multipart form.
titlestringRequired<=255 characters
descriptionstringOptional
voice_typeenum or any or nullOptional
Voice preset to use for the podcast (interview, panel, educational, narrative, debate) * `interview` - Interview * `panel` - Panel * `educational` - Educational * `narrative` - Narrative * `debate` - Debate
languageenum or any or nullOptional
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 nullOptional1-180
knowledge_levelenumOptional
* `beginner` - Beginner * `intermediate` - Intermediate * `advanced` - Advanced * `expert` - Expert
Allowed values:
llm_promptstringOptional
cover_imagestring or nullOptionalformat: "uri"
categorystringOptional
subcategorystringOptional
focus_areastringOptional
tagslist of stringsOptional
rag_fileslist of stringsOptional
List of files to upload as RAG documents for podcast content
existing_rag_document_idslist of integersOptional
List of existing RAG document IDs to link to this podcast
visibilityenumOptional
* `public` - Public * `private` - Private * `team` - Team * `org` - Organization
Allowed values:
is_draftbooleanOptional
Whether this podcast is a draft
workspace_idintegerRequired

Response

Podcast created successfully
idintegerRead-only
uidstringRead-onlyformat: "uuid"
titlestring<=255 characters
created_atdatetimeRead-only
updated_atdatetimeRead-only
duration_displaystringRead-only
can_generate_scriptstringRead-only
can_generate_audiostringRead-only
category_namestringRead-only
subcategory_namestringRead-only
tag_nameslist of stringsRead-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
source_experience_uidstringRead-only
source_experience_titlestringRead-only
rag_document_countstringRead-only
rag_documentsstringRead-only
metricsstringRead-only
workspace_idintegerRead-only
descriptionstring or null
voice_typestring or null<=100 characters

Voice type from Hume AI (voice ID or clone settings)

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:
llm_promptstring or null
Optional custom prompt for the podcast script generation LLM
generated_scriptstring or null

LLM-generated podcast script

audio_filestring or nullformat: "uri"
Generated podcast audio file
audio_urlstring or nullformat: "uri"<=200 characters
URL to the generated podcast audio
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
estimated_durationinteger or null-2147483648-2147483647
Estimated duration of the podcast in seconds
actual_durationinteger or null-2147483648-2147483647
Actual duration of the generated podcast in seconds
cover_imagestring or nullformat: "uri"
Cover image for the podcast
focus_areastring or null<=256 characters
visibilityenum
  • public - Public
  • private - Private
  • team - Team
  • org - Organization
Allowed values:
is_draftboolean
Whether this podcast is a draft
creation_statusenum
  • not_started - Not Started
  • in_progress - In Progress
  • completed - Completed
  • failed - Failed
Allowed values:
generation_metadataany or null

Metadata about the generation process (model used, parameters, etc.)

Errors

400
Bad Request Error