Get, Update, or Delete Podcast

POST

https://host.com/api/v1/podcasts/:id/

POST

/api/v1/podcasts/:id/

$ curl -X POST /api/v1/podcasts/1/ \
>      -H "Content-Type: application/json" \
>      -d '{
>   "title": "The Future of Renewable Energy"
> }'

1 {
2   "id": 1,
3   "uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4   "title": "The Future of Renewable Energy",
5   "created_at": "2024-01-15T09:30:00Z",
6   "updated_at": "2024-01-20T14:45:00Z",
7   "duration_display": "44m 10s",
8   "can_generate_script": "yes",
9   "can_generate_audio": "yes",
10   "category_name": "Technology",
11   "subcategory_name": "Renewable Energy",
12   "tag_names": [
13     "energy",
14     "technology",
15     "environment"
16   ],
17   "owner": {
18     "id": 42,
19     "email": "jane.doe@example.com",
20     "full_name": "Jane Doe",
21     "username": "janedoe",
22     "is_verified": true,
23     "profile_picture": "https://example.com/profiles/janedoe.jpg"
24   },
25   "owner_username": "janedoe",
26   "publications": "Tech Insights Weekly",
27   "source_experience_uid": "exp-987654321",
28   "source_experience_title": "Renewable Energy Series",
29   "rag_document_count": "5",
30   "rag_documents": "doc1, doc2, doc3, doc4, doc5",
31   "metrics": "plays:1500, likes:300, shares:120",
32   "workspace_id": 7,
33   "description": "An in-depth discussion on the advancements and challenges in renewable energy technologies.",
34   "voice_type": "hume-voice-1234",
35   "language": "en",
36   "length": 45,
37   "knowledge_level": "intermediate",
38   "llm_prompt": "Generate a detailed podcast script about renewable energy innovations.",
39   "logo": "https://example.com/images/podcast-logo.png",
40   "generated_script": "Welcome to our podcast on renewable energy...",
41   "audio_file": "https://example.com/audio/future-renewable-energy.mp3",
42   "audio_url": "https://cdn.example.com/podcasts/future-renewable-energy.mp3",
43   "generation_status": "completed",
44   "estimated_duration": 2700,
45   "actual_duration": 2650,
46   "cover_image": "https://example.com/images/podcast-cover.jpg",
47   "focus_area": "Energy and Environment",
48   "visibility": "public",
49   "is_draft": false,
50   "creation_status": "completed"
51 }

Retrieves, updates, or deletes a specific podcast.

Path parameters

idintegerRequired

pkintegerRequired

The ID of the podcast

Request

This endpoint expects an object.

titlestringRequired<=255 characters

ownerobjectRequired

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)

descriptionstring or nullOptional

voice_typestring or nullOptional<=100 characters

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

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 nullOptional-2147483648-2147483647

Target podcast length in minutes

knowledge_levelenumOptional

Target knowledge level for the podcast audience

beginner - Beginner
intermediate - Intermediate
advanced - Advanced
expert - Expert

Allowed values:

llm_promptstring or nullOptional

Optional custom prompt for the podcast script generation LLM

logostring or nullOptionalformat: "uri"

Logo image for the podcast (copied from experience)

generated_scriptstring or nullOptional

LLM-generated podcast script

audio_filestring or nullOptionalformat: "uri"

Generated podcast audio file

audio_urlstring or nullOptionalformat: "uri"<=200 characters

URL to the generated podcast audio

generation_statusenumOptional

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 nullOptional-2147483648-2147483647

Estimated duration of the podcast in seconds

actual_durationinteger or nullOptional-2147483648-2147483647

Actual duration of the generated podcast in seconds

cover_imagestring or nullOptionalformat: "uri"

Cover image for the podcast

focus_areastring or nullOptional<=256 characters

visibilityenumOptional

public - Public
private - Private
team - Team
org - Organization

Allowed values:

is_draftbooleanOptional

Whether this podcast is a draft

creation_statusenumOptional

not_started - Not Started
in_progress - In Progress
completed - Completed
failed - Failed

Allowed values:

generation_metadataany or nullOptional

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

Response

Podcast details

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

logostring or nullformat: "uri"

Logo image for the podcast (copied from experience)

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

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error