API文档

使用我们的 RESTful API 将强大的文件转换功能集成到您的应用程序中

bolt

快如闪电

通过优化处理实现高性能转换

shield

安全可靠

企业级安全性和 99.9% 的正常运行时间

trending_up

可扩展

从原型到生产,我们与您一起扩展

terminal入门

要使用 1converter API,请按照以下简单步骤操作:

  1. 在 1converter.com 注册免费帐户
  2. 从您的仪表板生成 API 密钥
  3. 开始使用您的 API 密钥发出 API 请求

key验证

所有 API 请求都必须在授权标头中包含您的 API 密钥:

X-API-Key: YOUR_API_KEY Authorization: Bearer YOUR_API_KEY

注意:切勿共享您的 API 密钥或将其提交给版本控制。

确保您的 API 密钥安全,切勿在客户端代码中公开它。

基本网址

所有 API 请求均应发送至:

https://api.1-converter.com/api/v1

OpenAPI 3.1 specification (JSON)

codeAPI端点

上传和转换

上传文件并将其转换为指定格式

POST/api/v1/convert/upload

请求标头

Content-Type: multipart/form-data
Authorization: Bearer YOUR_API_KEY

请求正文

  • 要转换的文件(必需)
  • 目标格式(例如“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 需要付费套餐:

计划速率限制
自由的不可用 — 需要升级
起动机5,000 次请求/分钟
专业版5,000 次请求/分钟
商业无限

当超出速率限制时,您将收到 429 Too Many Requests 响应。

错误代码

API 使用标准 HTTP 状态代码来指示成功或失败:

代码描述
400 错误请求请求参数无效
401 未经授权API 密钥无效或丢失
403 禁忌权限不足
404 未找到找不到资源
429 请求过多超出速率限制
500 内部服务器错误服务器错误,请重试

integration_instructions代码示例

以下是不同编程语言的示例:

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"

需要帮助吗?

如果您对 API 有疑问或需要帮助,我们随时为您提供帮助!