Skip to content

参考数据:Files API 参考 — TypeScript

Data: Files API reference — TypeScript

v2.1.63

TypeScript Files API reference including file upload, listing, deletion, and usage in messages

Files API — TypeScript

Files API 用于上传文件,以便在 Messages API 请求中使用。通过内容块中的 file_id 引用文件,避免在多次 API 调用中重复上传。

Beta 版本: 在您的 API 调用中传递 betas: ["files-api-2025-04-14"](SDK 会自动设置所需的请求头)。

关键信息

  • 最大文件大小:500 MB
  • 总存储空间:每个组织 100 GB
  • 文件将持久保存,直到被删除
  • 文件操作(上传、列出、删除)免费;在消息中使用的内容将按输入 token 计费
  • 在 Amazon Bedrock 或 Google Vertex AI 上不可用

上传文件

typescript
import Anthropic, { toFile } from "@anthropic-ai/sdk";
import fs from "fs";

const client = new Anthropic();

const uploaded = await client.beta.files.upload({
  file: await toFile(fs.createReadStream("report.pdf"), undefined, {
    type: "application/pdf",
  }),
  betas: ["files-api-2025-04-14"],
});

console.log(`File ID: \${uploaded.id}`);
console.log(`Size: \${uploaded.size_bytes} bytes`);

在消息中使用文件

PDF / 文本文档

typescript
const response = await client.beta.messages.create({
  model: "{\{OPUS_ID}\}",
  max_tokens: 1024,
  messages: [
    {
      role: "user",
      content: [
        { type: "text", text: "Summarize the key findings in this report." },
        {
          type: "document",
          source: { type: "file", file_id: uploaded.id },
          title: "Q4 Report",
          citations: { enabled: true },
        },
      ],
    },
  ],
  betas: ["files-api-2025-04-14"],
});

console.log(response.content[0].text);

管理文件

列出文件

typescript
const files = await client.beta.files.list({
  betas: ["files-api-2025-04-14"],
});
for (const f of files.data) {
  console.log(`\${f.id}: \${f.filename} (\${f.size_bytes} bytes)`);
}

删除文件

typescript
await client.beta.files.delete("file_011CNha8iCJcU1wXNR6q4V8w", {
  betas: ["files-api-2025-04-14"],
});

下载文件

typescript
const response = await client.beta.files.download(
  "file_011CNha8iCJcU1wXNR6q4V8w",
  { betas: ["files-api-2025-04-14"] },
);
const content = Buffer.from(await response.arrayBuffer());
await fs.promises.writeFile("output.txt", content);

英文原文 / English Original

Files API — TypeScript

The Files API uploads files for use in Messages API requests. Reference files via file_id in content blocks, avoiding re-uploads across multiple API calls.

Beta: Pass betas: ["files-api-2025-04-14"] in your API calls (the SDK sets the required header automatically).

Key Facts

  • Maximum file size: 500 MB
  • Total storage: 100 GB per organization
  • Files persist until deleted
  • File operations (upload, list, delete) are free; content used in messages is billed as input tokens
  • Not available on Amazon Bedrock or Google Vertex AI

Upload a File

typescript
import Anthropic, { toFile } from "@anthropic-ai/sdk";
import fs from "fs";

const client = new Anthropic();

const uploaded = await client.beta.files.upload({
  file: await toFile(fs.createReadStream("report.pdf"), undefined, {
    type: "application/pdf",
  }),
  betas: ["files-api-2025-04-14"],
});

console.log(`File ID: \${uploaded.id}`);
console.log(`Size: \${uploaded.size_bytes} bytes`);

Use a File in Messages

PDF / Text Document

typescript
const response = await client.beta.messages.create({
  model: "{\{OPUS_ID}\}",
  max_tokens: 1024,
  messages: [
    {
      role: "user",
      content: [
        { type: "text", text: "Summarize the key findings in this report." },
        {
          type: "document",
          source: { type: "file", file_id: uploaded.id },
          title: "Q4 Report",
          citations: { enabled: true },
        },
      ],
    },
  ],
  betas: ["files-api-2025-04-14"],
});

console.log(response.content[0].text);

Manage Files

List Files

typescript
const files = await client.beta.files.list({
  betas: ["files-api-2025-04-14"],
});
for (const f of files.data) {
  console.log(`\${f.id}: \${f.filename} (\${f.size_bytes} bytes)`);
}

Delete a File

typescript
await client.beta.files.delete("file_011CNha8iCJcU1wXNR6q4V8w", {
  betas: ["files-api-2025-04-14"],
});

Download a File

typescript
const response = await client.beta.files.download(
  "file_011CNha8iCJcU1wXNR6q4V8w",
  { betas: ["files-api-2025-04-14"] },
);
const content = Buffer.from(await response.arrayBuffer());
await fs.promises.writeFile("output.txt", content);