--- title: Files url: https://platform.claude.com/docs/en/api/java/files --- # Files ## Upload File `FileMetadata files().upload(params, requestOptions = RequestOptions.none())` **POST** `/v1/files` Upload File ### Parameters - `FileUploadParams params` - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. - `String file` The file to upload. Only the final path component of the part's `filename` is kept; an absent or empty `filename` is replaced with `unnamed` plus the extension for the file's stored `mime_type`, when known. format: binary - `Optional expiresInSeconds` Seconds from upload until the file expires and its bytes become permanently unavailable. Must be between 3600 (one hour) and 7776000 (ninety days). minimum: 3600, maximum: 7776000 ### Returns - `class FileMetadata` - `JsonValue type = "file"` Object type. For files, this is always `"file"`. - `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. format: date-time - `String filename` Original filename of the uploaded file. minLength: 1, maxLength: 500 - `String mimeType` MIME type of the file. minLength: 1, maxLength: 255 - `long sizeBytes` Size of the file in bytes. minimum: 0 - `Optional downloadable` Whether the file can be downloaded. - `Optional expiresAt` RFC 3339 datetime string representing when the file will expire and become unavailable for download. Null if the file does not expire. For files uploaded with `expires_in_seconds`, this is the upload time plus that value. format: date-time ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.files.FileMetadata; import com.anthropic.models.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.files().upload(params); } } ``` #### Response (200) ```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, "expires_at": "2025-05-15T18:37:24.100435Z" } ``` ## List Files `FileListPage files().list(params = FileListParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/files` List Files ### Parameters - `FileListParams params` - `Optional> ids` (query parameter) Restrict the result set to Files whose `id` is in this list. At most 100 entries (after de-duplication). Mutually exclusive with `page` and `limit`. When supplied, the response is always a single page (`next_page` is null). IDs that do not resolve to a visible File — including deleted Files — are silently omitted. - `Optional limit` (query parameter) Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. minimum: 1, maximum: 1000 - `Optional page` (query parameter) Opaque page cursor returned in a prior list response's `next_page`. Prefixed `page_`. - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class FileMetadata` - `JsonValue type = "file"` Object type. For files, this is always `"file"`. - `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. format: date-time - `String filename` Original filename of the uploaded file. minLength: 1, maxLength: 500 - `String mimeType` MIME type of the file. minLength: 1, maxLength: 255 - `long sizeBytes` Size of the file in bytes. minimum: 0 - `Optional downloadable` Whether the file can be downloaded. - `Optional expiresAt` RFC 3339 datetime string representing when the file will expire and become unavailable for download. Null if the file does not expire. For files uploaded with `expires_in_seconds`, this is the upload time plus that value. format: date-time ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.files.FileListPage; import com.anthropic.models.files.FileListParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); FileListPage page = client.files().list(); } } ``` #### Response (200) ```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, "expires_at": "2025-05-15T18:37:24.100435Z" } ], "next_page": "next_page" } ``` ## Download File `HttpResponse files().download(params = FileDownloadParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/files/{file_id}/content` Download File ### Parameters - `FileDownloadParams params` - `Optional fileId` (path parameter) ID of the File. - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### 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.files.FileDownloadParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); HttpResponse response = client.files().download("file_id"); } } ``` ## Get File Metadata `FileMetadata files().retrieveMetadata(params = FileRetrieveMetadataParams.none(), requestOptions = RequestOptions.none())` **GET** `/v1/files/{file_id}` Get File Metadata ### Parameters - `FileRetrieveMetadataParams params` - `Optional fileId` (path parameter) ID of the File. - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class FileMetadata` - `JsonValue type = "file"` Object type. For files, this is always `"file"`. - `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. format: date-time - `String filename` Original filename of the uploaded file. minLength: 1, maxLength: 500 - `String mimeType` MIME type of the file. minLength: 1, maxLength: 255 - `long sizeBytes` Size of the file in bytes. minimum: 0 - `Optional downloadable` Whether the file can be downloaded. - `Optional expiresAt` RFC 3339 datetime string representing when the file will expire and become unavailable for download. Null if the file does not expire. For files uploaded with `expires_in_seconds`, this is the upload time plus that value. format: date-time ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.files.FileMetadata; import com.anthropic.models.files.FileRetrieveMetadataParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); FileMetadata fileMetadata = client.files().retrieveMetadata("file_id"); } } ``` #### Response (200) ```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, "expires_at": "2025-05-15T18:37:24.100435Z" } ``` ## Delete File `DeletedFile files().delete(params = FileDeleteParams.none(), requestOptions = RequestOptions.none())` **DELETE** `/v1/files/{file_id}` Delete File ### Parameters - `FileDeleteParams params` - `Optional fileId` (path parameter) ID of the File. - `Optional workspaceId` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class DeletedFile` - `Optional type` Deleted object type. For file deletion, this is always `"file_deleted"`. - `String id` ID of the deleted file. ### Example ```java package com.anthropic.example; import com.anthropic.client.AnthropicClient; import com.anthropic.client.okhttp.AnthropicOkHttpClient; import com.anthropic.models.files.DeletedFile; import com.anthropic.models.files.FileDeleteParams; public final class Main { private Main() {} public static void main(String[] args) { AnthropicClient client = AnthropicOkHttpClient.fromEnv(); DeletedFile deletedFile = client.files().delete("file_id"); } } ``` #### Response (200) ```json { "id": "file_011CNha8iCJcU1wXNR6q4V8w", "type": "file_deleted" } ``` ## Domain types ### Deleted File - `class DeletedFile` - `Optional type` Deleted object type. For file deletion, this is always `"file_deleted"`. - `String id` ID of the deleted file. ### File Metadata - `class FileMetadata` - `JsonValue type = "file"` Object type. For files, this is always `"file"`. - `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. format: date-time - `String filename` Original filename of the uploaded file. minLength: 1, maxLength: 500 - `String mimeType` MIME type of the file. minLength: 1, maxLength: 255 - `long sizeBytes` Size of the file in bytes. minimum: 0 - `Optional downloadable` Whether the file can be downloaded. - `Optional expiresAt` RFC 3339 datetime string representing when the file will expire and become unavailable for download. Null if the file does not expire. For files uploaded with `expires_in_seconds`, this is the upload time plus that value. format: date-time