# Download and export transcripts Download a transcript directly or export selected transcript fields as JSON, CSV, TSV, or text. URL: /guides/outputs/download-transcripts Wait until the relevant workflow is complete before requesting an output. ## Direct download [#direct-download] The GET endpoint accepts `locale`, `layout`, and `file_format` query parameters. Use `locale=source` for the original transcript. ```bash export LINGOPAL_API_KEY="your-api-key" export JOB_ID="replace-with-job-id" curl "https://api.lingopal.ai/v2/jobs/$JOB_ID/outputs/transcript?locale=source&file_format=txt" \ -H "X-API-Key: $LINGOPAL_API_KEY" \ --output transcript.txt ``` ## GET /v2/jobs/{job_id}/outputs/transcript ```json { "openapi": "3.1.0", "info": { "title": "Download job transcript", "description": "Lingopal v2 public API for text translation, storage uploads, registered jobs, job workflows, and job outputs.", "version": "v2" }, "servers": [ { "url": "https://vod-api.lingopal-dev.com" } ], "security": [ { "APIKeyHeader": [] } ], "paths": { "/v2/jobs/{job_id}/outputs/transcript": { "get": { "tags": [ "Job Outputs" ], "summary": "Download job transcript", "description": "Downloads a transcript for a registered job as JSON, CSV, TSV, or plain text.", "operationId": "downloadJobTranscript", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Reusable registered job ID returned by `/v2/jobs/register` or `/v2/jobs/upload-and-register`.", "examples": [ "job_123" ], "title": "Job Id" }, "description": "Reusable registered job ID returned by `/v2/jobs/register` or `/v2/jobs/upload-and-register`." }, { "name": "locale", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "source", "title": "Locale" } }, { "name": "layout", "in": "query", "required": false, "schema": { "enum": [ "compact", "detailed" ], "type": "string", "default": "compact", "title": "Layout" } }, { "name": "file_format", "in": "query", "required": false, "schema": { "enum": [ "json", "csv", "tsv", "txt" ], "type": "string", "default": "txt", "title": "File Format" } } ], "responses": { "200": { "description": "Transcript file content or JSON transcript payload.", "content": { "application/json": { "schema": {}, "example": { "job_id": "job_123", "locale": "es", "layout": "detailed", "columns": [ "speaker_id", "start_time", "end_time", "text" ], "line_count": 1, "segments": [ { "speaker_id": "speaker_1", "start_time": "0.00", "end_time": "2.40", "text": "Bienvenido a Lingopal." } ] } }, "text/plain": { "example": "[0.00 -> 2.40] : Bienvenido a Lingopal." }, "text/csv": { "example": "speaker_id,start_time,end_time,text\nspeaker_1,0.00,2.40,Bienvenido a Lingopal." }, "text/tab-separated-values": { "example": "speaker_id\tstart_time\tend_time\ttext\nspeaker_1\t0.00\t2.40\tBienvenido a Lingopal." } } }, "404": { "description": "The requested resource was not found.", "content": { "application/json": { "example": { "detail": "Transcript Not Found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "tags": [ { "name": "Job Outputs", "description": "Download transcripts, subtitles, and exported job outputs." } ], "components": { "schemas": { "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } }, "securitySchemes": { "APIKeyHeader": { "in": "header", "name": "X-API-Key", "type": "apiKey" } } } } ``` Use the [API Reference entry for downloadJobTranscript](/reference/job-outputs/downloadJobTranscript) for complete query options and response behavior, including locale and format combinations. ## Structured export [#structured-export] ## POST /v2/jobs/{job_id}/outputs/transcript ```json { "openapi": "3.1.0", "info": { "title": "Export job transcript with selected columns", "description": "Lingopal v2 public API for text translation, storage uploads, registered jobs, job workflows, and job outputs.", "version": "v2" }, "servers": [ { "url": "https://vod-api.lingopal-dev.com" } ], "security": [ { "APIKeyHeader": [] } ], "paths": { "/v2/jobs/{job_id}/outputs/transcript": { "post": { "tags": [ "Job Outputs" ], "summary": "Export job transcript with selected columns", "description": "Exports a transcript for a registered job with optional include/exclude controls.", "operationId": "exportJobTranscript", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "description": "Reusable registered job ID returned by `/v2/jobs/register` or `/v2/jobs/upload-and-register`.", "examples": [ "job_123" ], "title": "Job Id" }, "description": "Reusable registered job ID returned by `/v2/jobs/register` or `/v2/jobs/upload-and-register`." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscriptDownloadRequest" }, "examples": { "exportJobTranscriptJsonDetailed": { "summary": "Export detailed JSON transcript", "description": "Export a target-language transcript as JSON with speaker and timing columns.", "value": { "locale": "es", "layout": "detailed", "file_format": "json", "include_columns": [ "speaker_id", "start_time", "end_time", "text" ] } }, "exportJobTranscriptCsvCompact": { "summary": "Export compact CSV transcript", "description": "Export the source transcript as CSV while omitting optional metadata columns.", "value": { "locale": "source", "layout": "compact", "file_format": "csv", "exclude_columns": [ "gender", "emotion" ] } } } } } }, "responses": { "200": { "description": "Transcript file content or JSON transcript payload.", "content": { "application/json": { "schema": {}, "example": { "job_id": "job_123", "locale": "es", "layout": "detailed", "columns": [ "speaker_id", "start_time", "end_time", "text" ], "line_count": 1, "segments": [ { "speaker_id": "speaker_1", "start_time": "0.00", "end_time": "2.40", "text": "Bienvenido a Lingopal." } ] } }, "text/plain": { "example": "[0.00 -> 2.40] : Bienvenido a Lingopal." }, "text/csv": { "example": "speaker_id,start_time,end_time,text\nspeaker_1,0.00,2.40,Bienvenido a Lingopal." }, "text/tab-separated-values": { "example": "speaker_id\tstart_time\tend_time\ttext\nspeaker_1\t0.00\t2.40\tBienvenido a Lingopal." } } }, "404": { "description": "The requested resource was not found.", "content": { "application/json": { "example": { "detail": "Transcript Not Found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "tags": [ { "name": "Job Outputs", "description": "Download transcripts, subtitles, and exported job outputs." } ], "components": { "schemas": { "TranscriptDownloadRequest": { "properties": { "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Locale", "description": "Transcript locale to export. Use `source` for the original transcript.", "default": "source", "examples": [ "source", "es" ] }, "layout": { "type": "string", "enum": [ "compact", "detailed" ], "title": "Layout", "description": "Transcript response layout for JSON-style exports.", "default": "compact", "examples": [ "compact", "detailed" ] }, "file_format": { "type": "string", "enum": [ "json", "csv", "tsv", "txt" ], "title": "File Format", "description": "Transcript download format.", "default": "txt", "examples": [ "txt", "json", "csv", "tsv" ] }, "include_columns": { "anyOf": [ { "items": { "type": "string", "enum": [ "speaker_id", "start_time", "end_time", "text", "gender", "emotion" ] }, "type": "array" }, { "type": "null" } ], "title": "Include Columns", "description": "Additional transcript columns to include in the export.", "examples": [ [ "speaker_id", "start_time", "end_time", "text" ] ] }, "exclude_columns": { "anyOf": [ { "items": { "type": "string", "enum": [ "speaker_id", "start_time", "end_time", "text", "gender", "emotion" ] }, "type": "array" }, { "type": "null" } ], "title": "Exclude Columns", "description": "Transcript columns to omit from the export.", "examples": [ [ "gender", "emotion" ] ] } }, "type": "object", "title": "TranscriptDownloadRequest" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } }, "securitySchemes": { "APIKeyHeader": { "in": "header", "name": "X-API-Key", "type": "apiKey" } } } } ``` The POST endpoint supports JSON payload configuration for field and layout control: ```json { "locale": "es", "layout": "compact", "file_format": "csv", "include_columns": ["speaker_id", "start_time", "end_time", "text"] } ``` Available fields include `speaker_id`, timestamps, text, gender, and emotion. Use `compact` for flat CSV/TSV data and `detailed` when preserving richer JSON structure. Use the [API Reference entry for exportJobTranscript](/reference/job-outputs/exportJobTranscript) for the complete export schema and supported field combinations.