curl -X POST https://api.1-converter.com/api/v1/convert/upload \
-H "X-API-Key: YOUR_API_KEY" \
-F "[email protected]" \
-F "target_format=png"入门
从零到第一个转换完成的文件:
- 在 1-converter.com 选择付费套餐(Starter、Pro 或 Business)。免费版不提供 API 密钥。
- 在“控制台 → 设置 → API 密钥”中创建密钥并复制:它只显示一次。
- 按照“身份验证”部分的说明,在第一次上传时附上密钥。
验证
每个请求都要带上你的 API 密钥,放在下面任意一个请求头中:
X-API-Key: YOUR_API_KEY
Authorization: Bearer YOUR_API_KEY两个请求头都可以使用,携带的是同一个密钥,选你的 HTTP 客户端更方便的那个即可。
切勿分享你的 API 密钥,也不要把它提交到版本控制中。
确保您的 API 密钥安全,切勿在客户端代码中公开它。
基本网址
API端点
上传和转换
上传文件并将其转换为指定格式
POST/api/v1/convert/upload
请求标头
Content-Type: multipart/form-data
Authorization: Bearer YOUR_API_KEY请求正文
file要转换的文件(必需)target_format目标格式(例如“pdf”、“jpg”、“png”)(必填)
回复
{
"id": 4821,
"original_file_name": "document.pdf",
"original_format": "pdf",
"target_format": "docx",
"status": "pending",
"progress": 0,
"created_at": "2026-08-01T09:14:03Z",
"expires_at": "2026-08-08T09:14:03Z"
}检查状态
检查转换状态
GET/api/v1/convert/status/:id
回复
{
"conversion": {
"id": 4821,
"original_file_name": "document.pdf",
"target_format": "docx",
"status": "completed",
"progress": 100,
"created_at": "2026-08-01T09:14:03Z",
"expires_at": "2026-08-08T09:14:03Z"
}
}下载结果
下载转换后的文件
GET/api/v1/convert/download/:id
速率限制
每个付费套餐都包含每月的 API 调用次数,与价格页面上显示的一致。
| 计划 | 每月 API 调用 |
|---|---|
| Free | 无 API 密钥 |
| Starter | 每月 1,000 次 API 调用 |
| Pro | 每月 10,000 次 API 调用 |
| Business | API 无限制 |
当超出速率限制时,您将收到 429 Too Many Requests 响应。
错误代码
API 使用标准 HTTP 状态代码来指示成功或失败:
| 代码 | 描述 |
|---|---|
| 400 错误请求 | 请求参数无效 |
| 401 未经授权 | API 密钥无效或丢失 |
| 403 禁忌 | 权限不足 |
| 404 未找到 | 找不到资源 |
| 429 请求过多 | 超出速率限制 |
| 500 内部服务器错误 | 服务器错误,请重试 |
代码示例
以下是不同编程语言的示例:
JavaScript (Node.js)
const FormData = require('form-data');
const fs = require('fs');
const axios = require('axios');
const formData = new FormData();
formData.append('file', fs.createReadStream('input.jpg'));
formData.append('target_format', 'png');
axios.post('https://api.1-converter.com/api/v1/convert/upload', formData, {
headers: {
...formData.getHeaders(),
'Authorization': 'Bearer YOUR_API_KEY'
}
}).then(response => {
console.log(response.data);
}).catch(error => {
console.error(error);
});Python
import requests
url = 'https://api.1-converter.com/api/v1/convert/upload'
headers = {'Authorization': 'Bearer YOUR_API_KEY'}
files = {'file': open('input.jpg', 'rb')}
data = {'target_format': 'png'}
response = requests.post(url, headers=headers, files=files, data=data)
print(response.json())卷曲
curl -X POST https://api.1-converter.com/api/v1/convert/upload \
-H "X-API-Key: YOUR_API_KEY" \
-F "[email protected]" \
-F "target_format=png"需要帮助吗?
请求失败的原因在文档中找不到?请把请求和收到的响应发给我们。