创建图片压缩任务

开发中

POST

/api/tasks/visual/imgcompress

创建图片压缩任务

图片来源：文件上传（二进制）或从 URL 下载

请求参数

Query 参数

string

可选

Header 参数

X-API-KEY

string

必需

string

可选

Body 参数multipart/form-data

image_file

string

可选

源图像文件（二进制）。（如果此参数存在，则其他图像源参数必须为空）

image_url

string

可选

源图像URL。(如果存在此参数，则其他图像源参数必须为空)

sync

integer

可选

是否等待结果就绪并立即返回（默认值：0）。如果设为1，API将会等待结果准备好后立即返回。如果设为0，API将返回 task_id，稍后可通过 /{task_id} 端点获取结果。请注意，请求提交后，结果最多只会保留1个小时。

format

string

可选

处理后的输出格式。若原格式为 jpg 或 png 或 webp则保持原格式，否则返回服务器自动推荐的格式。

return_type

integer

可选

1 = 返回图片的下载URL。
2 = 以base64字符串形式返回图片。

quality

integer

可选

图片质量，取值范围：0 - 100, 默认为 75。(如果存在此参数，则kbyte参数必须为空)
0~~100为由强~~弱的压缩程度，1最强，100最弱

kbyte

integer

可选

指定压缩后图片大小，单位为KB，取值范围：0 - 51200。(如果存在此参数，则quality参数必须为空)

若返回的编码格式为png，则不支持指定文件大小压缩

width

integer

可选

压缩后图片宽度，取值范围：0 - 8000, 默认为原图宽度。若无 height 参数，则保持图片宽高比。

height

integer

可选

压缩后图片高度，取值范围：0 - 8000, 默认为原图高度。若无 width 参数，则保持图片宽高比。

string

可选

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.gptnb.ai/api/tasks/visual/imgcompress' \
--header 'X-API-KEY;' \
--form '=""'

返回响应

🟢200成功

application/json

Body

status

integer

必需

200 任务创建成功。
400
客户端参数传递错误。请检查参数是否缺失或值是否正确
401
认证失败。请检查X-API-KEY是否正确或者服务是否开通
429
请求频率超出QPS限制（默认QPS为2）。请放缓请求速率，或者联系商务提升QPS限制

message

string

必需

data

object

必需

task_id

string

必需

示例

{
  "status": 200,
  "message": "ok",
  "data": {
    "task_id": "94806a3f-1173-4afb-9bcc-3ff19c0981f4"
  }
}

修改于 2024-08-25 07:35:41

获取黑白图像上色结果

创建OCR任务