poddub docs

edit_heading

Edit the heading

Renames the episode's title or its summary on the latest version; a call sends at least one of the two. While the script is in review any member who can see the episode can use it, and after approval only owners and admins can. It never touches the turns.

What the server says

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

Rename the episode's title or summary on the latest version. Send at least one of the two: a call with neither is refused. In review any member may; after approval, owners and admins only.

Input

FieldTypeRequiredWhat it takes
versionwhole numberyes1 or more
titletextno1 to 120 characters
summarytextno1 to 600 characters
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
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.
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.
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.
heading_edit_forbiddenAfter approval only owners and admins can rename an episode.
invalid_bodyWhat was sent breaks a rule the input table cannot show: a new text that would break the script, or a fallback for a step that is not the audio, or an engine the show does not offer.

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

On this page