文件

上传文件

post /v1/files

上传文件

请求头参数

• "anthropic-beta": optional array of AnthropicBeta

  可选的请求头，用于指定要使用的 beta 版本。

  • string

  • "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 22 more

    • "message-batches-2024-09-24"

    • "prompt-caching-2024-07-31"

    • "computer-use-2024-10-22"

    • "computer-use-2025-01-24"

    • "pdfs-2024-09-25"

    • "token-counting-2024-11-01"

    • "token-efficient-tools-2025-02-19"

    • "output-128k-2025-02-19"

    • "files-api-2025-04-14"

    • "mcp-client-2025-04-04"

    • "mcp-client-2025-11-20"

    • "dev-full-thinking-2025-05-14"

    • "interleaved-thinking-2025-05-14"

    • "code-execution-2025-05-22"

    • "extended-cache-ttl-2025-04-11"

    • "context-1m-2025-08-07"

    • "context-management-2025-06-27"

    • "model-context-window-exceeded-2025-08-26"

    • "skills-2025-10-02"

    • "fast-mode-2026-02-01"

    • "output-300k-2026-03-24"

    • "user-profiles-2026-03-24"

    • "advisor-tool-2026-03-01"

    • "managed-agents-2026-04-01"

    • "cache-diagnosis-2026-04-07"

返回值

• FileMetadata object { id, created_at, filename, 5 more }

  • id: string

    唯一对象标识符。

    ID 的格式和长度可能会随时间变化。

  • created_at: string

    表示文件创建时间的 RFC 3339 日期时间字符串。

  • filename: string

    上传文件的原始文件名。

  • mime_type: string

    文件的 MIME 类型。

  • size_bytes: number

    文件大小（以字节为单位）。

  • type: "file"

    对象类型。

    对于文件，始终为 "file"。

    • "file"

  • downloadable: optional boolean

    文件是否可下载。

  • scope: optional BetaFileScope

    此文件的作用域，指示其创建时的上下文（例如会话）。

    • id: string

      作用域资源的 ID（例如会话 ID）。

    • type: "session"

      作用域类型（例如 "session"）。

      • "session"

示例

curl https://api.anthropic.com/v1/files \
    -H 'Content-Type: multipart/form-data' \
    -H 'anthropic-version: 2023-06-01' \
    -H 'anthropic-beta: files-api-2025-04-14' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY" \
    -F 'file=@/path/to/file'

响应

{
  "id": "file_011CNha8iCJcU1wXNR6q4V8w",
  "created_at": "2025-04-15T18:37:24.100435Z",
  "filename": "document.pdf",
  "mime_type": "application/pdf",
  "size_bytes": 102400,
  "type": "file",
  "downloadable": false,
  "scope": {
    "id": "id",
    "type": "session"
  }
}

列出文件

get /v1/files

列出文件

查询参数

• after_id: optional string

  用作分页游标的对象 ID。提供时，返回此对象之后的结果页。

• before_id: optional string

  用作分页游标的对象 ID。提供时，返回此对象之前的结果页。

• limit: optional number

  每页返回的项目数量。

  默认为 20。范围从 1 到 1000。

• scope_id: optional string

  按作用域 ID 筛选。仅返回与指定作用域关联的文件（例如会话 ID）。

请求头参数

• "anthropic-beta": optional array of AnthropicBeta

  可选的请求头，用于指定要使用的 beta 版本。

  • string

  • "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 22 more

    • "message-batches-2024-09-24"

    • "prompt-caching-2024-07-31"

    • "computer-use-2024-10-22"

    • "computer-use-2025-01-24"

    • "pdfs-2024-09-25"

    • "token-counting-2024-11-01"

    • "token-efficient-tools-2025-02-19"

    • "output-128k-2025-02-19"

    • "files-api-2025-04-14"

    • "mcp-client-2025-04-04"

    • "mcp-client-2025-11-20"

    • "dev-full-thinking-2025-05-14"

    • "interleaved-thinking-2025-05-14"

    • "code-execution-2025-05-22"

    • "extended-cache-ttl-2025-04-11"

    • "context-1m-2025-08-07"

    • "context-management-2025-06-27"

    • "model-context-window-exceeded-2025-08-26"

    • "skills-2025-10-02"

    • "fast-mode-2026-02-01"

    • "output-300k-2026-03-24"

    • "user-profiles-2026-03-24"

    • "advisor-tool-2026-03-01"

    • "managed-agents-2026-04-01"

    • "cache-diagnosis-2026-04-07"

返回值

• data: array of FileMetadata

  文件元数据对象列表。

  • id: string

    唯一对象标识符。

    ID 的格式和长度可能会随时间变化。

  • created_at: string

    表示文件创建时间的 RFC 3339 日期时间字符串。

  • filename: string

    上传文件的原始文件名。

  • mime_type: string

    文件的 MIME 类型。

  • size_bytes: number

    文件大小（以字节为单位）。

  • type: "file"

    对象类型。

    对于文件，始终为 "file"。

    • "file"

  • downloadable: optional boolean

    文件是否可下载。

  • scope: optional BetaFileScope

    此文件的作用域，指示其创建时的上下文（例如会话）。

    • id: string

      作用域资源的 ID（例如会话 ID）。

    • type: "session"

      作用域类型（例如 "session"）。

      • "session"

• first_id: optional string

  此结果页中第一个文件的 ID。

• has_more: optional boolean

  是否还有更多可用结果。

• last_id: optional string

  此结果页中最后一个文件的 ID。

示例

curl https://api.anthropic.com/v1/files \
    -H 'anthropic-version: 2023-06-01' \
    -H 'anthropic-beta: files-api-2025-04-14' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

响应

{
  "data": [
    {
      "id": "file_011CNha8iCJcU1wXNR6q4V8w",
      "created_at": "2025-04-15T18:37:24.100435Z",
      "filename": "document.pdf",
      "mime_type": "application/pdf",
      "size_bytes": 102400,
      "type": "file",
      "downloadable": false,
      "scope": {
        "id": "id",
        "type": "session"
      }
    }
  ],
  "first_id": "file_011CNha8iCJcU1wXNR6q4V8w",
  "has_more": true,
  "last_id": "file_013Zva2CMHLNnXjNJJKqJ2EF"
}

下载文件

get /v1/files/{file_id}/content

下载文件

路径参数

• file_id: string

  文件的 ID。

请求头参数

• "anthropic-beta": optional array of AnthropicBeta

  可选的请求头，用于指定要使用的 beta 版本。

  • string

  • "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 22 more

    • "message-batches-2024-09-24"

    • "prompt-caching-2024-07-31"

    • "computer-use-2024-10-22"

    • "computer-use-2025-01-24"

    • "pdfs-2024-09-25"

    • "token-counting-2024-11-01"

    • "token-efficient-tools-2025-02-19"

    • "output-128k-2025-02-19"

    • "files-api-2025-04-14"

    • "mcp-client-2025-04-04"

    • "mcp-client-2025-11-20"

    • "dev-full-thinking-2025-05-14"

    • "interleaved-thinking-2025-05-14"

    • "code-execution-2025-05-22"

    • "extended-cache-ttl-2025-04-11"

    • "context-1m-2025-08-07"

    • "context-management-2025-06-27"

    • "model-context-window-exceeded-2025-08-26"

    • "skills-2025-10-02"

    • "fast-mode-2026-02-01"

    • "output-300k-2026-03-24"

    • "user-profiles-2026-03-24"

    • "advisor-tool-2026-03-01"

    • "managed-agents-2026-04-01"

    • "cache-diagnosis-2026-04-07"

示例

curl https://api.anthropic.com/v1/files/$FILE_ID/content \
    -H 'anthropic-version: 2023-06-01' \
    -H 'anthropic-beta: files-api-2025-04-14' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

获取文件元数据

get /v1/files/{file_id}

获取文件元数据

路径参数

• file_id: string

  文件的 ID。

请求头参数

• "anthropic-beta": optional array of AnthropicBeta

  可选的请求头，用于指定要使用的 beta 版本。

  • string

  • "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 22 more

    • "message-batches-2024-09-24"

    • "prompt-caching-2024-07-31"

    • "computer-use-2024-10-22"

    • "computer-use-2025-01-24"

    • "pdfs-2024-09-25"

    • "token-counting-2024-11-01"

    • "token-efficient-tools-2025-02-19"

    • "output-128k-2025-02-19"

    • "files-api-2025-04-14"

    • "mcp-client-2025-04-04"

    • "mcp-client-2025-11-20"

    • "dev-full-thinking-2025-05-14"

    • "interleaved-thinking-2025-05-14"

    • "code-execution-2025-05-22"

    • "extended-cache-ttl-2025-04-11"

    • "context-1m-2025-08-07"

    • "context-management-2025-06-27"

    • "model-context-window-exceeded-2025-08-26"

    • "skills-2025-10-02"

    • "fast-mode-2026-02-01"

    • "output-300k-2026-03-24"

    • "user-profiles-2026-03-24"

    • "advisor-tool-2026-03-01"

    • "managed-agents-2026-04-01"

    • "cache-diagnosis-2026-04-07"

返回值

• FileMetadata object { id, created_at, filename, 5 more }

  • id: string

    唯一对象标识符。

    ID 的格式和长度可能会随时间变化。

  • created_at: string

    表示文件创建时间的 RFC 3339 日期时间字符串。

  • filename: string

    上传文件的原始文件名。

  • mime_type: string

    文件的 MIME 类型。

  • size_bytes: number

    文件大小（以字节为单位）。

  • type: "file"

    对象类型。

    对于文件，始终为 "file"。

    • "file"

  • downloadable: optional boolean

    文件是否可下载。

  • scope: optional BetaFileScope

    此文件的作用域，指示其创建时的上下文（例如会话）。

    • id: string

      作用域资源的 ID（例如会话 ID）。

    • type: "session"

      作用域类型（例如 "session"）。

      • "session"

示例

curl https://api.anthropic.com/v1/files/$FILE_ID \
    -H 'anthropic-version: 2023-06-01' \
    -H 'anthropic-beta: files-api-2025-04-14' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

响应

{
  "id": "file_011CNha8iCJcU1wXNR6q4V8w",
  "created_at": "2025-04-15T18:37:24.100435Z",
  "filename": "document.pdf",
  "mime_type": "application/pdf",
  "size_bytes": 102400,
  "type": "file",
  "downloadable": false,
  "scope": {
    "id": "id",
    "type": "session"
  }
}

删除文件

delete /v1/files/{file_id}

删除文件

路径参数

• file_id: string

  文件的 ID。

请求头参数

• "anthropic-beta": optional array of AnthropicBeta

  可选的请求头，用于指定要使用的 beta 版本。

  • string

  • "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 22 more

    • "message-batches-2024-09-24"

    • "prompt-caching-2024-07-31"

    • "computer-use-2024-10-22"

    • "computer-use-2025-01-24"

    • "pdfs-2024-09-25"

    • "token-counting-2024-11-01"

    • "token-efficient-tools-2025-02-19"

    • "output-128k-2025-02-19"

    • "files-api-2025-04-14"

    • "mcp-client-2025-04-04"

    • "mcp-client-2025-11-20"

    • "dev-full-thinking-2025-05-14"

    • "interleaved-thinking-2025-05-14"

    • "code-execution-2025-05-22"

    • "extended-cache-ttl-2025-04-11"

    • "context-1m-2025-08-07"

    • "context-management-2025-06-27"

    • "model-context-window-exceeded-2025-08-26"

    • "skills-2025-10-02"

    • "fast-mode-2026-02-01"

    • "output-300k-2026-03-24"

    • "user-profiles-2026-03-24"

    • "advisor-tool-2026-03-01"

    • "managed-agents-2026-04-01"

    • "cache-diagnosis-2026-04-07"

返回值

• DeletedFile object { id, type }

  • id: string

    已删除文件的 ID。

  • type: optional "file_deleted"

    已删除对象的类型。

    对于文件删除，始终为 "file_deleted"。

    • "file_deleted"

示例

curl https://api.anthropic.com/v1/files/$FILE_ID \
    -X DELETE \
    -H 'anthropic-version: 2023-06-01' \
    -H 'anthropic-beta: files-api-2025-04-14' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

响应

{
  "id": "file_011CNha8iCJcU1wXNR6q4V8w",
  "type": "file_deleted"
}

领域类型

Beta 文件作用域

• BetaFileScope object { id, type }

  • id: string

    作用域资源的 ID（例如会话 ID）。

  • type: "session"

    作用域类型（例如 "session"）。

    • "session"

已删除文件

• DeletedFile object { id, type }

  • id: string

    已删除文件的 ID。

  • type: optional "file_deleted"

    已删除对象的类型。

    对于文件删除，始终为 "file_deleted"。

    • "file_deleted"

文件元数据

• FileMetadata object { id, created_at, filename, 5 more }

  • id: string

    唯一对象标识符。

    ID 的格式和长度可能会随时间变化。

  • created_at: string

    表示文件创建时间的 RFC 3339 日期时间字符串。

  • filename: string

    上传文件的原始文件名。

  • mime_type: string

    文件的 MIME 类型。

  • size_bytes: number

    文件大小（以字节为单位）。

  • type: "file"

    对象类型。

    对于文件，始终为 "file"。

    • "file"

  • downloadable: optional boolean

    文件是否可下载。

  • scope: optional BetaFileScope

    此文件的作用域，指示其创建时的上下文（例如会话）。

    • id: string

      作用域资源的 ID（例如会话 ID）。

    • type: "session"

      作用域类型（例如 "session"）。

      • "session"