poddub docs

approve_episode

Approve an episode

Approves the script under review: the version is frozen, the organization's minutes are spent and poddub starts making the audio. It works only where an owner has allowed agents to approve in the organization, which stays off until they turn it on; until then it is refused, and the person approves in the app. It never approves a version other than the latest, and never one that is no longer in review.

What the server says

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

Approve the version under review: it freezes that version, spends the episode's minutes and starts rendering, so read the script first and name the version you read. Only where an owner has allowed agents to approve in this organization; otherwise refused with agent_approval_disabled, and a person approves in the app's review screen. Refused with script_version_conflict (with the latest version) when version is not the latest, minutes_exhausted when the allowance is spent, and generation_paused while poddub's operator has paused generation (nothing is charged; try again later).

Input

FieldTypeRequiredWhat it takes
versionwhole numberyes1 or more
episodeIdtextyesnot empty; The episode's id, as list_episodes or create_episode answers it.

Refusals

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

CodeWhat it means
agent_approval_disabledThe organization's owner has not allowed agents to approve. The person approves in the app; the refusal names the episode.
episode_not_foundNo such episode among the ones the person can see.
script_not_foundThe episode has no script yet: poddub is still writing it.
script_version_conflictThe version named is not the latest, because the script changed since it was read. The refusal carries the latest version: read the script again.
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.
episode_state_conflictThe episode is not in a state that allows this: a script no longer in review, or a retry of an episode that has not failed. The refusal says the state it is in.
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.

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

On this page