Podcast Transcription
tier:free

Get a transcription request

Returns one of your organization's transcription requests and where it stands. Not billed.

get/v1/podcasts/transcription/requests/{id}

Request

  • Base URL: https://api.particle.pro
  • URL: https://api.particle.pro/v1/podcasts/transcription/requests/{id}
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

idstring required

The request's ID, as POST /v1/podcasts/transcription/requests returned it.

Response

OK

admitted_atstring date-time

When transcription started.

completed_atstring date-time

When the request was transcribed or failed.

created_atstring date-time

When the request was made.

episode_idstring required

The episode, for GET /v1/podcasts/episodes/{id}. It keeps this ID once transcribed.

failure_reasonstring

Why a failed request will not be transcribed, e.g. enclosure_gone when the publisher removed the audio, or timed_out.

idstring

The request's ID, for GET /v1/podcasts/transcription/requests/{id}. Absent when no request was needed because we already hold the episode: state then reports where its transcript stands.

podcast_idstring

The episode's podcast.

refunded_atstring date-time

When a failed request's transcription charge was returned to your organization: the included request, prepaid credit or overage it drew. Absent until then, and on requests that were billed as a lookup.

state'queued' | 'admitted' | 'transcribed' | 'failed' required

queued: waiting its turn. admitted: being transcribed. transcribed: the transcript is available. failed: it will not be transcribed; failure_reason says why.

Changes

No recorded changes to this operation across all 2 revisions of this API.