跳转到主要内容
POST
/
v1
/
jobs
异步任务
curl --request POST \
  --url https://screenshot.cleariflow.com/v1/jobs \
  --header 'Content-Type: application/json' \
  --data '
{
  "request": {},
  "priority": 123
}
'
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000"
}

​
入门

​
基础 URL

https://screenshot.cleariflow.com/v1/jobs

​
创建任务

使用与同步端点相同的 ScreenshotRequest 负载将异步截图任务入队。

​
请求示例

curl -X POST 'https://screenshot.cleariflow.com/v1/jobs' \
  -H 'Content-Type: application/json' \
  -d '{
    "request": {
      "api_key": "YOUR_UNIQUE_API_KEY",
      "url": "https://cleariflow.com"
    },
    "priority": 10
  }'
成功请求会返回任务标识符： 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000"
}

​
创建任务参数

​
request
Object
必填
与同步截图端点字段相同的 ScreenshotRequest 对象（url、render、actions、cookies 等）。
​
priority
Integer
任务优先级。数值越高越先处理。默认值：0。

​
获取任务状态

通过 ID 轮询任务以检查状态，并在完成后获取结果。

​
基础 URL

https://screenshot.cleariflow.com/v1/jobs/{job_id}

​
请求示例

curl 'https://screenshot.cleariflow.com/v1/jobs/550e8400-e29b-41d4-a716-446655440000'
任务运行中： 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "running"
}
任务成功完成时： 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "done",
  "result": {
    "ok": true,
    "image_base64": "/9j/4AAQSkZJRg...",
    "content_type": "image/jpeg",
    "meta": {
      "elapsed_ms": 8123
    }
  }
}

​
任务状态值

状态说明
queued任务在队列中等待。
running浏览器会话处于活动状态。
done截图已完成；result 包含输出。
failed截图失败；error 包含错误描述。

​
响应参数

​
job_id
String
异步任务的唯一标识符。
​
status
String
当前任务状态：queued、running、done 或 failed。
​
result
Object
截图结果对象（与同步端点响应结构相同）。当 status 为 done 时存在。
​
error
String
错误消息。当 status 为 failed 时存在。
​
meta
Object
有关任务执行的附加元数据。