--- updatedAt: 2026-07-21T08:40:48.000Z agentTools: projectIndex: https://developers.intandem.tech/llms.txt --- # List TranscriptionRuns ## Overview Retrieve a paginated list of transcription runs for the authenticated client. Supports sorting by field and direction. **Available for Staff tokens** # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Ai", "description": "Unified OpenAPI specification for ai domain", "version": "3.0", "x-generated": { "sourceFiles": [ "recommendations.json", "business_rules.json", "business_ai_settings.json", "bizai.json", "ai_smart_reply.json", "generic_ai.json", "staff_ai_settings.json", "ai_generation_feedback.json" ], "pathNormalizations": [], "pathConflicts": [], "componentConflicts": [ { "type": "schema", "name": "ErrorResponse", "resolution": "Renamed to ErrorResponse_business_rules", "files": [ "merged", "business_rules.json" ] }, { "type": "schema", "name": "ErrorResponse", "resolution": "Renamed to ErrorResponse_business_ai_settings", "files": [ "merged", "business_ai_settings.json" ] }, { "type": "schema", "name": "Response", "resolution": "Renamed to Response_ai_smart_reply", "files": [ "merged", "ai_smart_reply.json" ] }, { "type": "schema", "name": "ErrorResponse", "resolution": "Renamed to ErrorResponse_staff_ai_settings", "files": [ "merged", "staff_ai_settings.json" ] } ], "totalPaths": 20, "totalComponents": 33 } }, "servers": [ { "url": "https://api.vcita.biz", "description": "Unified API Gateway server" } ], "paths": { "/v3/ai/transcription_runs": { "get": { "tags": [ "AI Transcription Runs" ], "summary": "List TranscriptionRuns", "description": "## Overview\nRetrieve a paginated list of transcription runs for the authenticated client. Supports sorting by field and direction.\n\n**Available for Staff tokens**", "parameters": [ { "name": "page", "in": "query", "description": "Page number for pagination (e.g., 1, 2, 3). Defaults to 1.", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Number of items per page, between 1 and 100. Defaults to 20.", "required": false, "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "sort", "in": "query", "description": "Sort field and direction in the format 'field:direction' (e.g., \"created_at:desc\", \"status:asc\").", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of transcription runs retrieved successfully.", "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "description": "Indicates whether the API request was successful (true) or failed (false)." }, "data": { "type": "object", "description": "The response payload. Present on successful responses (success: true)." }, "error": { "type": "string", "description": "Error message for simple error responses. Used in some legacy endpoints." }, "errors": { "type": "array", "description": "Array of error objects for detailed error responses. Present on error responses (success: false).", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found')." }, "message": { "type": "string", "description": "Human-readable error message." }, "field": { "type": "string", "description": "The field that caused the error (for validation errors)." } }, "required": [ "code", "message" ] } } }, "required": [ "success" ], "description": "Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string." }, { "properties": { "data": { "$ref": "#/components/schemas/TranscriptionRunList" } } } ] } } } }, "401": { "description": "Unauthorized - The bearer token is missing, expired, or invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Indicates whether the API request was successful (true) or failed (false)." }, "data": { "type": "object", "description": "The response payload. Present on successful responses (success: true)." }, "error": { "type": "string", "description": "Error message for simple error responses. Used in some legacy endpoints." }, "errors": { "type": "array", "description": "Array of error objects for detailed error responses. Present on error responses (success: false).", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found')." }, "message": { "type": "string", "description": "Human-readable error message." }, "field": { "type": "string", "description": "The field that caused the error (for validation errors)." } }, "required": [ "code", "message" ] } } }, "required": [ "success" ], "description": "Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string." }, "example": { "success": false, "errors": [ { "code": "unauthorized", "message": "Invalid or expired bearer token." } ] } } } } }, "security": [ { "Bearer": [] } ] } } }, "components": { "schemas": { "TranscriptionRunList": { "type": "object", "description": "A list of transcription runs.", "properties": { "transcription_runs": { "type": "array", "items": { "type": "object", "description": "Represents an async transcription run. Poll this resource until status is COMPLETED or FAILED.", "properties": { "uid": { "type": "string", "readOnly": true, "description": "Unique identifier of the transcription run." }, "status": { "type": "string", "readOnly": true, "enum": [ "QUEUED", "IN_PROGRESS", "COMPLETED", "FAILED" ], "description": "Current status of the run. Possible values: 'QUEUED' (job is waiting to be processed), 'IN_PROGRESS' (job is actively being processed by the transcription provider), 'COMPLETED' (job finished successfully and result is available), 'FAILED' (job encountered an error and error_message is available)." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The date and time when the run was created, in ISO 8601 format (e.g., \"2026-02-08T13:18:39.698Z\")." }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The date and time when the run was last updated, in ISO 8601 format (e.g., \"2026-02-08T13:18:41.000Z\")." }, "result": { "type": "object", "description": "The transcription result. Only present when status is 'COMPLETED'.", "properties": { "text": { "type": "string", "readOnly": true, "description": "The full transcribed text output from the audio file." }, "language": { "type": "string", "readOnly": true, "description": "The detected or specified language code in ISO-639-1 format (e.g., \"en\" for English, \"es\" for Spanish, \"he\" for Hebrew)." }, "duration": { "type": "number", "readOnly": true, "description": "Total duration of the audio file in seconds (e.g., 3.5)." }, "words": { "type": "array", "readOnly": true, "description": "Word-level timestamps for each transcribed word. Only present when using the 'verbose_json' response format.", "items": { "type": "object", "properties": { "word": { "type": "string", "description": "The transcribed word." }, "start": { "type": "number", "description": "Start time of the word in seconds from the beginning of the audio." }, "end": { "type": "number", "description": "End time of the word in seconds from the beginning of the audio." } } } }, "segments": { "type": "array", "readOnly": true, "description": "Segment-level data with timing and optional speaker information. Each segment represents a contiguous block of transcribed speech, useful for diarization and long audio files.", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Sequential identifier for the segment (e.g., 0, 1, 2)." }, "start": { "type": "number", "description": "Start time of the segment in seconds from the beginning of the audio." }, "end": { "type": "number", "description": "End time of the segment in seconds from the beginning of the audio." }, "text": { "type": "string", "description": "The transcribed text for this segment." }, "speaker": { "type": "string", "description": "Speaker identifier when diarization is enabled (e.g., \"SPEAKER_00\", \"SPEAKER_01\")." } } } } }, "required": [ "text" ], "example": { "text": "For more information visit www.FEMA.gov", "language": "en", "duration": 3.5, "words": [ { "word": "For", "start": 0, "end": 0.18 }, { "word": "more", "start": 0.18, "end": 0.38 }, { "word": "information", "start": 0.38, "end": 0.92 }, { "word": "visit", "start": 0.92, "end": 1.24 }, { "word": "www.FEMA.gov", "start": 1.24, "end": 3.5 } ], "segments": [ { "id": 0, "start": 0, "end": 3.5, "text": "For more information visit www.FEMA.gov", "speaker": "SPEAKER_00" } ] }, "readOnly": true }, "error_message": { "type": "string", "readOnly": true, "description": "Error message describing the failure reason. Only present when status is 'FAILED'." } }, "required": [ "uid", "status", "created_at" ], "example": { "uid": "85ade9f5-2690-48e8-ae5b-b07d6b57b457", "status": "COMPLETED", "created_at": "2026-02-08T13:18:39.698Z", "updated_at": "2026-02-08T13:18:41.000Z", "result": { "text": "For more information visit www.FEMA.gov", "language": "en", "duration": 3.5 } } } } } } }, "securitySchemes": { "Bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Provide a valid bearer token in the Authorization header. Example: 'Authorization: Bearer {app_token}'" } } }, "tags": [ { "name": "AI Transcription Runs", "description": "Manage async transcription runs" } ] } ```