Publish or schedule an episode

POST/v1/episodes/{episode_id}/publish

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

episode_idstring<uuid>required

Episode UUID

Request body

application/json

scheduled_timestring<date-time>

Responses

200

Episode published or scheduled

dataobjectrequired

Show properties

idstringrequired

scheduled_timestring

statusstringrequired

Allowed:publishedscheduled

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

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

episode_idpath*Episode UUID

Bodyapplication/json

scheduled_timestring

Request

curl -X POST 'https://api.jellypod.com/v1/episodes/497f6eca-6276-4993-bfeb-53cbbbba6f08/publish' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "scheduled_time": "2019-08-24T14:15:22Z"
}'

const response = await fetch("https://api.jellypod.com/v1/episodes/497f6eca-6276-4993-bfeb-53cbbbba6f08/publish", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"scheduled_time\": \"2019-08-24T14:15:22Z\"\n}"
});

import requests

response = requests.post(
    "https://api.jellypod.com/v1/episodes/497f6eca-6276-4993-bfeb-53cbbbba6f08/publish",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"scheduled_time\": \"2019-08-24T14:15:22Z\"\n}",
)

Response

{
  "data": {
    "id": "string",
    "scheduled_time": "string",
    "status": "published"
  }
}

{
  "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"
}