Operations
POST /orders
| Summary | Submit a new order | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| URL | /api/v1/orders | ||||||||||
| Detailed Description |
Submit a new order for transcription. The order request contains two main elements:
Payment will be done by debiting the user's account balance. |
||||||||||
| Request Headers |
|
||||||||||
| Request Body | XML or 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, empty. On error, will contain an <error/> entity with more details. | ||||||||||
| Error Codes |
|
||||||||||
| 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": "XB432423",
/*
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": [
{
/*
Length of audio, in seconds rounded up.
*/
"audio_length_seconds": 60,
/*
URI of the media, as returned from the call to POST /inputs
*/,
"uri": "urn:rev:inputmedia:467432fds",
/*
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"],
/*
Optional, list of speaker accents.
Compatible with any input format.
*/
"accents": ["British", "AmericanNeutral", "Other"],
},
{
/*
YouTube URL, audio length determined automatically.
*/
"external_link": "http://www.youtube.com/watch?v=UF8uR6Z6KLc"
},
{
/*
For any other external link URL audio length is mandatory
*/
"audio_length_seconds": 300,
"external_link": "https://vimeo.com/7976699"
}
],
/*
Optional, should we transcribe the provided files verbatim?
If true, all filler words (i.e. umm, huh) will be included.
Requesting Verbatim adds $0.50 / minute to the cost of your orders.
*/
"verbatim": true,
/*
Optional, should we include timestamps?
Timestamps are available in the JSON format, and are free.
We make a best effort for the timestamps to be per-word, but do not guarantee it.
*/
"timestamps": true,
/*
Optional, should we rush this order?
Rush will deliver your files up to 5x faster.
Requesting Rush adds $1.25 per audio minute to the cost of your orders.
We expect a high degree of accuracy with these files.
However, speaker names may be inconsistent for files over 30 minutes.
*/
"rush": true,
/*
Optional, should we create an instant machine-generated first draft?
Requesting an Instant First Draft adds $0.10 per audio minute to the cost of your orders.
*/
"instant_first_draft": true
/*
Optional, what file formats should the transcripts be optimized for.
See table in description section for supported formats.
By default, we optimize for Microsoft Word.
*/
"output_file_formats": ["MS Word", "JSON"]
},
/*
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
}
<order_request>
<!--
Optional, whether to place a sandbox mode or real order
-->
<sandbox_mode>true</sandbox_mode>
<!--
Optional, a reference number for the order meaningful for the client
-->
<client_ref>XB432423</client_ref>
<!--
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>
<input>
<!--
Length of audio, in seconds rounded up.
-->
<audio_length_seconds>600</audio_length_seconds>
<!--
Mandatory, URI of the media, as returned from the call
to POST /inputs
-->
<uri>urn:rev:inputmedia:467432fds</uri>
<!--
Optional, list of speaker names.
Compatible with any input format.
-->
<speakers>
<speaker>John</speaker>
<speaker>Jane</speaker>
<speaker>Sam Jones</speaker>
</speakers>
<!--
Optional, list of glossary entries.
Compatible with any input format.
-->
<glossary>
<entry>cryptography</entry>
<entry>MD5</entry>
<entry>SHA-1</entry>
<entry>bcrypt</entry>
</glossary>
<!--
Optional, list of speaker accents.
Compatible with any input format.
-->
<accents>
<accent>British</accent>
<accent>AmericanNeutral</accent>
<accent>Other</accent>
</accents>
</input>
<input>
<!--
YouTube URL, audio length determined automatically
-->
<external_link>http://www.youtube.com/watch?v=UF8uR6Z6KLc</external_link>
</input>
<input>
<!--
For any other external URL audio length is mandatory
-->
<audio_length_seconds>300</audio_length_seconds>
<external_link>https://vimeo.com/7976699</external_link>
</input>
</inputs>
<!--
Optional, should we transcribe the provided files verbatim?
If true, all filler words (i.e. umm, huh) will be included.
-->
<verbatim>true</verbatim>
<!--
Optional, should we include timestamps?
-->
<timestamps>true</timestamps>
<!--
Optional, should we rush this order?
Rush will deliver your files up to 5x faster.
Requesting Rush adds $1.25 per audio minute to the cost of your orders.
We expect a high degree of accuracy with these files.
However, speaker names may be inconsistent for files over 30 minutes.
-->
<rush>true</rush>
<!--
Optional, should we create an instant machine-generated first draft?
Requesting an Instant First Draft adds $0.10 per minute to the cost of your orders.
-->
<instant_first_draft>true</instant_first_draft>
<!--
Optional, what file formats should the transcripts be optimized for.
See table in description section for supported formats.
By default, we optimize for Microsoft Word.
-->
<output_file_formats>
<file_format>MS Word</file_format>
<file_format>Pdf</file_format>
</output_file_formats>
</transcription_options>
<!--
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</url>
<!--
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</level>
<!--
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</content_type>
</notification>
<!--
Optional- customer must have invoicing, it links order to PO, Project, or Department for billing
-->
<ponumber>SamplePoNumber01</ponumber>
<!--
Optional- id of the workspace the order should be placed in
-->
<workspace_id>123456789</workspace_id>
</order_request>
|