Skip to navigation
FormantAI Voice APIPodcast

Get an episode

View as Markdown

Returns the current state of an episode, and a time-limited link to the MP3 once it is rendered. Poll until status is completed or failed; both are terminal. Episodes are scoped to the workspace that submitted them.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

podcast_idintegerRequired
Episode id returned when the episode was submitted.

Response

Current episode status, with an audio link once completed
idinteger
Episode id.
statusenum

pending and processing are in-flight; completed and failed are terminal.

Allowed values:
episode_namestring or nullOptional
Filename stem submitted with the episode.
errorstring or nullOptional

Set only when status is failed.

duration_secondsdouble or nullOptional
Length of the rendered episode.
audio_urlstring or nullOptional

Time-limited link to the episode, MP3 or MP4 per output_format. Absent until the episode completes; poll again for a fresh one.

audio_url_expires_ininteger or nullOptional

Seconds audio_url stays valid.

Errors

401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error