Get Transcription Translation | SoferAi

from soferai import SoferAI
import uuid
client = SoferAI(
    api_key="YOUR_TOKEN_HERE",
)
client.transcribe.get_transcription_translation(
    transcription_id=uuid.UUID("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
    target_mode="target_mode",
)

{
  "transcription_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "target_mode": "paragraph",
  "translation_style": "formal",
  "status": "completed",
  "completed_segments": 2,
  "failed_segments": 0,
  "segments": [
    {
      "segment_id": "seg-001",
      "segment_index": 1,
      "source_hash": "a1b2c3d4e5f6",
      "status": "translated",
      "is_stale": false,
      "source_language": "en",
      "target_language": "es",
      "start_time": 0,
      "end_time": 12.5,
      "speaker": "Speaker 1",
      "content": "Hola, ¿cómo estás?",
      "error": null
    },
    {
      "segment_id": "seg-002",
      "segment_index": 2,
      "source_hash": "f6e5d4c3b2a1",
      "status": "translated",
      "is_stale": false,
      "source_language": "en",
      "target_language": "es",
      "start_time": 12.6,
      "end_time": 25,
      "speaker": "Speaker 2",
      "content": "Estoy bien, gracias por preguntar.",
      "error": null
    }
  ],
  "model": "nmt-v2.1",
  "total_segments": 2,
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T10:00:00Z",
  "error": null
}

Get paragraph-level translation status and translated segments for a transcription

Authentication

AuthorizationBearer

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

Path parameters

transcription_idUUIDRequired

ID of the transcription.

target_modestringRequired

Translation target mode. Use auto, en, or he.

Query parameters

translation_stylestringOptional

Translation style id. Built-ins include learning_english and sefer_hebrew; saved user guides use custom:<style_id>.

Response

This endpoint returns an object.

transcription_idUUID

ID of the source transcription.

target_modestring

Translation target mode.

translation_stylestring

Translation style id.

statusstring

Overall translation status.

completed_segmentsinteger

Number of successfully translated segments.

failed_segmentsinteger

Number of failed segments.

segmentslist of objects

Paragraph-level translated segments.

modelstringOptional

Model used for translation.

total_segmentsintegerOptional

Total paragraph segments in the translation job.

created_atdatetimeOptional

When the translation job was created.

updated_atdatetimeOptional

When the translation job was last updated.

errorstringOptional

Overall job error, if any.

Errors

401

Authentication Error

404

Transcription Not Found

429

Rate Limit Error