Get Batch Status | SoferAi

from soferai import SoferAI
from uuid import UUID
client = SoferAI(
    api_key="YOUR_TOKEN_HERE"
)
client.batch_transcribe.get_batch_status(
    batch_id=UUID("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
)

{
  "batch_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "PROCESSING",
  "total_count": 3,
  "completed_count": 1,
  "failed_count": 0,
  "pending_count": 2,
  "transcriptions": [
    {
      "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "title": "Shiur 1",
      "created_at": "2024-01-15T09:30:00Z",
      "primary_language": "en",
      "hebrew_word_format": [
        "en",
        "he"
      ],
      "num_speakers": 1,
      "status": "COMPLETED",
      "duration": 1802.5,
      "model": "v1"
    },
    {
      "id": "e6f0d95a-d3c3-5ca5-c5c1-8aad8b0aad43",
      "title": "Shiur 2",
      "created_at": "2024-01-15T09:30:00Z",
      "primary_language": "en",
      "hebrew_word_format": [
        "en",
        "he"
      ],
      "num_speakers": 1,
      "status": "PROCESSING",
      "model": "v1"
    }
  ]
}

Check the progress of a batch transcription. Returns counts of completed, failed, and pending transcriptions, plus details for each individual transcription.

Authentication

AuthorizationBearer

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

Path parameters

batch_idUUIDRequired

The batch ID returned from Create Batch Transcription

Response

This endpoint returns an object.

batch_idUUID

ID of this batch

statusenum

Overall batch status

Allowed values:

total_countinteger

Total transcriptions in batch

completed_countinteger

Successfully completed

failed_countinteger

Failed transcriptions

pending_countinteger

Still processing or queued

transcriptionslist of objects

Status details for each transcription in the batch

Authentication

Path parameters

Response

Errors