API概览

概述

本文适用基于API URL发起HTTP或HTTPS POST请求的用户，如果您使用的是SDK，可以跳过本文档。

发起API请求的URL由不同参数组合而成，有固定的请求结构（具体请参见请求结构）。URL中包含公共参数（具体请参见公共参数）、您的签名（具体请参见签名）和某个API接口的具体参数。每篇API文档均给出了URL请求示例供您参考，但是为了方便显示，我们并没有编码这些URL示例，您需要在发起请求前自行编码。我们根据您的签名验证了请求后，会发送返回结果给您（具体请参见返回结果）。接口调用成功会显示返回参数，调用失败则显示相应报错，您可以根据公共错误码和具体API错误码分析排查。

说明推荐您使用SDK，免除手动签名验证环节，方便调用接口以及管理资源。

并发限制

并发限制指同一时刻能够检测的内容（图片、视频、文本、语音）的数量。关于接口调用的并发数量限制，请参见产品定价页的说明。

说明

如果您要调整默认并发限制，请提交工单联系我们。提高默认并发限制需另行收费。
默认情况下，针对同一对象进行多场景检测只计作一次并发。例如，对同一张图片进行色情和暴恐涉政检测，则并发数量是1。


对象	功能	描述
图片	图片审核	检测图片违规或识别图片中的不良信息。
	图文OCR识别	识别图片中的文字、卡证信息。
	相似图检索	检测指定图片和相似图库中的样本图片的相似度。
	图片敏感人脸检测	检测图片中是否包含敏感人脸内容。
	人脸比对	检测两张人脸照片的相似度。
	自定义人脸检索	从指定人脸库检索特定人脸图片，并返回与目标最相似的5个结果。
	活体翻拍检测	检测图片中的活体对象来自直接拍摄或翻拍。
	图片标签识别	识别图片中的标签内容。
视频	视频审核	检测视频中的违规内容或不良信息。
视频	视频敏感人脸检测	检测视频中是否包含敏感人脸内容。
文本	文本反垃圾	检测文本中的违规内容。
文件	文件内容反垃圾	解析待检测文件中的图片和文字部分，并分别检测其中的违规内容。
语音	语音反垃圾	检测语音文件或语音流中的违规信息。

更多API资源及信息，请访问OpenAPI开发者门户、阿里云开发者中心。

图片审核


接口	描述
/green/image/scan	提交图片同步检测任务，检测图片违规或识别图片中的不良信息。
/green/image/asyncscan	提交图片异步检测任务，检测图片违规或识别图片中的不良信息。
/green/image/results	查询图片审核的异步检测结果。
/green/image/feedback	提交图片审核的检测结果反馈。

图文OCR识别


接口	描述
/green/image/scan	提交OCR同步识别任务，识别图片中的文字、卡证信息。
/green/image/asyncscan	提交OCR异步识别任务，识别图片中的文字、卡证信息。
/green/image/results	查询OCR异步识别结果。

相似图检索


接口	描述
/green/similarity/library/add	新增一个相似图样本图库。
/green/similarity/image/add	向指定的相似图库中添加样本图片。
/green/image/scan	检测指定图片和相似图库中的样本图片的相似度。
/green/similarity/library/list	分页查询所有相似图库及其元信息。
/green/similarity/library/get	查询指定图库的信息。
/green/similarity/image/list	分页查询指定图库下的所有图片样本及其元信息。
/green/similarity/image/get	查询指定相似图库中样本图片的元信息。
/green/similarity/library/delete	删除指定的相似图库。
/green/similarity/image/delete	从指定的相似图库中移除相似图样本。

图片敏感人脸识别


接口	描述
/green/image/scan	提交图片同步检测任务，识别图片中的敏感人脸。
/green/image/asyncscan	提交图片异步检测任务，识别图片中的敏感人脸。
/green/image/results	提交图片异步检测任务进行敏感人脸检测后，调用本接口查询检测结果。

人脸比对


接口	描述
/green/image/scan	提交图片同步检测任务，进行人脸照片1：1比对，检测两张人脸照片的相似度。
/green/image/asyncscan	提交图片异步检测任务，进行人脸1：1比对。
/green/image/results	提交图片异步检测人脸1：1比对任务后，调用本接口查询检测结果。

自定义人脸检索


接口	描述
/green/image/scan	提交自定义人脸检索任务。根据您输入的待识别人脸图片，在指定人脸库中查找并返回最相似的Top 5个体，返回的Top 5个体按照相似度从大到小排序。
/green/sface/person/add	新建个体，并加入指定组。
/green/sface/person/update	设置个体信息，包括姓名和备注信息。
/green/sface/person	获取个体信息，包括姓名、相关人脸、所属的组。
/green/sface/person/delete	删除个体。
/green/sface/face/add	为指定个体新增一组人脸信息。
/green/sface/face/delete	删除指定个体下的人脸信息。
/green/sface/groups	获取所有的组列表。
/green/sface/group/persons	获取指定组下的个体列表。
/green/sface/person/groups/add	新增组信息，将一个个体加入到指定组中。
/green/sface/person/groups/delete	移除组信息，将一个个体从指定组中移除。

活体翻拍检测


接口	描述
/green/image/scan	提交图片同步检测任务，进行活体翻拍检测。
/green/image/asyncscan	提交图片异步检测任务，进行活体翻拍检测。
/green/image/results	提交图片异步活体翻拍检测任务后，调用本接口查询检测结果。

图片标签识别


接口	描述
/green/image/scan	提交图片同步检测任务，进行图片标签识别。
/green/image/asyncscan	提交图片异步检测任务，进行图片标签识别。
/green/image/results	提交图片标签异步识别任务后，调用本接口查询检测结果。

视频审核


接口	描述
/green/video/syncscan	提交视频同步检测任务，检测视频中的违规内容或不良信息。
/green/video/asyncscan	提交视频异步检测任务，检测视频中的违规内容或不良信息。
/green/video/results	查询视频审核的异步检测结果。
/green/video/feedback	提交视频审核的检测结果反馈。

视频敏感人脸识别


接口	描述
/green/video/syncscan	检测视频中是否包含敏感人脸，并同步返回检测结果。
/green/video/asyncscan	异步检测视频中是否包含敏感人脸。
/green/video/results	提交视频异步检测任务进行敏感人脸检测后，调用本接口查询检测结果。

文本反垃圾


接口	描述
/green/text/scan	提交文本检测任务，检测文本中的违规内容。
/green/text/feedback	提交文本检测结果反馈。

文件内容反垃圾


接口	描述
/green/file/asyncscan	提交文件检测任务，解析待检测文件中的图片和文字部分，并分别检测其中的违规内容。
/green/file/results	查询文件检测结果。

语音反垃圾


接口	描述
/green/voice/asyncscan	提交语音检测任务，检测语音文件或语音流中的违规信息。
/green/voice/results	查询语音检测结果。
/green/voice/cancelscan	取消语音检测任务。

概述

导航