Files API

Files API 让您可以上传和管理文件，以便与 Claude API 一起使用，而无需在每次请求时重新上传内容。这在使用代码执行工具提供输入（例如数据集和文档）然后下载输出（例如图表）时特别有用。除了本指南之外，您还可以直接浏览 API 参考。



支持的模型

在 Messages 请求中引用 file_id 在所有支持给定文件类型的模型上均受支持。图像在所有当前的 Claude 模型上均受支持。对于 PDF 和代码执行工具支持的其他文件类型，请参阅链接页面了解模型支持情况。

Files API 可在 Claude API、Claude Platform on AWS 和 Microsoft Foundry 上使用。在 Microsoft Foundry 上，Files API 需要 Hosted on Anthropic 部署。目前在 Amazon Bedrock 或 Google Cloud 上不可用。



Files API 的工作原理

Files API 提供了一种一次创建、多次使用的文件处理方式：

• 上传文件到 Anthropic 的安全存储并获得唯一的 file_id
• 下载文件，即由技能或代码执行工具创建的文件
• 在 Messages 请求中使用 file_id 引用文件，而无需重新上传内容
• 通过列出、检索和删除操作管理您的文件



如何使用 Files API



上传文件

上传文件以便在未来的 API 调用中引用：

uploaded = client.beta.files.upload(
    file=("document.pdf", open("/path/to/document.pdf", "rb"), "application/pdf"),
)
file_id = uploaded.id
print(file_id)

上传文件的响应包括：

{
  "id": "file_011CNha8iCJcU1wXNR6q4V8w",
  "type": "file",
  "filename": "document.pdf",
  "mime_type": "application/pdf",
  "size_bytes": 1024000,
  "created_at": "2025-01-01T00:00:00Z",
  "downloadable": false
}

对于您上传的文件，downloadable 为 false。只有由技能或代码执行工具创建的文件才能被下载。请参阅下载文件。



在消息中使用文件

上传后，通过将上传响应中的 id 作为 file_id 传递来引用该文件：

response = client.beta.messages.create(
    model="claude-opus-5",
    max_tokens=1024,
    messages=[
        {
            "role": "user",
            "content": [
                {"type": "text", "text": "Please summarize this document for me."},
                {
                    "type": "document",
                    "source": {
                        "type": "file",
                        "file_id": file_id,
                    },
                },
            ],
        }
    ],
    betas=["files-api-2025-04-14"],
)
print(response)



文件类型和内容块

Files API 支持不同的文件类型，它们对应不同的内容块类型：



文档块

对于 PDF 和文本文件，使用 document 内容块：

{
  "type": "document",
  "source": {
    "type": "file",
    "file_id": "file_011CNha8iCJcU1wXNR6q4V8w"
  },
  "title": "Document Title", // Optional
  "context": "Context about the document", // Optional
  "citations": { "enabled": true } // Optional, enables citations
}



图像块

对于图像，使用 image 内容块：

{
  "type": "image",
  "source": {
    "type": "file",
    "file_id": "file_011CPMxVD3fHLUhvTqtsQA5w"
  }
}



容器上传块

要将文件发送到代码执行工具，请使用 container_upload 内容块：

{
  "type": "container_upload",
  "file_id": "file_011CNha8iCJcU1wXNR6q4V8w"
}



处理其他文件格式

对于 document 块不支持的文件类型（例如 .docx 和 .xlsx），请将文件转换为纯文本并将内容直接包含在您的消息中。已经是纯文本的文件（如 .csv 和 .md 文件）既可以通过这种方式读取，也可以通过 Files API 以显式的 text/plain 内容类型上传。如果要分析数据集而不是将其作为文本读取，请使用 container_upload 块将它们上传给代码执行工具。

以下示例读取一个文本文件并将其内容作为纯文本发送：

client = anthropic.Anthropic()

# 读取文本文件
with open("document.txt") as f:
    text_content = f.read()

response = client.messages.create(
    model="claude-opus-5",
    max_tokens=1024,
    messages=[
        {
            "role": "user",
            "content": [
                {
                    "type": "text",
                    "text": f"Here's the document content:\n\n{text_content}\n\nPlease summarize this document.",
                }
            ],
        }
    ],
)

for block in response.content:
    if block.type == "text":
        print(block.text)



管理文件



列出文件

检索您已上传文件的列表。该端点是分页的：每个请求最多返回 limit 个文件（默认为 20 个），before_id 和 after_id 参数用于获取相邻页面。请参阅 List Files API 参考。SDK 返回第一页并提供自动分页辅助工具。CLI 示例使用 --max-items 限制总数：

client = anthropic.Anthropic()
files = client.beta.files.list()
print(files)



获取文件元数据

检索特定文件的信息：

file = client.beta.files.retrieve_metadata(file_id)
print(file)



删除文件

从您的工作区中移除文件：

client.beta.files.delete(file_id)



下载文件

下载由技能或代码执行工具创建的文件。您上传的文件无法下载。生成文件的 file_id 会出现在创建它的 Messages 响应的 bash_code_execution_tool_result 内容块中：

file_content = client.beta.files.download(file_id)

file_content.write_to_file("downloaded_file.txt")



文件存储和限制



存储限制

• **最大文件大小：**每个文件 500 MB
• **总存储量：**每个组织 500 GB



文件生命周期

• 文件的作用域限定于上传它们的 API 密钥所在的工作区。同一工作区中的任何 API 密钥都可以引用它们
• 文件上传后无法修改或重命名。要更改文件内容，请上传新文件并删除旧文件
• 文件会一直保留，直到您使用 DELETE /v1/files/{file_id} 端点删除它们
• 已删除的文件无法恢复
• 文件在删除后不久即无法通过 API 访问，但它们可能会在活跃的 Messages API 调用和相关的工具使用中继续存在
• 用户删除的文件将根据 Anthropic 的数据保留政策被删除。有关所有功能的 ZDR 资格，请参阅 API 和数据保留



错误处理

使用 Files API 时的常见错误包括：

• **文件未找到（404）：**指定的 file_id 不存在或您无权访问它
• **无效的文件类型（400）：**文件类型与内容块类型不匹配（例如，在文档块中使用图像文件）
• **不可下载（400）：**您上传的文件具有 "downloadable": false 且无法下载。只有由技能或代码执行工具创建的文件才能被下载
• **超出上下文窗口大小（400）：**文件大于上下文窗口大小（例如，在 /v1/messages 请求中使用 500 MB 的纯文本文件）
• **无效的文件名（400）：**文件名不符合长度要求（1-255 个字符）或包含禁止的字符（<、>、:、"、|、?、*、\、/ 或 Unicode 字符 0-31）
• **文件过大（413）：**文件超过 500 MB 限制
• **超出存储限制（400）：**您的组织已达到 500 GB 存储限制

{
  "type": "error",
  "error": {
    "type": "not_found_error",
    "message": "File `file_011CNha8iCJcU1wXNR6q4V8w` not found."
  },
  "request_id": "req_011CQFYcrRp7mCHLDsAYT8Qt"
}



使用量和计费

Files API 操作是免费的：

• 上传文件
• 下载文件
• 列出文件
• 获取文件元数据
• 删除文件

在 Messages 请求中使用的文件内容按输入令牌计费。



速率限制

在测试期间：

• 与文件相关的 API 调用限制为每分钟约 100 个请求
• 如果您的使用场景需要更高的限制，请联系我们



后续步骤