运营

发布/订单

总结 提交新订单
URL / api / v1 /订单
详细说明 提交一份新的订单以便抄写。订单请求包含两个主要元素:
  • 转录选项。本节包含要转录的输入介质的引用。指定输入介质有三种选项:
    • 对象返回的uriPOST /输入在Location头文件中。如果媒体要么存储在系统中,或者可以在我们可以下载的URL上访问,请使用此功能。
      首先,做一个POST /输入向我们发送媒体。接下来,您可以使用返回的URI在订单请求中引用它。
    • 外部链接- 如果您有嵌入媒体的网页链接,则应使用此选项,但不是向媒体文件的链接。在API调用时,我们不会尝试使用这种方式指定的链接。这与您在与媒体文件链接的链接发布到/输入时进行对比 - 在这种情况下下载文件。
      external_link只能在不能直接链接到媒体文件时使用。
      如果external_link指向一个YouTube页面,我们可以自动确定视频在该页面上的持续时间。否则,您将需要显式指定媒体持续时间。

    对于任何输入,您必须提供URI或External_Link,但不是两者。如果两个或两者都没有提供,则返回错误。

    对于每个输入,您可以明确指定输入所引用的视频的音频长度(以秒为单位)。如果您没有指定音频长度,我们将尝试从输入媒体自动确定它;然而,我们并非总能做到这一点。我们通常可以使用常见的音频/视频格式(例如mp3、aac、quicktime等)来计算文件的音频长度,这些格式的大小可达10MB。如果您的文件大于10MB或使用不常见的音频/视频格式,我们强烈建议您明确指定音频长度。

    对于每个输入,您可以选择可选地指定扬声器名称,词汇表和/或扬声器口音,以帮助提高订单的质量。扬声器列表最多可包含100个条目,并且扬声器名称最长可达50个字符。词汇表可能有多达1000个条目,而词汇表项可以长达255个字符。

    我们目前支持以下内容(区分大小写):

    • AmericanNeutral
    • 美国人南方
    • 亚洲人
    • 澳大利亚
    • 英国人
    • 印度人
    • 其他
    • 未知

    我们还允许API的用户指定转录是否应使用我们的逐字选项进行转录,并指定是否应包括时间戳。通过REV API放置时,时间戳是免费的,但您仍然需要指定应包括时间戳。

    您还可以选择为已完成的转录文件指定所需的文件格式。我们支持这些格式:

    恒定值 文件类型
    文书处理软件 。docx
    杰森 .JSON.
    文本 . txt
    PDF. .pdf.

    在订单请求中指定这些格式是可选的——我们在内部以规范格式生成转录本,然后可以将它们作为上述格式中的任何一种实时导出。但是,如果您在订单请求中指定了格式,那么我们的团队可以确保生成的成绩单是针对您想要的格式进行优化的,所以我们建议在已知想要的格式的情况下这样做。默认情况下,我们对Microsoft Word进行了优化。

  • 通知信息。可选地,当订单进入新状态(例如转录或审核)时,您可以请求将HTTP帖子进行到您选择的URL。
  • PO、项目或部门。(可选)您可以添加PO,项目或部门,以指定应如何支付订单。只有在客户有发票时才有效。

    最大长度:64。

付款将从用户的账户余额中扣除。

请求头
  • 授权- 包含客户端/用户API键
请求体 包含订单详细信息的XML或JSON。请参阅下面的示例实体,以说明所使用的字段。
响应 成功,201创建。
错误,400坏请求。
响应头
  • 地点- URI识别新创建的订单。此URI可用于请求订单的详细信息(例如状态)。仅在返回201次响应代码时才出现。
响应体 成功,空。出错,将包含一个<错误/>实体,具有更多详细信息。
错误代码
  • 缺少输入-如果订单请求不包含任何输入媒体
  • 10002无效输入 - 如果输入媒体URI之一无效,例如不会通过帖子到/输入上载上载的有效媒体
  • 10003多个服务选项指定-目前,一个订单只能为我们提供的三种服务之一(转录和标题)。通过包含一个转录选项、automated_transcription_options或caption_options元素来指定服务。如果请求中包含多个这样的元素,则返回此错误。
  • 未指定10004服务类型 - 您必须包含Transcription_Options,Automated_Transcription_Options或Caption_Options元素中的一个。如果其中均未包含,则返回此错误。
  • 10005外部链接和URI指定的 - 仅为输入媒体设置外部链接或URI
  • 10006输入位置未指定 - 既不是输入介质的外部链路和URI
  • 10007无法连接到提供的外部链接
  • 不支持10008 S3桶,请考虑使用符号的S3 URL
  • 20001无效的媒体长度 - 如果其中一个输入介质具有指定的音频长度,则不是正整数。如果您没有提供音频长度,那么这也将返回,我们无法自动计算它
  • 20010参考编号太长的代码 - 参考号码提供超过256个字符
  • 20020年扬声器清单可能不超过100个发言者
  • 20021说话人姓名不能超过50个字符
  • 20030词汇表可能不超过1000个条目
  • 术语表项不能为空,也不能超过255个字符
  • 20040年提供的口音数量不得超过8
  • 不支持提供的一个或多个重音
  • 30010只有余额付款,如果您代表订单请求的用户,则没有资格使用账户余额付款
  • 超过30011帐户余额限制 - 如果订单请求使用帐户余额指定付款,但这样做将超过用户的平衡限制
  • 40010 PO号码太长-提供的PO、项目或部门超过了最大长度
  • 40011用户未经授权的PO编号 - 用户没有发票设置或无法在结账时设置PO
  • 40012 PO编号的无效订单类型—为不支持的订单类型提供了PO、项目或部门
  • 50000字段验证错误-一个或多个字段格式错误
注释样本请求
{/ *可选,对于客户端* /“client_ref”的订单的参考编号:“xb432423”,/ *强制性,提供有关需要转录的信息,并允许设置任何转录选项。* /“transcription_options”:{/ *强制性,包含要传授的媒体列表。必须具有至少一个元素* /“输入”:[{/ *音频长度,以秒为单位。* /“Audio_Length_seconds”:60,/ *媒体URI,从呼叫到发布/输入* /,“URI”:“URN:Rev:InputMedia:467432FDS”,/ *可选,扬声器名称列表。兼容任何输入格式。* /“扬声器”:[“John”,“Jane”,“Sam Jones”],/ *可选,词汇表项列表。兼容任何输入格式。* /“词汇表”:[“加密”,“MD5”,“SHA-1”,“BCRYPT”,/ *可选,扬声器口音清单。兼容任何输入格式。* /“口音”:[“英国”,“AmericAnnutral”,“其他”]},{/ * YouTube URL,自动确定音频长度。 */ "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.25 / 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 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 or has a new comment. If "FinalOnly" (the default), notification is sent only when the order is complete. */ "level": "Detailed" }, /* Optional- customer must have invoicing, it links order to PO, Project, or Department for billing */ "ponumber": "SamplePoNumber01" }
< order_request > < !——可选,对客户端有意义的订单引用号——> XB432423  < transcription_options > < !-强制性,包含要转录的媒体列表。必须至少有一个元素——>    < audio_length_seconds > 600 < / audio_length_seconds > < !——必选,媒体的URI,从POST /inputs调用返回——> < URI >urn:rev:inputmedia:467432fds   John Jane Sam Jones    cryptography MD5 SHA-1 bcrypt    British AmericanNeutral Other     http://www.youtube.com/watch?v=UF8uR6Z6KLc    300 https://vimeo.com/7976699    true  true  true  true   MS Word Pdf      http://www.clientsite.com/orderupdate  Detailed   SamplePoNumber01