Operations
POST /orders
| Summary | Submit a new order | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| URL | /api/v1/orders | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Detailed Description |
Use this method to submit a new order for legal transcription. The order will be placed in the user's default team. Payment will be done by debiting the user's account balance. Note: Placing Legal Transcription orders requires some additional set up by the Rev team. Please contact us at nonprod+legalsupport@rev.com for support.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Request Headers |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Request Body |
JSON with the details about the order. See below for an example entity illustrating the fields used.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Response |
On success, 201 Created. On error, 400 Bad Request. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Response Headers |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Response Body |
On success, an entity containing information about expected delivery dates for each legal deliverable type ordered. On error, will contain an <error/> entity with more details. For each deliverable type ordered, the response body will include an entry in a deliverables list, where the following is provided:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Error Codes |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Legal Resources |
For the proceeding types:
For the proceeding type:
For the proceeding type
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Annotated sample request |
{
/*
Optional, whether to place a sandbox mode or real order
*/
"sandbox_mode": true,
/*
Optional, a reference number for the order meaningful for the client
*/
"client_ref": "Legal API test order",
/*
Mandatory, provides information on what needs to be transcribed and
allows for any transcription options to be set.
*/
"transcription_options": {
/*
Mandatory, contains list of media to transcribe.
Must have at least one element
*/
"inputs": [
{
/*
URL link to download media file that is to be transcribed.
*/
"external_link": "https://www.rev.ai/FTC_Sample_1.mp3",
/*
Optional, list of speaker names.
Compatible with any input format.
*/
"speakers": ["John", "Jane", "Sam Jones"],
/*
Optional, list of glossary entries.
Compatible with any input format.
*/
"glossary": ["cryptography", "MD5", "SHA-1", "bcrypt"],
/*
Additional legal resource files to be referenced for transcription.
See table above for a full list of supported legal resource types.
*/
"legal_resources": [
/*
Topsheet resource document link and file name.
*/
{
"type": "top_sheet",
"external_link":"https://www.rev.com/top_sheet.txt",
"name": "Test topsheet 1.txt"
},
/*
Worksheet resource document link and file name.
*/
{
"type": "worksheet",
"external_link": "https://www.rev.com/worksheet.txt",
"name": "test worksheet 1.txt"
},
/*
Tag file resource document link and file name.
*/
{
"type": "tag_file",
"external_link": "https://www.rev.com/tag_file.txt",
"name": "test tag file 1.txt"
}
],
/*
Backup recordings for reference
*/
"backups":[
{
"external_link": "https://www.rev.com/backup_audio1.mp3"
},
{
"external_link": "https://www.rev.com/backup_audio2.mp3"
}
]
}
],
/*
Mandatory, a list of the legal deliverable types and corresponding delivery information being ordered.
*/
"deliverable_options": [
{
/*
Mandatory, the legal deliverable type to be ordered.
*/
"deliverable_type": "legal_ready_to_certify",
/*
Optional, the number of business days to receive your deliverable by.
*/
"business_days": 5
},
{
"deliverable_type": "legal_human_rough_draft"
},
{
"deliverable_type": "legal_ai_rough_draft"
}
],
/*
Mandatory, specifies the type of proceeding to be transcribed. Supported proceeding types:
deposition, hearing, statement_on_record, examination_under_oath, other
*/
"proceeding_type": "deposition",
/*
Mandatory when ordering a ready_to_certify transcript.
Specifies the ID of the ready to certify template to be used when generating the transcript.
Template IDs are accessible via a GET request to the /templates endpoint.
*/
"template": 123456
},
/*
Optional, enables receiving notifications about the order status
*/
"notification": {
/*
The url for notifications.
Mandatory if the notifications element is used.
Updates will be posted to this URL
*/
"url": "http://www.clientsite.com/orderupdate",
/*
Optional, specifies which notifications are sent.
- If "Detailed", then a notification is sent whenever the order is in a new status,
has a completed file ready for download, or has a new comment.
- If "FileComplete", then a notification is sent whenever work on a file has been completed
and is ready for download.
- If "FinalOnly" (the default), a notification is sent only when the order is complete.
*/
"level": "Detailed",
/*
Optional, specifies the content-type that notifications will be transmitted with.
- If "FormUrlEncoded" (or omitted), they will be transmitted in application/x-www-form-urlencoded format.
- If "ApplicationJson", they will be transmitted in application/json format.
*/
"content_type": "FormUrlEncoded"
},
/*
Optional- customer must have invoicing, it links order to PO, Project, or Department for billing
*/
"ponumber": "SamplePoNumber01",
/*
Optional- id of the workspace the order should be placed in
*/
"workspace_id": 123456789
}
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Annotated sample request for audio concatenation |
{
/*
Optional, whether to place a sandbox mode or real order
*/
"sandbox_mode": true,
/*
Optional, a reference number for the order meaningful for the client
*/
"client_ref": "Legal API test order",
/*
Mandatory, provides information on what needs to be transcribed and
allows for any transcription options to be set.
*/
"transcription_options": {
/*
Mandatory, contains list of media to transcribe.
Must have at least one element
*/
"inputs": [
{
/*
URL link to download media file that is to be transcribed.
*/
"external_link": "https://www.rev.ai/FTC_Sample_1.mp3",
/*
Optional, use only when combination_mode is sequential
Indicates files sequential order in the concatenation of
audio/video files
*/
"order_index": 1,
/*
Optional, list of speaker names.
Compatible with any input format.
*/
"speakers": ["John", "Jane", "Sam Jones"],
/*
Optional, list of glossary entries.
Compatible with any input format.
*/
"glossary": ["cryptography", "MD5", "SHA-1", "bcrypt"],
/*
Additional legal resource files to be referenced for transcription.
See table above for a full list of supported legal resource types.
When combining inputs, it is important to associate the legal resources with the first input.
*/
"legal_resources": [
/*
Topsheet resource document link and file name.
*/
{
"type": "top_sheet",
"external_link":"https://www.rev.com/top_sheet.txt",
"name": "Test topsheet 1.txt"
},
/*
Worksheet resource document link and file name.
*/
{
"type": "worksheet",
"external_link": "https://www.rev.com/worksheet.txt",
"name": "test worksheet 1.txt"
},
/*
Tag file resource document link and file name.
*/
{
"type": "tag_file",
"external_link": "https://www.reg.com/tag_file.txt",
"name": "test tag file 1.txt"
}
],
/*
Backup recordings for reference.
When combining inputs, it is important to associate the backups with the first input.
*/
"backups":[
{
"external_link": "https://www.rev.com/backup_audio1.mp3"
},
{
"external_link": "https://www.rev.com/backup_audio2.mp3"
}
]
},
{
/*
URL link to the second media file that is to be combined with the
first.
*/
"external_link": "https://www.rev.ai/FTC_Sample_1.mp3",
/*
Optional, use only when combination_mode is sequential
Indicates files sequential order in the concatenation of
audio/video files
*/
"order_index": 2
}
],
/*
Optional, specifies that the audio files included need to be combined sequentially (concatenated)
*/
"combination_mode": "sequential",
/*
Mandatory, a list of the legal deliverable types and corresponding delivery information being ordered.
*/
"deliverable_options": [
{
/*
Mandatory, the legal deliverable type to be ordered.
*/
"deliverable_type": "legal_ready_to_certify",
/*
Optional, the number of business days to receive your deliverable by.
*/
"business_days": 5
},
{
"deliverable_type": "legal_human_rough_draft"
},
{
"deliverable_type": "legal_ai_rough_draft"
}
],
/*
Mandatory, specifies the type of proceeding to be transcribed. Supported proceeding types:
deposition, hearing, statement_on_record, examination_under_oath, other
*/
"proceeding_type": "deposition",
/*
Mandatory when ordering a ready_to_certify transcript.
Specifies the ID of the ready to certify template to be used when generating the transcript.
Template IDs are accessible via a GET request to the /templates endpoint.
*/
"template": 123456
},
/*
Optional, enables receiving notifications about the order status.
*/
"notification": {
/*
The url for notifications.
Mandatory if the notifications element is used.
Updates will be posted to this URL.
*/
"url": "https://webhook.site/example",
/*
Optional, specifies which notifications are sent.
- If "Detailed", then a notification is sent whenever the order is in a new status,
has a completed file ready for download, or has a new comment.
- If "FileComplete", then a notification is sent whenever work on a file has been completed
and is ready for download.
- If "FinalOnly" (the default), a notification is sent only when the order is complete.
*/
"level": "Detailed"
}
}
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Annotated sample response |
{
/*
A list of the ordered legal deliverables with corresponding expected delivery information.
*/
"deliverables": [
{
/*
The legal deliverable type ordered.
*/
"deliverable_type": "legal_ready_to_certify",
/*
The expected date and time (in UTC) the following completed deliverable will be returned to you by.
*/
"delivery_date": "2024-07-27T03:59:59Z"
},
{
"deliverable_type": "legal_human_rough_draft",
"delivery_date": "2024-07-25T03:59:59Z"
},
{
"deliverable_type": "legal_ai_rough_draft",
"delivery_date": "2024-07-29T19:06:58.59Z"
}
]
}
|