Tools
What an agent can do through poddub, tool by tool.
Every tool does what a button in the app does, with the same rules: the same roles, the same allowance and the same refusals. An agent works as the person whose key it holds, and never as more than that key's role allows.
Approval is a person's. Approving spends the organization's minutes and starts the audio, so a person approves in the app. An owner can allow agents to approve in their organization; it stays off until they turn it on, and while it is off approve_episode is refused and names the episode for the person to open.
Each page below says what the tool does, what it takes and what it can be refused with. The input and the description come from the server itself, so they always match what an agent is shown.
The tools
In the order the server lists them. A read changes nothing; a write does.
| Tool | Kind | What it does |
|---|---|---|
list_teams | read | Lists the teams an agent can create sources and episodes in: its person's own live teams, in the organization the key works in. |
get_allowance | read | Shows the organization's plan, the minutes and script generations left in this period, and when they reset. |
list_sources | read | Lists the sources its person can see, newest first, without their text; a team narrows the list to that team. |
create_text_source | write | Pastes text into one of its person's live teams, up to 60,000 characters, as a source an episode can be made from. |
update_source | write | Corrects a source's title, language or text; a call sends at least one of the three. |
create_episode | write | 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. |
list_episodes | read | Lists the episodes its person can see, with their state, title and any failure; a team or a state narrows the list. |
get_episode | read | Shows one episode's state, title and any failure and, once it is ready, links to listen to it that stop working after a while. |
get_script | read | Shows the latest version of an episode's script: its turns, its chapters and whether it was approved. |
edit_turn | write | Rewrites one turn of the script by hand, in place, on the version under review. |
regenerate_turn | write | Has poddub write one turn of the version under review again, inside the call, which can take up to about two minutes. |
regenerate_script | write | Has poddub write a new version of the whole script from the same sources, inside the call, which can take up to about two minutes. |
edit_heading | write | Renames the episode's title or its summary on the latest version; a call sends at least one of the two. |
approve_episode | write | Approves the script under review: the version is frozen, the organization's minutes are spent and poddub starts making the audio. |
retry_episode | write | Resumes a failed episode at the step where it stopped; when making the audio failed, the retry can name another voice engine or mode to try. |
publish_episode | write | Puts a ready episode in its audience's private feeds: its team by default, or the whole organization. |