1. Rev.com Help Center
  2. Legal Transcription
  3. Release Notes for Rev's Legal Transcription

Rev Legal API 1.0 Release Note

Updated
Have more questions? Submit a request

Release Date: Feb 29, 2024

Release Note Date: Feb 6, 2024

 

Overview

In this release we have made major changes to expand our support for supplementary files, ability to order multiple legal transcription deliverables, as well as the ability to determine the template and proceeding type that has to be used for the order. These changes and updates are aimed to match Rev’s legal workflow and order placement process with the way the industry works today. In this update we are enabling customers to add all the information that we would need in order to provide the transcript as seamlessly as possible.

 

Features

Support for accepting a larger number and additional types of resources, including Exhibits, on order submission. 

List of defined proceeding types in our system. These are the proceeding types which we have built more optimized workflows around:

  • Depositions
  • Hearings
  • SORs
  • EUOs

The supplementary documents categories for the 4 defined proceeding times in our system:

  • Speaker List
  • Glossary
  • Notice
    • Max count: 1
    • File types accepted: Text, Word, PDF, JSON
  • Reporter Notes
    • Max count: 1
    • File types accepted: Text, Word, PDF, JSON
  • Agency Worksheet
    • Max count: 1
    • File types accepted: Text, Word, PDF, JSON
  • Annotations/Tag sheet
    • Max count: 1
    • File types accepted: Text, Word, PDF, JSON
  • Cover/Top Sheet
    • Max count: 1
    • File types accepted: Text, Word, PDF, JSON
  • Exhibits
    • Max count: 150
    • File types accepted: Text, Word, PDF, JSON, Audio, Video
  • Other
    • Max count: 10
    • File types accepted: Text, Word, PDF, JSON, Audio, Video

The supplementary documents categories for proceeding types other than the 4 defined proceeding types in our system:

  • Speaker List
  • Glossary
  • Exhibits
    • Max count: 150
    • File types accepted: Text, Word, PDF, JSON, Audio, Video
  • Other
    • Max count: 20
    • File types accepted: Text, Word, PDF, JSON, Audio, Video

 

The format for accepting legal resources has changed. See below for the new structure for the request.

/**

 * legal_resources accepts an array of resources

 * The following resource types are supported: 

 * 

 * - top_sheet

 * - worksheet

 * - tag_file

 * - notice

 * - reporter_notes

 * - exhibit

 * - other

 * 

 */


{
  "transcription_options": {
    "inputs": [
      {
        "external_link": "https://example.com/main_audio.mp3",

        "speakers": ["John", "Jane", "Sam Jones"],

        "glossary": ["cryptography", "MD5", "SHA-1", "bcrypt"],
        "legal_resources": [
          {
            "type": "tag_file",
            "external_link": "https://example.com/tag_file.docx",
            "name": "legal_tag_file.docx"
          },
        ]

      }

    ],

    "legal_tc_types": ["human_rough_draft"],
  }
}

 

Supplementary resource documents are not required for placing an order via API, but are necessary for Rev to deliver high quality transcripts quickly.

 

 

Ability to determine the proceeding type for the legal transcript being ordered.

It will be required to determine what proceeding type the legal transcript is for.

The proceeding type categories are:

  • Depositions
  • Hearings
  • Examinations Under Oath
  • Statements On Record

{
  "transcription_options": {
    "inputs": [
      {
        "external_link": "https://example.com/main_audio.mp3"
      }
    ],
    "legal_tc_types": ["human_rough_draft"],


    /*
    * Required:
    * The proceeding_type field is used to specify
    * the type of proceeding.
    *
    * Supported proceeding types include:
    * - deposition
    * - hearing
    * - examination_under_oath
    * - statement_on_record
    * - other
    **/
    "proceeding_type": "hearing"
  }
}

 

 

Ability to determine the Ready to Certify Template for the legal Ready to Certify transcript being ordered.

For orders that include an RTC deliverable (unless they are an “Other” for proceeding type), will require a template from our system to be specified. The RTC templates that exist in our system are retrievable via a separate endpoint and are filterable by proceeding type and jurisdiction.

/**

  * GET: https://api.rev.com/api/v1/templates

  * 

  * Retrieves a set of templates.

  * 

  * Templates can be filtered by query parameters

  * i.e. (/templates?proceeding_type=deposition)

  * 

  * Query params:

  * 

  * - proceeding_type   limit the templates to a proceeding type

  * - jurisdiction      limit the templates to a jurisdiction

  * - rev_standard      true: show only rev standard templates

  *                     false: show only your organization templates

  *                     requests without the rev_standard parameter will

  *                       retrieve both your organization’s templates 

  *                       as well as rev standard templates

  */


{
  "templates": [
    {

      "id": 355427878,
      "proceeding_type": "hearing",
      "name": "California Hearing RTC",
      "jurisdiction": "CA",
      "sample_url": "https://example.com/sample.pdf",
      "rev_standard": false
      }
  ]
}








{
  "transcription_options": {
    "inputs": [
      {
        "external_link": "https://example.com/main_audio.mp3"
      }
    ],
    "legal_tc_types": ["ready_to_certify"],
    "proceeding_type": "hearing",


    /**

     * Specify the template ID retrieved from the /templates endpoint here

     */
    "template": 355427878
  }
}

 

 

Ability to order multiple legal transcription deliverables in the same order. 

Any combination of Rev’s legal deliverables, i.e. Legal AI Rough, Human Rough, and Ready to Certify, can be ordered in the same order.

 

 

Ability to add Backup Audio to the order

{
  "transcription_options": {
    "inputs": [
      {
        "external_link": "https://example.com/main_audio.mp3",
        "backups": [
          {
            "external_link": "https://example.com/backup_audio.mp3"
          }
        ]
      }
    ]
 }
}



 

Ability to have multiple splits of the same audio added to the order where the splits will be concatenated by Rev

/**

  * When combining inputs into a single source for transcription

  * use the "combine_inputs" field

  * 

  * IMPORTANT

  *

  * - Each input must have an order_index representing the order that

  *   the audio will be combined.

  *

  * - Any legal resources or backup audio added to the request must be

  *   added to the first input

  */


{
  "transcription_options": {
    "inputs": [
      {
        "external_link": "https://example.com/main_audio_day_1.mp3",
        "order_index": 1,

        "Legal_resources": [],

        "backups": []
      },
      {
        "external_link": "https://example.com/main_audio_day_2.mp3",
        "order_index": 2
      }
    ],
    "combine_inputs": true
  }
}



Updates

  • Ability to get Timestamps on legal non-RTC deliverables when in JSON format.
  • Ability to order non-legal transcripts using the same account used for legal transcription orders. The issues have been fixed for a non-legal transcript to be ordered with a legal transcription Rev account.

 

Notes

The old version of the API will be supported until the end of June 2024. All updates and changes will be based on this update to the API.

There will be full documentation available for the API on release date.

Was this article helpful?
1 out of 1 found this helpful