运营

POST /订单

总结 提交一个新的标题顺序
URL. / api / v1 /订单
详细描述 提交新订单以进行标题。订单请求包含两个主要元素:
  • 标题选项.本节包含对要加标题的输入媒体的引用,作为您希望我们生成的标题文件的格式。

    有三个选项可以指定输入媒体的位置:

    • 对象返回的uriPOST /输入在Location头文件中.如果您的媒体存储在您的系统中,或者可以通过URL访问,我们可以下载它,请使用此方法。首先,做一个POST /输入发送给我们的媒体。接下来,你可以使用返回的URI引用它的订单请求。
    • External_Link.-这应该用于这种情况下,你有一个链接到一个嵌入媒体的网页,但没有一个链接到媒体文件。在进行API调用时,我们不会尝试对以这种方式指定的链接进行任何操作。这与你发布/输入一个媒体文件的链接相反——在这种情况下,我们确实下载了文件。所以external_link应该只在不能直接链接到媒体文件时使用。例如存储在YouTube或Vimeo上的视频。
      如果external_link指向一个YouTube页面,我们可以自动确定视频在该页面上的持续时间。否则,您将需要显式指定媒体持续时间。

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

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

    对于每个输入,您可以选择指定说话人的名字和/或词汇表,以帮助提高您的订单质量。讲话者列表最多可以有100个条目,讲话者姓名最多可以有50个字符长。词汇表最多可以有1000个条目,词汇表条目最多可以有255个字符长。

    您还可以指定为成品字幕文件所需的文件格式。我们支持这些格式:

    常数值 文件格式 描述
    SubRip SubRip SubRip是SubRip程序最先使用的一种简单的字幕文本格式。更多信息。
    鳞状细胞癌 编剧 scenario Closed Caption是一种较老但很流行的格式,许多视频创作工具(如Adobe Premiere)都使用这种格式。更多信息。
    世纪挑战集团 MacCaption MacCaption (.mcc)格式用于高清广播电视。
    TTML. 定时的文本 计时文本标记语言,一种W3C标准,用于指定与视频一起显示的计时文本。更多信息。
    QTtext Quicktime的文本 Quicktime Timed Text是苹果Quicktime Authoring软件支持的专用文本格式,用于指定定时文本。更多信息。
    成绩单 成绩单 纯文本格式
    WebVtt WebVTT WebVTT (Web视频文本轨迹)格式用于标记外部文本轨迹资源。WebVTT文件的主要用途是给视频内容加字幕或字幕。更多信息。
    DFXP DFXP 发行格式Exchange配置文件的目的是用于转换或目前使用的交换遗留分发内容格式之间的定时文本信息的字幕和解说功能的目的。更多信息。
    CheetahCap 猎豹.CAP 对于猎豹Captivator脱机文件格式
    STL. 云杉字幕文件 Spruce Subtitle File,一种简单的字幕文本格式,最初由DVD Studio Pro使用。更多信息。
    AvidDs Avid DS字幕文件 Avid DS Subtitle File: Avid DS软件的字幕文件格式
    Aviddvd. Avid DVD字幕文件 Avid DVD字幕文件,是Avid DVD软件的字幕文件格式
    FacebookSubrip. Facebook就绪子领域 标准的SubRip文件与Facebook文件命名约定。更多信息。

    在订单请求指定这些格式是可选的 - 我们在内部产生一个规范格式的字幕,然后可以即时导出为上述任何格式。但是,如果在订单请求指定格式,那么我们的团队可以确保生产字幕您想要的格式进行了优化,所以我们推荐这样做,如果所需的格式是已知的。默认情况下,我们优化子领域。

    如果您需要外语字幕,您可以指定语言代码列表。你可以为这些语言代码订购字幕:es-es, es-la, fr, ko, ar, de, pl, zh-si, hi, pt-br, zh-tr, it, ru, cs, ja, tr和nl。

  • 通知信息.可选地,当订单进入新状态(例如,被标记)和完成时,您可以请求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
  • 没有指定输入位置-没有为输入媒体设置外部链接和URI
  • 10007无法连接到提供的外部链路
  • 10008个S3桶不支持,请考虑使用签名的S3网址,而不是
  • 20001无效媒体长度-如果输入的媒体中有一个指定的视频长度不是正整数。如果您不提供视频长度,我们也无法自动计算它,这也将被返回
  • 20003无效语言代码-提供的一个或多个语言代码无效
  • 20004不兼容的语言-一些选定的输出文件格式不支持一种或多种指定的语言。例如,Scenarist (Scc)、MacCaptions (Mcc)和CheetahCap (CAP)与使用非拉丁字母的语言不兼容。
  • 有字幕语言的字幕订单不支持20005 Rush
  • 20010参考编号太长的代码 - 参考号码提供超过256个字符
  • 20020发言者名单不得超过100人
  • 20021扬声器名不能超过50个字符
  • 20030词汇不得超过1000项
  • 术语表项不能为空,也不能超过255个字符
  • 30010只有余额付款,如果您代表订单请求的用户,则没有资格使用账户余额付款
  • 30011帐户余额限制超过-如果订单请求使用帐户余额指定付款,但这样做将超过用户的余额限制
  • 40010 PO号码太长-提供的PO、项目或部门超过了最大长度
  • 40011用户未经授权的PO编号 - 用户没有发票设置或无法在结账时设置PO
  • 40012 PO编号的无效订单类型—为不支持的订单类型提供了PO、项目或部门
  • 50000字段验证错误-一个或多个字段格式错误
带注释的示例请求
{/ *可选,对于客户端* /“client_ref”的订单的参考编号:“xb432423”,/ *可选,指定不需要正常的周转时间。默认情况下,假设正常的周转时间(假)。请注意,此值仅用为指南。* /“non_standard_tat_guarantee”:“false”,/ *必填,提供有关需要字样的信息和指定所需的标题输出格式的信息。* /“caption_options”:{/ *强制性,包含要标题的媒体列表。必须具有至少一个元素* /“输入”:[{/ *视频长度,以秒为单位。* /“video_length_seconds”:600,/ *介质的URI,从呼叫到发布/输入* /,“URI”:“URN:Rev:InputMedia:467432FDS”,/ *可选,扬声器名称列表。兼容任何输入格式。* /“扬声器”:[“John”,“Jane”,“Sam Jones”],/ *可选,词汇表项列表。兼容任何输入格式。 */ "glossary": ["cryptography", "MD5", "SHA-1", "bcrypt"], }, { /* YouTube URL, video length determined automatically. */ "external_link": "http://www.youtube.com/watch?v=UF8uR6Z6KLc" }, { /* For any other external URL, video length in seconds is required. */ "video_length_seconds": 300, "external_link": "https://vimeo.com/7976699" } ], /* Optional, language codes to request foreign language subtitles. */ "subtitle_languages": [ "es-es", "it" ], /* Optional, what file formats should the captions be optimized for. See table in description section for supported formats. By default, we optimize for SubRip. */ "output_file_formats": [ "Scc", "SubRip" ], /* 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. */ "rush": true, /* Optional, should we generate burned-in caption (aka open captions) videos for every input on this order? Requesting burned-in captions adds $0.25 per audio minute to the cost of your orders. Burned-in captions will be available to download via the API for 7 days after they are generated. */ "burned_in_captions": true }, /* 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" }
 <! - 可选,用于有意义的用于客户端的顺序的附图标记 - >  XB432423  <! - 可选,指定正常周转时间是不需要的。默认情况下,假设正常的周转时间(假)。请注意,此值仅用为指南。- >  <! - 强制的,提供了关于需要被标题和指定的期望字幕的输出格式的信息。- >  <! - 强制性,包含的媒体标题列表。必须至少有一个元件 - > <输入> <输入> <! - 视频的长度,以秒四舍五入。! - >  600  < - 强制性,媒体的URI,作为从呼叫到POST返回/输入 - > 瓮启:inputmedia:467432fds  <!- 可选,音箱名单。兼容任何输入格式。- > <扬声器> <扬声器>约翰 <扬声器>简 <扬声器>萨姆 - 琼斯  <! - 可选,词汇条目列表。兼容任何输入格式。 -->  cryptography MD5 SHA-1 bcrypt     http://www.youtube.com/watch?v=UF8uR6Z6KLc    300 https://vimeo.com/7976699     es-es it    Scc SubRip   true  true     http://www.clientsite.com/orderupdate  Detailed   SamplePoNumber01