Add output file format parameter to get_transcript call

cielo24 · May 2, 2019 · 1b7c48d · 1b7c48d
1 parent 96a2b01
commit 1b7c48d
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/api/source/job_control/get_transcript.rst b/api/source/job_control/get_transcript.rst
@@ -221,6 +221,17 @@ The job must have completed transcription before a transcript can be downloaded.
 |                               +------------------+-----------------------------------------------------------+
 |                               | `Example`        | ``timecode_offset=200``                                   |
 +-------------------------------+------------------+-----------------------------------------------------------+
+| file_format                   | .. raw:: html                                                                |
+|                               |                                                                              |
+|                               |  Select output file format                                                   |
+|                               |                                                                              |
+|                               +------------------+-----------------------------------------------------------+
+|                               | `Allowed Values` | String. One of [txt, html, pdf (coming soon)]             |
+|                               +------------------+-----------------------------------------------------------+
+|                               | `Default Value`  | txt                                                       |
+|                               +------------------+-----------------------------------------------------------+
+|                               | `Example`        | ``file_format=html``                                      |
++-------------------------------+------------------+-----------------------------------------------------------+
 
 **Responses**
 
@@ -257,4 +268,4 @@ The job must have completed transcription before a transcript can be downloaded.
     First line of text.
 
     [00:00:11]
-    Second line of text.
+    Second line of text.