中文 ← MyDocs

Files

Upload File

post /v1/files

Upload File

Header Parameters

  • "anthropic-beta": optional array of AnthropicBeta

    Optional header to specify the beta version(s) you want to use.

    • 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"

Returns

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

    • id: string

      Unique object identifier.

      The format and length of IDs may change over time.

    • created_at: string

      RFC 3339 datetime string representing when the file was created.

    • filename: string

      Original filename of the uploaded file.

    • mime_type: string

      MIME type of the file.

    • size_bytes: number

      Size of the file in bytes.

    • type: "file"

      Object type.

      For files, this is always "file".

      • "file"

    • downloadable: optional boolean

      Whether the file can be downloaded.

    • scope: optional BetaFileScope

      The scope of this file, indicating the context in which it was created (e.g., a session).

      • id: string

        The ID of the scoping resource (e.g., the session ID).

      • type: "session"

        The type of scope (e.g., "session").

        • "session"

Example

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'

Response

{
  "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"
  }
}

List Files

get /v1/files

List Files

Query Parameters

  • after_id: optional string

    ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.

  • before_id: optional string

    ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.

  • limit: optional number

    Number of items to return per page.

    Defaults to 20. Ranges from 1 to 1000.

  • scope_id: optional string

    Filter by scope ID. Only returns files associated with the specified scope (e.g., a session ID).

Header Parameters

  • "anthropic-beta": optional array of AnthropicBeta

    Optional header to specify the beta version(s) you want to use.

    • 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"

Returns

  • data: array of FileMetadata

    List of file metadata objects.

    • id: string

      Unique object identifier.

      The format and length of IDs may change over time.

    • created_at: string

      RFC 3339 datetime string representing when the file was created.

    • filename: string

      Original filename of the uploaded file.

    • mime_type: string

      MIME type of the file.

    • size_bytes: number

      Size of the file in bytes.

    • type: "file"

      Object type.

      For files, this is always "file".

      • "file"

    • downloadable: optional boolean

      Whether the file can be downloaded.

    • scope: optional BetaFileScope

      The scope of this file, indicating the context in which it was created (e.g., a session).

      • id: string

        The ID of the scoping resource (e.g., the session ID).

      • type: "session"

        The type of scope (e.g., "session").

        • "session"

  • first_id: optional string

    ID of the first file in this page of results.

  • has_more: optional boolean

    Whether there are more results available.

  • last_id: optional string

    ID of the last file in this page of results.

Example

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"

Response

{
  "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"
}

Download File

get /v1/files/{file_id}/content

Download File

Path Parameters

  • file_id: string

    ID of the File.

Header Parameters

  • "anthropic-beta": optional array of AnthropicBeta

    Optional header to specify the beta version(s) you want to use.

    • 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"

Example

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 File Metadata

get /v1/files/{file_id}

Get File Metadata

Path Parameters

  • file_id: string

    ID of the File.

Header Parameters

  • "anthropic-beta": optional array of AnthropicBeta

    Optional header to specify the beta version(s) you want to use.

    • 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"

Returns

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

    • id: string

      Unique object identifier.

      The format and length of IDs may change over time.

    • created_at: string

      RFC 3339 datetime string representing when the file was created.

    • filename: string

      Original filename of the uploaded file.

    • mime_type: string

      MIME type of the file.

    • size_bytes: number

      Size of the file in bytes.

    • type: "file"

      Object type.

      For files, this is always "file".

      • "file"

    • downloadable: optional boolean

      Whether the file can be downloaded.

    • scope: optional BetaFileScope

      The scope of this file, indicating the context in which it was created (e.g., a session).

      • id: string

        The ID of the scoping resource (e.g., the session ID).

      • type: "session"

        The type of scope (e.g., "session").

        • "session"

Example

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"

Response

{
  "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 File

delete /v1/files/{file_id}

Delete File

Path Parameters

  • file_id: string

    ID of the File.

Header Parameters

  • "anthropic-beta": optional array of AnthropicBeta

    Optional header to specify the beta version(s) you want to use.

    • 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"

Returns

  • DeletedFile object { id, type }

    • id: string

      ID of the deleted file.

    • type: optional "file_deleted"

      Deleted object type.

      For file deletion, this is always "file_deleted".

      • "file_deleted"

Example

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"

Response

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

Domain Types

Beta File Scope

  • BetaFileScope object { id, type }

    • id: string

      The ID of the scoping resource (e.g., the session ID).

    • type: "session"

      The type of scope (e.g., "session").

      • "session"

Deleted File

  • DeletedFile object { id, type }

    • id: string

      ID of the deleted file.

    • type: optional "file_deleted"

      Deleted object type.

      For file deletion, this is always "file_deleted".

      • "file_deleted"

File Metadata

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

    • id: string

      Unique object identifier.

      The format and length of IDs may change over time.

    • created_at: string

      RFC 3339 datetime string representing when the file was created.

    • filename: string

      Original filename of the uploaded file.

    • mime_type: string

      MIME type of the file.

    • size_bytes: number

      Size of the file in bytes.

    • type: "file"

      Object type.

      For files, this is always "file".

      • "file"

    • downloadable: optional boolean

      Whether the file can be downloaded.

    • scope: optional BetaFileScope

      The scope of this file, indicating the context in which it was created (e.g., a session).

      • id: string

        The ID of the scoping resource (e.g., the session ID).

      • type: "session"

        The type of scope (e.g., "session").

        • "session"