Documentation

Use this method to download the finished output file contents of a legal transcription attachment. This endpoint will retrieve the latest version of the attachment, including edits, after all editor sessions for the attachment have been closed for at least two minutes.

For output file attachments, you may request to get the contents in a specific representation (file format), either via the Accept HTTP header or by appending an extension to the end of the URL.

Per word timestamps are automatically included with your transcript. Per word timestamps are only available with the JSON format.

Additionally, legal monologue types will also surface in the JSON output to provide more information on what type each monologue is. The following monologue types are supported:

• colloquy
• question
• answer
• by_line
• exhibit
• swear_in
• examination_title
• other_parenthetical
• proceeding_end

The following representations are supported for legal transcripts:

{
    "speakers": [
        {"id": 1, "name": "Interviewee"},
        {"id": 2, "name": "Interviewer"}
    ],
    /*
        Monologues (transcribed speech).
        Each monologue corresponds to a run of text from one speaker.
    */
    "monologues": [
        {
            "id": 1,
            "speaker": 1, /* Speaker id, same as declared above */
            "speaker_name": "Interviewee", /* Speaker name, same as declared above */
            "monologue_type": "colloquy", /* Monologue type */
            /*
                Elements of the monologue.
                Each element is either text (transcribed speech)
                or a tag (an annotation), such as inaudible.

                Text elements may or may not contain a timestamp.
                Tag elements require a timestamp.
            */
            "elements": [
                {
                    /* Text element, no timestamp */
                    "type": "text",
                    /* For text elements, value contains the text */
                    "value": "I've never been here before"
                },
                {
                    /* Tag element */
                    "type": "tag",
                    /* For tag elements, value contains the annotation type */
                    "value": "inaudible",
                    /*
                        Timestamp format is hh:mm:sss,fff,
                        where fff represents milliseconds
                    */
                    "timestamp": "00:00:07,000"
                },
                /*
                    Text elements, with per word timestamps
                    Whitespace and punctuation are not timestamped
                */
                {
                    "type": "text",
                    "value": " "
                },
                {
                    "type": "text",
                    "value": "so",
                    "timestamp": "00:00:20,000",
                    "end_timestamp": "00:00:20,138"
                },
                {
                    "type": "text",
                    "value": " "
                },
                {
                    "type": "text",
                    "value": "this",
                    "timestamp": "00:00:20,222",
                    "end_timestamp": "00:00:20,566"
                }
            ]
        }
    ]
}
                    

If the requested representation is not supported for the output file, then a 406 Not Acceptable status code will be returned. With the Accept header, you may specify multiple acceptable representations (as described in the Accept header HTTP spec), and the best possible match will be returned.

If you do not specify a desired representation via Accept header or URL extension, then the output file contents will be returned in its default format. For both AI Rough Draft and Human Rough Draft transcripts, this will be a JSON output. For Ready To Certify transcripts, this will be returned in the format of the set preferred legal file type.

For both AI Rough Draft and Human Rough Draft transcripts, if you request an attachment in the plain text representation (using "Accept: text/plain" header or ".txt" URL extension), you can also request a specific character encoding using the Accept-Charset HTTP header. The following encodings are supported:

If you do not specify a desired character encoding via the Accept-Charset header, then the UTF-8 encoding will be used. If something other than the plain text representation is requested, then the Accept-Charset header is ignored.

• id - id of the attachment to retrieve

• Authorization - contains client/user API keys
• Accept - optional, specifies a desired format for the attachment as a media type.
• Accept-Charset - optional, specifies a desired character set encoding for the attachment, if a plain text representation is requested.

• Content-Type - the content type of the attachment