List transcription requests

Returns your organization’s transcription requests, newest first, filterable by state and podcast. Not billed.

GET /v1/podcasts/transcription/requests

cURL

cURL

curl -H "X-API-Key: $PARTICLE_API_KEY" \
  "https://api.particle.pro/v1/podcasts/transcription/requests?limit=25"

200

{
  "data": [
    {
      "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"
    }
  ],
  "has_more": true,
  "cursor": "<string>"
}

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).

Query Parameters

limit · integer<int64> · default: 25

Results per page

Required range: 1 <= x <= 100

cursor · string

Opaque pagination cursor from previous response

state · enum<string>

Only requests in this state.

Available options: queued, admitted, transcribed, failed

podcast_id · string

Only requests for this podcast's episodes: slug, ID, or numeric iTunes ID.

Response

200

application/json

OK

data · object[] · required

List of results

Show child attributes

has_more · boolean · required

Whether more results exist

cursor · string

Pass to next request for more results