准备开始

访问 API

通过 HTTP 请求来访问 API. 您可以在 CoolParse 官网控制台 API Keys 页面创建 API key。

访问 API 的基础 URL 是 https://openapi.coolparse.com。

验证

所有请求都需要带上验证信息，通过Authorization请求头来传递，值的格式是 Bearer {key}, 示例：Authorization: Bearer sk-xxx。

Content types

带 body 的请求统一使用 JSON 格式，需要使用 Content-Type: application/json请求头。

所有接口返回 body 统一使用 JSON 格式。

其他公共请求头

Header	描述
x-cp-request-id	您需要创建一个 UUID 来追踪请求，以便排查问题。

请求结果

请求成功时会返回 200 HTTP 状态码。

返回 body

使用统一的数据结构，包括 code, msg, data 3 个字段。

字段	描述
code	在请求成功时返回 0，其他错误码请参见错误码列表。
msg	主要用于返回错误提示信息。
data	它的数据结构视不同的接口而定，一般而言只有请求成功时才有值。

{
	"code": 0, 
	"msg": "",
	"data": "true"
}

分页查询

请求参数

参数	描述
page	页码，从 1 开始。数据项的偏移量等于 (page -1) * size
size	一页数据项的条数。

示例：https://openapi.coolparse.com/cloud/batches?page=1&size=10.

响应结果

参数	描述
page	请求参数回填
size	请求参数回填
total	符合查询条件的所有数据项总条数。

示例：

{
	"code": 0,
	"data": {
		"list": [
			{}
		],
		"pagination": {
			"page": 1,
			"size": 10,
			"total": 23
		}
	}
}

请求示例

curl --location --request POST 'https://openapi.coolparse.com/cloud/stop' \
--header 'Authorization: Bearer sk-xxx' \
--header 'Content-Type: application/json' \
--header 'x-cp-request-id: 26387cf4-b166-4487-aab0-052cc64267e0' \
--data-raw '{ "taskID": "9b57f4b8-c5d5-44ac-b4be-52ea63ae4742" }'

返回结果：

{
    "code": 0,
    "data": {
        "list": [
            {
                "batchID": 56692473407440,
                "taskID": "da18d43c-4958-4e67-9d76-ee292006b552",
                "createTime": 1731744923000,
                "updateTime": 1731744953000,
                "startTime": 1731744923000,
                "endTime": 1731744953000,
                "useTime": 30178,
                "lineCount": 32,
                "duplicatedCount": 0,
                "captchaCount": 0,
                "ipProxyUsage": 0,
                "region": "",
                "nodeCount": 1,
                "jobCount": 1,
                "status": 3,
                "fields": [
                    {
                        "id": "91ca1f16-36b8-4e8d-975d-d8a3fbd91bd4",
                        "name": "asni"
                    },
                    {
                        "id": "6a3173c9-64f3-4348-8ec0-622f29252d48",
                        "name": "title"
                    }
                ]
            }
        ],
        "pagination": {
            "page": 1,
            "size": 10,
            "total": 1
        }
    }
}

错误码

code	说明
9000000	解析参数失败，通常是因为数据类型不正确、缺少必填参数等。
9000001	非法参数，例如参数值超出有效范围等。
9000002	非法请求。
9000003	没有访问权限
9000004	没有找到指定的资源
9000005	不能重复创建