文件Files

文件用于上传文档，可与Fine-tuning等功能配合使用。

文件列表List files

get https://api.openai.com/v1/files (opens in a new tab)

返回属于用户组织的文件列表。

请求示例（Python方式）

curl https://api.openai.com/v1/files 
  -H "Authorization: Bearer $OPENAI_API_KEY"

响应体（Response）

{
 "data": [
    {
 "id": "file-ccdDZrC3iZVNiQVeEA6Z66wf",
 "object": "file",
 "bytes": 175,
 "created_at": 1613677385,
 "filename": "train.jsonl",
 "purpose": "search"
    },
    {
 "id": "file-XjGxS3KTG0uNmNOK362iJua3",
 "object": "file",
 "bytes": 140,
 "created_at": 1613779121,
 "filename": "puppy.jsonl",
 "purpose": "search"
    }
  ],
 "object": "list"
}

上传Upload filepost https://api.openai.com/v1/files (opens in a new tab)

上传包含要在各种端点/功能中使用的文档的文件。目前，一个组织上传的所有文件的大小可以高达1 GB。如果需要增加存储限制，请联系我们。

请求正文

file 是字符串类型的必填项，表示要上传的 JSON Lines 文件的名称。JSON Lines 是一种格式，详见官方文档 (opens in a new tab)。

如果 purpose 设置为"fine-tune"，每行是一个 JSON 记录，其中包含 "prompt" 和 "completion" 字段，表示训练示例。

purpose 是字符串类型的必填项，表示上传文档的预期用途。使用 "fine-tune" 进行 Fine-tuning。这可以验证上传文件的格式。

请求示例（Python方式）

curl https://api.openai.com/v1/files 
  -H "Authorization: Bearer $OPENAI_API_KEY" 
  -F purpose="fine-tune" 
  -F file="@mydata.jsonl"

响应体（Response）

 {
 "id": "file-XjGxS3KTG0uNmNOK362iJua3",
 "object": "file",
 "bytes": 140,
 "created_at": 1613779121,
 "filename": "mydata.jsonl",
 "purpose": "fine-tune"
}

删除文件Delete filedelete https://api.openai.com/v1/files/{file_id} (opens in a new tab)

删除文件。

路径参数

file_id字符串类型，必填项。用于此请求的文件的ID。

请求示例（Python方式）

curl https://api.openai.com/v1/files/file-XjGxS3KTG0uNmNOK362iJua3 
  -X DELETE 
  -H "Authorization: Bearer $OPENAI_API_KEY"

响应体（Response）

 {
 "id": "file-XjGxS3KTG0uNmNOK362iJua3",
 "object": "file",
 "deleted": true
}

返回有关特定文件Retrieve file

get https://api.openai.com/v1/files/{file_id} (opens in a new tab)

返回有关特定文件的信息。

路径参数

file_id字符串类型，必填项。用于此请求的文件的ID。

请求示例（Python方式）

curl https://api.openai.com/v1/files/file-XjGxS3KTG0uNmNOK362iJua3 
  -H "Authorization: Bearer $OPENAI_API_KEY"

响应体（Response）

 {
 "id": "file-XjGxS3KTG0uNmNOK362iJua3",
 "object": "file",
 "bytes": 140,
 "created_at": 1613779657,
 "filename": "mydata.jsonl",
 "purpose": "fine-tune"
}

返回指定文件的内容Retrieve file content

get https://api.openai.com/v1/files/{file_id}/content (opens in a new tab)

返回指定文件的内容。

路径参数

file_id字符串类型，必填项。用于此请求的文件的ID。

请求示例（Python方式）

curl https://api.openai.com/v1/files/file-XjGxS3KTG0uNmNOK362iJua3/content 
  -H "Authorization: Bearer $OPENAI_API_KEY" > file.jsonl

音频（Audio）微调（Fine-Tunes）