# Files ## Upload File `FileMetadata beta().files().upload(FileUploadParamsparams, RequestOptionsrequestOptions = RequestOptions.none())` **post** `/v1/files` Upload File ### Parameters - `FileUploadParams params` - `Optional> betas` Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` - `String file` The file to upload ### Returns - `class FileMetadata:` - `String id` Unique object identifier. The format and length of IDs may change over time. - `LocalDateTime createdAt` RFC 3339 datetime string representing when the file was created. - `String filename` Original filename of the uploaded file. - `String mimeType` MIME type of the file. - `long sizeBytes` Size of the file in bytes. - `JsonValue; type "file"constant` Object type. For files, this is always `"file"`. - `FILE("file")` - `Optional downloadable` Whether the file can be downloaded. - `Optional scope` The scope of this file, indicating the context in which it was created (e.g., a session). - `String id` The ID of the scoping resource (e.g., the session ID). - `JsonValue; type "session"constant` The type of scope (e.g., `"session"`). - `SESSION("session")` ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.files.FileMetadata; import com.anthropic.models.beta.files.FileUploadParams; import java.io.ByteArrayInputStream; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); FileUploadParams params = FileUploadParams.builder() .file(new ByteArrayInputStream("Example data".getBytes())) .build(); FileMetadata fileMetadata = client.beta().files().upload(params); } } ``` #### Response ```json { "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 `FileListPage beta().files().list(FileListParamsparams = FileListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **get** `/v1/files` List Files ### Parameters - `FileListParams params` - `Optional afterId` ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `Optional beforeId` ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `Optional limit` Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. - `Optional scopeId` Filter by scope ID. Only returns files associated with the specified scope (e.g., a session ID). - `Optional> betas` Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` ### Returns - `class FileMetadata:` - `String id` Unique object identifier. The format and length of IDs may change over time. - `LocalDateTime createdAt` RFC 3339 datetime string representing when the file was created. - `String filename` Original filename of the uploaded file. - `String mimeType` MIME type of the file. - `long sizeBytes` Size of the file in bytes. - `JsonValue; type "file"constant` Object type. For files, this is always `"file"`. - `FILE("file")` - `Optional downloadable` Whether the file can be downloaded. - `Optional scope` The scope of this file, indicating the context in which it was created (e.g., a session). - `String id` The ID of the scoping resource (e.g., the session ID). - `JsonValue; type "session"constant` The type of scope (e.g., `"session"`). - `SESSION("session")` ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.files.FileListPage; import com.anthropic.models.beta.files.FileListParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); FileListPage page = client.beta().files().list(); } } ``` #### Response ```json { "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 `HttpResponse beta().files().download(FileDownloadParamsparams = FileDownloadParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **get** `/v1/files/{file_id}/content` Download File ### Parameters - `FileDownloadParams params` - `Optional fileId` ID of the File. - `Optional> betas` Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.core.http.HttpResponse; import com.anthropic.models.beta.files.FileDownloadParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); HttpResponse response = client.beta().files().download("file_id"); } } ``` ## Get File Metadata `FileMetadata beta().files().retrieveMetadata(FileRetrieveMetadataParamsparams = FileRetrieveMetadataParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **get** `/v1/files/{file_id}` Get File Metadata ### Parameters - `FileRetrieveMetadataParams params` - `Optional fileId` ID of the File. - `Optional> betas` Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` ### Returns - `class FileMetadata:` - `String id` Unique object identifier. The format and length of IDs may change over time. - `LocalDateTime createdAt` RFC 3339 datetime string representing when the file was created. - `String filename` Original filename of the uploaded file. - `String mimeType` MIME type of the file. - `long sizeBytes` Size of the file in bytes. - `JsonValue; type "file"constant` Object type. For files, this is always `"file"`. - `FILE("file")` - `Optional downloadable` Whether the file can be downloaded. - `Optional scope` The scope of this file, indicating the context in which it was created (e.g., a session). - `String id` The ID of the scoping resource (e.g., the session ID). - `JsonValue; type "session"constant` The type of scope (e.g., `"session"`). - `SESSION("session")` ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.files.FileMetadata; import com.anthropic.models.beta.files.FileRetrieveMetadataParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); FileMetadata fileMetadata = client.beta().files().retrieveMetadata("file_id"); } } ``` #### Response ```json { "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 `DeletedFile beta().files().delete(FileDeleteParamsparams = FileDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **delete** `/v1/files/{file_id}` Delete File ### Parameters - `FileDeleteParams params` - `Optional fileId` ID of the File. - `Optional> betas` Optional header to specify the beta version(s) you want to use. - `MESSAGE_BATCHES_2024_09_24("message-batches-2024-09-24")` - `PROMPT_CACHING_2024_07_31("prompt-caching-2024-07-31")` - `COMPUTER_USE_2024_10_22("computer-use-2024-10-22")` - `COMPUTER_USE_2025_01_24("computer-use-2025-01-24")` - `PDFS_2024_09_25("pdfs-2024-09-25")` - `TOKEN_COUNTING_2024_11_01("token-counting-2024-11-01")` - `TOKEN_EFFICIENT_TOOLS_2025_02_19("token-efficient-tools-2025-02-19")` - `OUTPUT_128K_2025_02_19("output-128k-2025-02-19")` - `FILES_API_2025_04_14("files-api-2025-04-14")` - `MCP_CLIENT_2025_04_04("mcp-client-2025-04-04")` - `MCP_CLIENT_2025_11_20("mcp-client-2025-11-20")` - `DEV_FULL_THINKING_2025_05_14("dev-full-thinking-2025-05-14")` - `INTERLEAVED_THINKING_2025_05_14("interleaved-thinking-2025-05-14")` - `CODE_EXECUTION_2025_05_22("code-execution-2025-05-22")` - `EXTENDED_CACHE_TTL_2025_04_11("extended-cache-ttl-2025-04-11")` - `CONTEXT_1M_2025_08_07("context-1m-2025-08-07")` - `CONTEXT_MANAGEMENT_2025_06_27("context-management-2025-06-27")` - `MODEL_CONTEXT_WINDOW_EXCEEDED_2025_08_26("model-context-window-exceeded-2025-08-26")` - `SKILLS_2025_10_02("skills-2025-10-02")` - `FAST_MODE_2026_02_01("fast-mode-2026-02-01")` - `OUTPUT_300K_2026_03_24("output-300k-2026-03-24")` - `USER_PROFILES_2026_03_24("user-profiles-2026-03-24")` - `ADVISOR_TOOL_2026_03_01("advisor-tool-2026-03-01")` - `MANAGED_AGENTS_2026_04_01("managed-agents-2026-04-01")` - `CACHE_DIAGNOSIS_2026_04_07("cache-diagnosis-2026-04-07")` - `THINKING_TOKEN_COUNT_2026_05_13("thinking-token-count-2026-05-13")` ### Returns - `class DeletedFile:` - `String id` ID of the deleted file. - `Optional type` Deleted object type. For file deletion, this is always `"file_deleted"`. - `FILE_DELETED("file_deleted")` ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.beta.files.DeletedFile; import com.anthropic.models.beta.files.FileDeleteParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); DeletedFile deletedFile = client.beta().files().delete("file_id"); } } ``` #### Response ```json { "id": "file_011CNha8iCJcU1wXNR6q4V8w", "type": "file_deleted" } ``` ## Domain Types ### Beta File Scope - `class BetaFileScope:` - `String id` The ID of the scoping resource (e.g., the session ID). - `JsonValue; type "session"constant` The type of scope (e.g., `"session"`). - `SESSION("session")` ### Deleted File - `class DeletedFile:` - `String id` ID of the deleted file. - `Optional type` Deleted object type. For file deletion, this is always `"file_deleted"`. - `FILE_DELETED("file_deleted")` ### File Metadata - `class FileMetadata:` - `String id` Unique object identifier. The format and length of IDs may change over time. - `LocalDateTime createdAt` RFC 3339 datetime string representing when the file was created. - `String filename` Original filename of the uploaded file. - `String mimeType` MIME type of the file. - `long sizeBytes` Size of the file in bytes. - `JsonValue; type "file"constant` Object type. For files, this is always `"file"`. - `FILE("file")` - `Optional downloadable` Whether the file can be downloaded. - `Optional scope` The scope of this file, indicating the context in which it was created (e.g., a session). - `String id` The ID of the scoping resource (e.g., the session ID). - `JsonValue; type "session"constant` The type of scope (e.g., `"session"`). - `SESSION("session")`