Get result of transcription request

Endpoint Overview

Endpoint:
GET /api/companies/{companyCuid}/orchestrators/{orchestratorCuid}/transcriptionRequests/{processCuid}

This endpoint retrieves the current status and details of a transcription request using the process_cuid provided during request creation.

---

Path Parameters

Parameter	Description	Type	Required	Example
companyCuid	Unique identifier of the company	String	Yes	cmp_abc123
orchestratorCuid	Unique identifier of the orchestrator	String	Yes	orc_def456
processCuid	Unique identifier of the transcription job	String	Yes	proc_789ghi

---

Response

If successful, the API returns detailed information about the transcription request, including status, step, actions, and metadata.

Field	Description	Type
process_cuid	Unique ID of the transcription process	String
created_at	Timestamp of process creation	DateTime
updated_at	Timestamp of last update	DateTime
status	Overall process status (pending, started, finished, etc.)	String
step	Current processing step (uploading, transcribing, etc.)	String
vocabulary	Optional custom vocabulary used	String
external_ref	Optional client-supplied external reference	String
actions	List of actions with status, result, and webhook info	Array

Note on Failure Handling
If the process fails at any point, the overall status of the process and the status of the corresponding action will be set to "failed".
An error message will be provided in the error field of the corresponding action dictionary.
In the case of failure, no further actions will be executed and the process will be halted.

Example Response

{
  "process_cuid": "abcd-1234-efgh-5678",
  "created_at": "2025-01-01T12:00:00Z",
  "updated_at": "2025-01-01T14:00:00Z",
  "status": "started",
  "step": "transcribing",
  "vocabulary": "DalirSicx, metAl Plus, MeltiStake, TFGC, Q.U.A.R.T.Z.",
  "external_ref": "1234-abcd-56ef-7891",
  "actions": [
    {
      "action_type": "factual_summary",
      "created_at": "2025-01-01T12:15:00Z",
      "status": "pending",
      "error": null,
      "result": null,
      "webhook": "https://example.com/webhook/factual-summary",
      "external_metadata": {
        "conversation_id": "afvvf67890dfsf",
        "source": "workflow-manager",
        "status": "in-progress"
      }
    }
  ]
}