Discover video creation options

GET/v1/videos/options

Authorization

AuthorizationBearer token · headerrequired

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

Responses

200

Creation options and saved defaults

dataobjectrequired

Show properties

default_duration_secondsnumber | nullrequired

default_languagestringrequired

default_orientationstringrequired

default_style_idstring | nullrequired

guidancestringrequired

objectstringrequired

Allowed:videoshortvoiceover

stylesobject[]required

Show properties

Array of object

descriptionstringrequired

idstringrequired

namestringrequired

supported_duration_secondsnumber[]required

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

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

Request

curl -X GET 'https://api.jellypod.com/v1/videos/options' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.jellypod.com/v1/videos/options", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.jellypod.com/v1/videos/options",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "data": {
    "default_duration_seconds": 0,
    "default_language": "string",
    "default_orientation": "string",
    "default_style_id": "string",
    "guidance": "string",
    "object": "video",
    "styles": [
      {
        "description": "string",
        "id": "string",
        "name": "string"
      }
    ],
    "supported_duration_seconds": [
      0
    ]
  }
}

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