# Get, Update, or Delete Podcast

PUT /api/v1/podcasts/{id}/
Content-Type: application/json

Retrieves, updates, or deletes a specific podcast.

Reference: https://docs.aisquare.studio/api-reference/ai-square-studio-api/podcasts/retrieve

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: AISquare Studio API
  version: 1.0.0
paths:
  /api/v1/podcasts/{id}/:
    put:
      operationId: update-1
      summary: Get, Update, or Delete Podcast
      description: Retrieves, updates, or deletes a specific podcast.
      tags:
        - subpackage_podcasts
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
        - name: pk
          in: path
          description: The ID of the podcast
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Podcast details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodcastDetail'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                description: Any type
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                description: Any type
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                description: Any type
        '404':
          description: Podcast not found
          content:
            application/json:
              schema:
                description: Any type
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PodcastUpdate'
components:
  schemas:
    VoiceTypeEnum:
      type: string
      enum:
        - interview
        - panel
        - educational
        - narrative
        - debate
      description: |-
        * `interview` - Interview
        * `panel` - Panel
        * `educational` - Educational
        * `narrative` - Narrative
        * `debate` - Debate
      title: VoiceTypeEnum
    BlankEnum:
      type: string
      enum:
        - ''
      title: BlankEnum
    NullEnum:
      description: Any type
      title: NullEnum
    PodcastUpdateVoiceType:
      oneOf:
        - $ref: '#/components/schemas/VoiceTypeEnum'
        - $ref: '#/components/schemas/BlankEnum'
        - $ref: '#/components/schemas/NullEnum'
      description: >-
        Voice preset to use for the podcast (interview, panel, educational,
        narrative, debate)


        * `interview` - Interview

        * `panel` - Panel

        * `educational` - Educational

        * `narrative` - Narrative

        * `debate` - Debate
      title: PodcastUpdateVoiceType
    LanguageEnum:
      type: string
      enum:
        - en
        - es
        - fr
        - de
        - it
        - pt
        - zh
        - ja
        - ko
        - ar
        - ru
        - hi
      description: |-
        * `en` - English
        * `es` - Spanish
        * `fr` - French
        * `de` - German
        * `it` - Italian
        * `pt` - Portuguese
        * `zh` - Chinese
        * `ja` - Japanese
        * `ko` - Korean
        * `ar` - Arabic
        * `ru` - Russian
        * `hi` - Hindi
      title: LanguageEnum
    PodcastUpdateLanguage:
      oneOf:
        - $ref: '#/components/schemas/LanguageEnum'
        - $ref: '#/components/schemas/NullEnum'
      title: PodcastUpdateLanguage
    KnowledgeLevelEnum:
      type: string
      enum:
        - beginner
        - intermediate
        - advanced
        - expert
      description: |-
        * `beginner` - Beginner
        * `intermediate` - Intermediate
        * `advanced` - Advanced
        * `expert` - Expert
      title: KnowledgeLevelEnum
    GlobalVisibilityEnum:
      type: string
      enum:
        - public
        - private
        - team
        - org
      description: |-
        * `public` - Public
        * `private` - Private
        * `team` - Team
        * `org` - Organization
      title: GlobalVisibilityEnum
    PodcastUpdate:
      type: object
      properties:
        title:
          type: string
        description:
          type: string
        voice_type:
          oneOf:
            - $ref: '#/components/schemas/PodcastUpdateVoiceType'
            - type: 'null'
          description: >-
            Voice preset to use for the podcast (interview, panel, educational,
            narrative, debate)


            * `interview` - Interview

            * `panel` - Panel

            * `educational` - Educational

            * `narrative` - Narrative

            * `debate` - Debate
        language:
          oneOf:
            - $ref: '#/components/schemas/PodcastUpdateLanguage'
            - type: 'null'
        length:
          type:
            - integer
            - 'null'
        knowledge_level:
          $ref: '#/components/schemas/KnowledgeLevelEnum'
        llm_prompt:
          type: string
        focus_area:
          type:
            - string
            - 'null'
        visibility:
          $ref: '#/components/schemas/GlobalVisibilityEnum'
        is_draft:
          type: boolean
          description: Whether this podcast is a draft
        logo:
          type:
            - string
            - 'null'
          format: uri
        cover_image:
          type:
            - string
            - 'null'
          format: uri
      description: Serializer for updating podcasts.
      title: PodcastUpdate
    PodcastDetailLanguage:
      oneOf:
        - $ref: '#/components/schemas/LanguageEnum'
        - $ref: '#/components/schemas/BlankEnum'
        - $ref: '#/components/schemas/NullEnum'
      description: |-
        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
      title: PodcastDetailLanguage
    GenerationStatusEnum:
      type: string
      enum:
        - not_started
        - generating_script
        - script_generated
        - generating_audio
        - completed
        - failed
      description: |-
        * `not_started` - Not Started
        * `generating_script` - Generating Script
        * `script_generated` - Script Generated
        * `generating_audio` - Generating Audio
        * `completed` - Completed
        * `failed` - Failed
      title: GenerationStatusEnum
    GlobalCreationStatusEnum:
      type: string
      enum:
        - not_started
        - in_progress
        - completed
        - failed
      description: |-
        * `not_started` - Not Started
        * `in_progress` - In Progress
        * `completed` - Completed
        * `failed` - Failed
      title: GlobalCreationStatusEnum
    SimpleUser:
      type: object
      properties:
        id:
          type: integer
        email:
          type: string
          format: email
        full_name:
          type: string
        username:
          type: string
          description: >-
            Required. 150 characters or fewer. Letters, digits and @/./+/-/_
            only.
        is_verified:
          type: boolean
        profile_picture:
          type: string
          format: uri
          description: |-
            Convert ImageFieldFile to URL string for JSON serialization.

            Args:
                obj: The model instance being serialized (typically IAMUser)

            Returns:
                str | None: The URL of the profile picture, or None if not available
      required:
        - id
        - email
        - full_name
        - username
        - is_verified
        - profile_picture
      description: >-
        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)
      title: SimpleUser
    PodcastDetail:
      type: object
      properties:
        id:
          type: integer
        uid:
          type: string
          format: uuid
        title:
          type: string
        description:
          type:
            - string
            - 'null'
        voice_type:
          type:
            - string
            - 'null'
          description: Voice type from Hume AI (voice ID or clone settings)
        language:
          oneOf:
            - $ref: '#/components/schemas/PodcastDetailLanguage'
            - type: 'null'
          description: |-
            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
        length:
          type:
            - integer
            - 'null'
          description: Target podcast length in minutes
        knowledge_level:
          $ref: '#/components/schemas/KnowledgeLevelEnum'
          description: |-
            Target knowledge level for the podcast audience

            * `beginner` - Beginner
            * `intermediate` - Intermediate
            * `advanced` - Advanced
            * `expert` - Expert
        llm_prompt:
          type:
            - string
            - 'null'
          description: Optional custom prompt for the podcast script generation LLM
        logo:
          type:
            - string
            - 'null'
          format: uri
          description: Logo image for the podcast (copied from experience)
        generated_script:
          type:
            - string
            - 'null'
          description: LLM-generated podcast script
        audio_file:
          type:
            - string
            - 'null'
          format: uri
          description: Generated podcast audio file
        audio_url:
          type:
            - string
            - 'null'
          format: uri
          description: URL to the generated podcast audio
        generation_status:
          $ref: '#/components/schemas/GenerationStatusEnum'
          description: |-
            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_duration:
          type:
            - integer
            - 'null'
          description: Estimated duration of the podcast in seconds
        actual_duration:
          type:
            - integer
            - 'null'
          description: Actual duration of the generated podcast in seconds
        cover_image:
          type:
            - string
            - 'null'
          format: uri
          description: Cover image for the podcast
        focus_area:
          type:
            - string
            - 'null'
        visibility:
          $ref: '#/components/schemas/GlobalVisibilityEnum'
        is_draft:
          type: boolean
          description: Whether this podcast is a draft
        creation_status:
          $ref: '#/components/schemas/GlobalCreationStatusEnum'
        generation_metadata:
          oneOf:
            - description: Any type
            - type: 'null'
          description: Metadata about the generation process (model used, parameters, etc.)
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        duration_display:
          type: string
        can_generate_script:
          type: string
        can_generate_audio:
          type: string
        category_name:
          type: string
        subcategory_name:
          type: string
        tag_names:
          type: array
          items:
            type: string
        owner:
          $ref: '#/components/schemas/SimpleUser'
        owner_username:
          type: string
        publications:
          type: string
        source_experience_uid:
          type: string
        source_experience_title:
          type: string
        rag_document_count:
          type: string
        rag_documents:
          type: string
        metrics:
          type: string
        workspace_id:
          type: integer
      required:
        - id
        - uid
        - title
        - created_at
        - updated_at
        - duration_display
        - can_generate_script
        - can_generate_audio
        - category_name
        - subcategory_name
        - tag_names
        - owner
        - owner_username
        - publications
        - source_experience_uid
        - source_experience_title
        - rag_document_count
        - rag_documents
        - metrics
        - workspace_id
      description: Detailed serializer for podcast responses.
      title: PodcastDetail

```

## SDK Code Examples

```python
import requests

url = "https://api.example.com/api/v1/podcasts/1/"

payload = {}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/api/v1/podcasts/1/';
const options = {method: 'PUT', headers: {'Content-Type': 'application/json'}, body: '{}'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/podcasts/1/"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/podcasts/1/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.example.com/api/v1/podcasts/1/")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.example.com/api/v1/podcasts/1/', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/api/v1/podcasts/1/");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/api/v1/podcasts/1/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

```python
import requests

url = "https://api.example.com/api/v1/podcasts/1/"

payload = {}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/api/v1/podcasts/1/';
const options = {method: 'PUT', headers: {'Content-Type': 'application/json'}, body: '{}'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/podcasts/1/"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/podcasts/1/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.example.com/api/v1/podcasts/1/")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.example.com/api/v1/podcasts/1/', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/api/v1/podcasts/1/");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/api/v1/podcasts/1/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```