Import a script as a new episode

Generates a new episode from finished script text, asynchronously. Poll its status for progress.

POST/v1/episodes/import

Authorization

AuthorizationBearer token · headerrequired

API key issued from /settings/api-keys in the Jellypod studio. Send as Authorization: Bearer <key>.

Header parameters

idempotency-keystring

Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request.

min length 1 · max length 255 · matches ^[\x21-\x7e]+$

Request body

requiredapplication/json

podcast_idstring<uuid>required

Podcast that will own the imported generated episode.

outputsstring[]

Files to produce: audio (MP3), video (MP4 with sound), both, or [] for an editable draft. Each requested file becomes downloadable independently. Do not combine with render. Omission preserves legacy render behavior.

max items 2

renderbooleandeprecated

Deprecated: use outputs. True produces audio and video; false or omission leaves an editable draft. Do not combine with outputs.

scriptstringrequired

Script or transcript text. Bracketed speaker labels match saved Characters unless speaker_characters explicitly assigns their Character IDs.

min length 1 · max length 75000

speaker_charactersobject[]

Optional explicit assignments for a finished script: label as written in [brackets], and character_id from list_characters. Assignments override name matching; unmapped labels still match saved Character names.

min items 1 · max items 200

Show properties

Array of object

character_idstringrequired

min length 1

labelstringrequired

min length 1 · max length 200

Responses

202

Imported episode queued for generation

dataobjectrequired

Show properties

created_atstringrequired

host_idsstring[]required

idstringrequired

podcast_idstringrequired

statusstringrequired

Allowed:generating

updated_atstringrequired

workflow_run_idstringrequired

400

Validation failed or malformed request.

detailstring

Longer human-readable explanation when available.

errorsobject[]

Per-field validation failures. Present when type is validation_error.

Show properties

Array of object

fieldstringrequired

messagestringrequired

reasonstring

Script import failure when one or more Speakers have no saved Character match.

Allowed:unresolved_speakers

recoveryobject

Show properties

actionstringrequired

Allowed:correct_inputchoose_characterscheck_accountpoll_contentopen_studiocheck_contentreconnectretrycheck_result

idempotency_keystring

Allowed:reusenew

poll_after_secondsnumber

min 0

toolstring

Allowed:list_characterslist_contentget_contentsave_podcast

request_idstring

Correlation id, also returned in the X-Request-Id response header. Include in support requests.

speakersstring[]

Speaker labels needing a saved Character match when reason is unresolved_speakers.

statusintegerrequired

HTTP status code mirrored from the response.

titlestringrequired

Short human-readable summary.

typestringrequired

Machine-readable error class. Suitable for switch/match in client code.

Allowed:bad_requestvalidation_errorunauthorizedforbiddennot_foundconflictmethod_not_allowedunsupported_media_typeunprocessable_entityrate_limitedbad_gatewayinternal_error

401

Missing or invalid API key.

detailstring

Longer human-readable explanation when available.

errorsobject[]

Per-field validation failures. Present when type is validation_error.

Show properties

Array of object

fieldstringrequired

messagestringrequired

reasonstring

Script import failure when one or more Speakers have no saved Character match.

Allowed:unresolved_speakers

recoveryobject

Show properties

actionstringrequired

Allowed:correct_inputchoose_characterscheck_accountpoll_contentopen_studiocheck_contentreconnectretrycheck_result

idempotency_keystring

Allowed:reusenew

poll_after_secondsnumber

min 0

toolstring

Allowed:list_characterslist_contentget_contentsave_podcast

request_idstring

Correlation id, also returned in the X-Request-Id response header. Include in support requests.

speakersstring[]

Speaker labels needing a saved Character match when reason is unresolved_speakers.

statusintegerrequired

HTTP status code mirrored from the response.

titlestringrequired

Short human-readable summary.

typestringrequired

Machine-readable error class. Suitable for switch/match in client code.

Allowed:bad_requestvalidation_errorunauthorizedforbiddennot_foundconflictmethod_not_allowedunsupported_media_typeunprocessable_entityrate_limitedbad_gatewayinternal_error

403

Authenticated, but this API key does not have access to this resource.

detailstring

Longer human-readable explanation when available.

errorsobject[]

Per-field validation failures. Present when type is validation_error.

Show properties

Array of object

fieldstringrequired

messagestringrequired

reasonstring

Script import failure when one or more Speakers have no saved Character match.

Allowed:unresolved_speakers

recoveryobject

Show properties

actionstringrequired

Allowed:correct_inputchoose_characterscheck_accountpoll_contentopen_studiocheck_contentreconnectretrycheck_result

idempotency_keystring

Allowed:reusenew

poll_after_secondsnumber

min 0

toolstring

Allowed:list_characterslist_contentget_contentsave_podcast

request_idstring

Correlation id, also returned in the X-Request-Id response header. Include in support requests.

speakersstring[]

Speaker labels needing a saved Character match when reason is unresolved_speakers.

statusintegerrequired

HTTP status code mirrored from the response.

titlestringrequired

Short human-readable summary.

typestringrequired

Machine-readable error class. Suitable for switch/match in client code.

Allowed:bad_requestvalidation_errorunauthorizedforbiddennot_foundconflictmethod_not_allowedunsupported_media_typeunprocessable_entityrate_limitedbad_gatewayinternal_error

404

Resource not found.

detailstring

Longer human-readable explanation when available.

errorsobject[]

Per-field validation failures. Present when type is validation_error.

Show properties

Array of object

fieldstringrequired

messagestringrequired

reasonstring

Script import failure when one or more Speakers have no saved Character match.

Allowed:unresolved_speakers

recoveryobject

Show properties

actionstringrequired

Allowed:correct_inputchoose_characterscheck_accountpoll_contentopen_studiocheck_contentreconnectretrycheck_result

idempotency_keystring

Allowed:reusenew

poll_after_secondsnumber

min 0

toolstring

Allowed:list_characterslist_contentget_contentsave_podcast

request_idstring

Correlation id, also returned in the X-Request-Id response header. Include in support requests.

speakersstring[]

Speaker labels needing a saved Character match when reason is unresolved_speakers.

statusintegerrequired

HTTP status code mirrored from the response.

titlestringrequired

Short human-readable summary.

typestringrequired

Machine-readable error class. Suitable for switch/match in client code.

Allowed:bad_requestvalidation_errorunauthorizedforbiddennot_foundconflictmethod_not_allowedunsupported_media_typeunprocessable_entityrate_limitedbad_gatewayinternal_error

415

Request Content-Type is not supported for this endpoint.

detailstring

Longer human-readable explanation when available.

errorsobject[]

Per-field validation failures. Present when type is validation_error.

Show properties

Array of object

fieldstringrequired

messagestringrequired

reasonstring

Script import failure when one or more Speakers have no saved Character match.

Allowed:unresolved_speakers

recoveryobject

Show properties

actionstringrequired

Allowed:correct_inputchoose_characterscheck_accountpoll_contentopen_studiocheck_contentreconnectretrycheck_result

idempotency_keystring

Allowed:reusenew

poll_after_secondsnumber

min 0

toolstring

Allowed:list_characterslist_contentget_contentsave_podcast

request_idstring

Correlation id, also returned in the X-Request-Id response header. Include in support requests.

speakersstring[]

Speaker labels needing a saved Character match when reason is unresolved_speakers.

statusintegerrequired

HTTP status code mirrored from the response.

titlestringrequired

Short human-readable summary.

typestringrequired

Machine-readable error class. Suitable for switch/match in client code.

Allowed:bad_requestvalidation_errorunauthorizedforbiddennot_foundconflictmethod_not_allowedunsupported_media_typeunprocessable_entityrate_limitedbad_gatewayinternal_error

422

Request was well-formed but the resource is in a state that does not allow this operation (e.g. publishing an episode that has not finished rendering).

detailstring

Longer human-readable explanation when available.

errorsobject[]

Per-field validation failures. Present when type is validation_error.

Show properties

Array of object

fieldstringrequired

messagestringrequired

reasonstring

Script import failure when one or more Speakers have no saved Character match.

Allowed:unresolved_speakers

recoveryobject

Show properties

actionstringrequired

Allowed:correct_inputchoose_characterscheck_accountpoll_contentopen_studiocheck_contentreconnectretrycheck_result

idempotency_keystring

Allowed:reusenew

poll_after_secondsnumber

min 0

toolstring

Allowed:list_characterslist_contentget_contentsave_podcast

request_idstring

Correlation id, also returned in the X-Request-Id response header. Include in support requests.

speakersstring[]

Speaker labels needing a saved Character match when reason is unresolved_speakers.

statusintegerrequired

HTTP status code mirrored from the response.

titlestringrequired

Short human-readable summary.

typestringrequired

Machine-readable error class. Suitable for switch/match in client code.

Allowed:bad_requestvalidation_errorunauthorizedforbiddennot_foundconflictmethod_not_allowedunsupported_media_typeunprocessable_entityrate_limitedbad_gatewayinternal_error

429

Rate limit exceeded. Wait Retry-After seconds before retrying; RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset describe the window.

detailstring

Longer human-readable explanation when available.

errorsobject[]

Per-field validation failures. Present when type is validation_error.

Show properties

Array of object

fieldstringrequired

messagestringrequired

reasonstring

Script import failure when one or more Speakers have no saved Character match.

Allowed:unresolved_speakers

recoveryobject

Show properties

actionstringrequired

Allowed:correct_inputchoose_characterscheck_accountpoll_contentopen_studiocheck_contentreconnectretrycheck_result

idempotency_keystring

Allowed:reusenew

poll_after_secondsnumber

min 0

toolstring

Allowed:list_characterslist_contentget_contentsave_podcast

request_idstring

Correlation id, also returned in the X-Request-Id response header. Include in support requests.

speakersstring[]

Speaker labels needing a saved Character match when reason is unresolved_speakers.

statusintegerrequired

HTTP status code mirrored from the response.

titlestringrequired

Short human-readable summary.

typestringrequired

Machine-readable error class. Suitable for switch/match in client code.

Allowed:bad_requestvalidation_errorunauthorizedforbiddennot_foundconflictmethod_not_allowedunsupported_media_typeunprocessable_entityrate_limitedbad_gatewayinternal_error

500

Internal server error.

detailstring

Longer human-readable explanation when available.

errorsobject[]

Per-field validation failures. Present when type is validation_error.

Show properties

Array of object

fieldstringrequired

messagestringrequired

reasonstring

Script import failure when one or more Speakers have no saved Character match.

Allowed:unresolved_speakers

recoveryobject

Show properties

actionstringrequired

Allowed:correct_inputchoose_characterscheck_accountpoll_contentopen_studiocheck_contentreconnectretrycheck_result

idempotency_keystring

Allowed:reusenew

poll_after_secondsnumber

min 0

toolstring

Allowed:list_characterslist_contentget_contentsave_podcast

request_idstring

Correlation id, also returned in the X-Request-Id response header. Include in support requests.

speakersstring[]

Speaker labels needing a saved Character match when reason is unresolved_speakers.

statusintegerrequired

HTTP status code mirrored from the response.

titlestringrequired

Short human-readable summary.

typestringrequired

Machine-readable error class. Suitable for switch/match in client code.

Allowed:bad_requestvalidation_errorunauthorizedforbiddennot_foundconflictmethod_not_allowedunsupported_media_typeunprocessable_entityrate_limitedbad_gatewayinternal_error

502

The API could not enqueue the downstream asynchronous workflow.

detailstring

Longer human-readable explanation when available.

errorsobject[]

Per-field validation failures. Present when type is validation_error.

Show properties

Array of object

fieldstringrequired

messagestringrequired

reasonstring

Script import failure when one or more Speakers have no saved Character match.

Allowed:unresolved_speakers

recoveryobject

Show properties

actionstringrequired

Allowed:correct_inputchoose_characterscheck_accountpoll_contentopen_studiocheck_contentreconnectretrycheck_result

idempotency_keystring

Allowed:reusenew

poll_after_secondsnumber

min 0

toolstring

Allowed:list_characterslist_contentget_contentsave_podcast

request_idstring

Correlation id, also returned in the X-Request-Id response header. Include in support requests.

speakersstring[]

Speaker labels needing a saved Character match when reason is unresolved_speakers.

statusintegerrequired

HTTP status code mirrored from the response.

titlestringrequired

Short human-readable summary.

typestringrequired

Machine-readable error class. Suitable for switch/match in client code.

Allowed:bad_requestvalidation_errorunauthorizedforbiddennot_foundconflictmethod_not_allowedunsupported_media_typeunprocessable_entityrate_limitedbad_gatewayinternal_error

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

idempotency-keyheaderOptional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request.

Bodyapplication/json

Request body

Request

curl -X POST 'https://api.jellypod.com/v1/episodes/import' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "podcast_id": "4c1cb0f8-818b-4f7a-9ddb-0d1ea990b35a",
  "outputs": [
    "audio"
  ],
  "render": true,
  "script": "[Host One]\nWelcome to the show. Today we are talking about one small habit that can make the week easier.\n\n[Host Two]\nI like that. Let us start with something simple someone can try tomorrow morning.",
  "speaker_characters": [
    {
      "character_id": "string",
      "label": "string"
    }
  ]
}'

const response = await fetch("https://api.jellypod.com/v1/episodes/import", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"podcast_id\": \"4c1cb0f8-818b-4f7a-9ddb-0d1ea990b35a\",\n  \"outputs\": [\n    \"audio\"\n  ],\n  \"render\": true,\n  \"script\": \"[Host One]\\nWelcome to the show. Today we are talking about one small habit that can make the week easier.\\n\\n[Host Two]\\nI like that. Let us start with something simple someone can try tomorrow morning.\",\n  \"speaker_characters\": [\n    {\n      \"character_id\": \"string\",\n      \"label\": \"string\"\n    }\n  ]\n}"
});

import requests

response = requests.post(
    "https://api.jellypod.com/v1/episodes/import",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"podcast_id\": \"4c1cb0f8-818b-4f7a-9ddb-0d1ea990b35a\",\n  \"outputs\": [\n    \"audio\"\n  ],\n  \"render\": true,\n  \"script\": \"[Host One]\\nWelcome to the show. Today we are talking about one small habit that can make the week easier.\\n\\n[Host Two]\\nI like that. Let us start with something simple someone can try tomorrow morning.\",\n  \"speaker_characters\": [\n    {\n      \"character_id\": \"string\",\n      \"label\": \"string\"\n    }\n  ]\n}",
)

Response

{
  "data": {
    "created_at": "string",
    "host_ids": [
      "string"
    ],
    "id": "string",
    "podcast_id": "string",
    "status": "generating",
    "updated_at": "string",
    "workflow_run_id": "string"
  }
}

{
  "detail": "string",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "reason": "unresolved_speakers",
  "recovery": {
    "action": "correct_input",
    "idempotency_key": "reuse",
    "poll_after_seconds": 0,
    "tool": "list_characters"
  },
  "request_id": "string",
  "speakers": [
    "string"
  ],
  "status": 0,
  "title": "string",
  "type": "bad_request"
}

{
  "detail": "string",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "reason": "unresolved_speakers",
  "recovery": {
    "action": "correct_input",
    "idempotency_key": "reuse",
    "poll_after_seconds": 0,
    "tool": "list_characters"
  },
  "request_id": "string",
  "speakers": [
    "string"
  ],
  "status": 0,
  "title": "string",
  "type": "bad_request"
}

{
  "detail": "string",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "reason": "unresolved_speakers",
  "recovery": {
    "action": "correct_input",
    "idempotency_key": "reuse",
    "poll_after_seconds": 0,
    "tool": "list_characters"
  },
  "request_id": "string",
  "speakers": [
    "string"
  ],
  "status": 0,
  "title": "string",
  "type": "bad_request"
}

{
  "detail": "string",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "reason": "unresolved_speakers",
  "recovery": {
    "action": "correct_input",
    "idempotency_key": "reuse",
    "poll_after_seconds": 0,
    "tool": "list_characters"
  },
  "request_id": "string",
  "speakers": [
    "string"
  ],
  "status": 0,
  "title": "string",
  "type": "bad_request"
}

{
  "detail": "string",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "reason": "unresolved_speakers",
  "recovery": {
    "action": "correct_input",
    "idempotency_key": "reuse",
    "poll_after_seconds": 0,
    "tool": "list_characters"
  },
  "request_id": "string",
  "speakers": [
    "string"
  ],
  "status": 0,
  "title": "string",
  "type": "bad_request"
}

{
  "detail": "string",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "reason": "unresolved_speakers",
  "recovery": {
    "action": "correct_input",
    "idempotency_key": "reuse",
    "poll_after_seconds": 0,
    "tool": "list_characters"
  },
  "request_id": "string",
  "speakers": [
    "string"
  ],
  "status": 0,
  "title": "string",
  "type": "bad_request"
}

{
  "detail": "string",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "reason": "unresolved_speakers",
  "recovery": {
    "action": "correct_input",
    "idempotency_key": "reuse",
    "poll_after_seconds": 0,
    "tool": "list_characters"
  },
  "request_id": "string",
  "speakers": [
    "string"
  ],
  "status": 0,
  "title": "string",
  "type": "bad_request"
}

{
  "detail": "string",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "reason": "unresolved_speakers",
  "recovery": {
    "action": "correct_input",
    "idempotency_key": "reuse",
    "poll_after_seconds": 0,
    "tool": "list_characters"
  },
  "request_id": "string",
  "speakers": [
    "string"
  ],
  "status": 0,
  "title": "string",
  "type": "bad_request"
}

{
  "detail": "string",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "reason": "unresolved_speakers",
  "recovery": {
    "action": "correct_input",
    "idempotency_key": "reuse",
    "poll_after_seconds": 0,
    "tool": "list_characters"
  },
  "request_id": "string",
  "speakers": [
    "string"
  ],
  "status": 0,
  "title": "string",
  "type": "bad_request"
}