--- title: Files url: https://platform.claude.com/docs/en/api/csharp/files --- # Files ## Upload File `FileMetadata Files.Upload(parameters, cancellationToken = default)` **POST** `/v1/files` Upload File ### Parameters - `FileUploadParams parameters` - `required BinaryContent 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 - `long 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 - `string 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` - `JsonElement Type = "file"` Object type. For files, this is always `"file"`. - `required string ID` Unique object identifier. The format and length of IDs may change over time. - `required DateTimeOffset CreatedAt` RFC 3339 datetime string representing when the file was created. format: date-time - `required string Filename` Original filename of the uploaded file. minLength: 1, maxLength: 500 - `required string MimeType` MIME type of the file. minLength: 1, maxLength: 255 - `required long SizeBytes` Size of the file in bytes. minimum: 0 - `bool Downloadable` Whether the file can be downloaded. - `DateTimeOffset? 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 ```csharp using System; using System.Text; using Anthropic.Models.Files; FileUploadParams parameters = new() { File = Encoding.UTF8.GetBytes("Example data") }; var fileMetadata = await client.Files.Upload(parameters); Console.WriteLine(fileMetadata); ``` #### 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(parameters, cancellationToken = default)` **GET** `/v1/files` List Files ### Parameters - `FileListParams parameters` - `IReadOnlyList? 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. - `long limit` (query parameter) Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. minimum: 1, maximum: 1000 - `string? page` (query parameter) Opaque page cursor returned in a prior list response's `next_page`. Prefixed `page_`. - `string 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` - `JsonElement Type = "file"` Object type. For files, this is always `"file"`. - `required string ID` Unique object identifier. The format and length of IDs may change over time. - `required DateTimeOffset CreatedAt` RFC 3339 datetime string representing when the file was created. format: date-time - `required string Filename` Original filename of the uploaded file. minLength: 1, maxLength: 500 - `required string MimeType` MIME type of the file. minLength: 1, maxLength: 255 - `required long SizeBytes` Size of the file in bytes. minimum: 0 - `bool Downloadable` Whether the file can be downloaded. - `DateTimeOffset? 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 ```csharp using System; using Anthropic.Models.Files; FileListParams parameters = new(); var page = await client.Files.List(parameters); await foreach (var item in page.Paginate()) { Console.WriteLine(item); } ``` #### 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(parameters, cancellationToken = default)` **GET** `/v1/files/{file_id}/content` Download File ### Parameters - `FileDownloadParams parameters` - `required string fileID` (path parameter) ID of the File. - `string 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 ```csharp using System; using Anthropic.Models.Files; FileDownloadParams parameters = new() { FileID = "file_id" }; var response = await client.Files.Download(parameters); Console.WriteLine(response); ``` ## Get File Metadata `FileMetadata Files.RetrieveMetadata(parameters, cancellationToken = default)` **GET** `/v1/files/{file_id}` Get File Metadata ### Parameters - `FileRetrieveMetadataParams parameters` - `required string fileID` (path parameter) ID of the File. - `string 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` - `JsonElement Type = "file"` Object type. For files, this is always `"file"`. - `required string ID` Unique object identifier. The format and length of IDs may change over time. - `required DateTimeOffset CreatedAt` RFC 3339 datetime string representing when the file was created. format: date-time - `required string Filename` Original filename of the uploaded file. minLength: 1, maxLength: 500 - `required string MimeType` MIME type of the file. minLength: 1, maxLength: 255 - `required long SizeBytes` Size of the file in bytes. minimum: 0 - `bool Downloadable` Whether the file can be downloaded. - `DateTimeOffset? 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 ```csharp using System; using Anthropic.Models.Files; FileRetrieveMetadataParams parameters = new() { FileID = "file_id" }; var fileMetadata = await client.Files.RetrieveMetadata(parameters); Console.WriteLine(fileMetadata); ``` #### 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(parameters, cancellationToken = default)` **DELETE** `/v1/files/{file_id}` Delete File ### Parameters - `FileDeleteParams parameters` - `required string fileID` (path parameter) ID of the File. - `string 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` - `Type Type` Deleted object type. For file deletion, this is always `"file_deleted"`. - `required string ID` ID of the deleted file. ### Example ```csharp using System; using Anthropic.Models.Files; FileDeleteParams parameters = new() { FileID = "file_id" }; var deletedFile = await client.Files.Delete(parameters); Console.WriteLine(deletedFile); ``` #### Response (200) ```json { "id": "file_011CNha8iCJcU1wXNR6q4V8w", "type": "file_deleted" } ``` ## Domain types ### Deleted File - `class DeletedFile` - `Type Type` Deleted object type. For file deletion, this is always `"file_deleted"`. - `required string ID` ID of the deleted file. ### File Metadata - `class FileMetadata` - `JsonElement Type = "file"` Object type. For files, this is always `"file"`. - `required string ID` Unique object identifier. The format and length of IDs may change over time. - `required DateTimeOffset CreatedAt` RFC 3339 datetime string representing when the file was created. format: date-time - `required string Filename` Original filename of the uploaded file. minLength: 1, maxLength: 500 - `required string MimeType` MIME type of the file. minLength: 1, maxLength: 255 - `required long SizeBytes` Size of the file in bytes. minimum: 0 - `bool Downloadable` Whether the file can be downloaded. - `DateTimeOffset? 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