poddub docs

create_episode

Create an episode

Starts an episode from one or more sources of one team, with a format, a length and a language, and comes back at once while poddub writes the script. Any member can use it in their own team, once they have accepted the provider list in the app. It never skips that consent or the organization's allowance, and it never waits for the script: follow the episode with get_episode.

What the server says

The description an agent is given, word for word. This tool makes changes.

Start an episode from one or more sources of one team, each named once. It returns at once in scripting; call get_episode every 20 to 30 seconds until it is in review. Refused with consent_required until you have accepted the provider list in the app, with minutes_exhausted or attempts_exhausted when the allowance is spent, and with generation_paused while poddub's operator has paused generation (nothing is charged; try again later). language defaults to the show's.

Input

FieldTypeRequiredWhat it takes
teamIdtextyesnot empty
sourceIdslist of textyesat least 1
targetMinutesnumberyesone of 5, 10, 15
formattextyesone of dialogue, narrator
languagetextnomatches ^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$

Refusals

A refusal comes back as the tool's result, marked as an error, with the code and what explains it.

CodeWhat it means
consent_requiredThe key's person has not accepted the current list of providers poddub works with, or withdrew it. Only that person can accept it, in the app.
team_not_foundThe team is not one of the person's own teams.
team_archivedThe team is archived and takes no new work.
source_not_foundA source named is not one the person can see, is in another team, or was deleted.
source_not_usableA source cannot be made into an episode yet, such as an uploaded file that has not been processed.
generation_pausedpoddub's operator has paused generation for now. Nothing was counted or charged. Try again later; reading, editing by hand and publishing still work.
plan_requiredThe organization has no plan. An owner chooses one in the app.
minutes_exhaustedThe minutes left in this period are fewer than the episode needs. The refusal carries the allowance and when it resets.
attempts_exhaustedThe period's script generations are spent. The refusal carries the allowance and when it resets.
episode_sources_too_manyMore sources than the plan allows in one episode.
episode_sources_too_longMore text across the sources than the plan allows in one episode.

Every tool can also answer rate_limited and not_a_member: see Limits and Keys.

On this page