Get a transcription request

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

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

cURL

cURL

curl -H "X-API-Key: $PARTICLE_API_KEY" \
  "https://api.particle.pro/v1/podcasts/transcription/requests/{id}"

200

{
  "episode_id": "<string>",
  "state": "queued",
  "admitted_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "episode": {
    "id": "<string>",
    "title": "<string>",
    "podcast": {
      "id": "<string>",
      "title": "<string>",
      "best_rank": {
        "captured_at": "2023-11-07T05:31:56Z",
        "chart_type": "top_podcasts",
        "rank": 123,
        "source": "apple",
        "category_slug": "<string>",
        "country": "<string>"
      },
      "image_url": "<string>",
      "popularity": 123,
      "publisher": {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>"
      },
      "slug": "<string>"
    },
    "published_at": "2023-11-07T05:31:56Z",
    "slug": "<string>",
    "web_url": "<string>"
  },
  "failure_reason": "<string>",
  "id": "<string>",
  "podcast": {
    "id": "<string>",
    "title": "<string>",
    "best_rank": {
      "captured_at": "2023-11-07T05:31:56Z",
      "chart_type": "top_podcasts",
      "rank": 123,
      "source": "apple",
      "category_slug": "<string>",
      "country": "<string>"
    },
    "image_url": "<string>",
    "popularity": 123,
    "publisher": {
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>"
    },
    "slug": "<string>"
  },
  "podcast_id": "<string>",
  "refunded_at": "2023-11-07T05:31:56Z"
}

Prefer the terminal? This endpoint is also a command in the Particle CLI: pick Particle CLI in the request example’s language menu. Install the Particle CLI.

Authorizations

ApiKeyHeaderBearerAuth

X-API-Key · string · header · required

Pass your API key in the X-API-Key header (recommended).

Path Parameters

id · string · required

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

Response

200

application/json

OK

episode_id · string · required

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

state · enum<string> · required

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

Available options: queued, admitted, transcribed, failed

admitted_at · string<date-time>

When transcription started.

completed_at · string<date-time>

When the request was transcribed or failed.

created_at · string<date-time>

When the request was made.

episode · object

The episode's id, title and publication date, so a list can be read without looking each one up. slug is set once the episode is transcribed or being transcribed, and absent if it was since removed. Its podcast is the podcast field beside it, not episode.podcast.

Show child attributes

failure_reason · string

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

id · string

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 · object

The episode's podcast, with its slug and title. Absent if the podcast was removed from the catalogue.

Show child attributes

podcast_id · string

The episode's podcast.

refunded_at · string<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.