--- title: Files url: https://platform.claude.com/docs/en/api/go/files --- # Files ## Upload File `client.Files.Upload(ctx, params) (*FileMetadata, error)` **POST** `/v1/files` Upload File ### Parameters - `params FileUploadParams` - `File Reader` 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 - `ExpiresInSeconds param.Opt[int64] Optional` 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 - `WorkspaceID param.Opt[string] Optional` (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 - `type FileMetadata` - `Type File` Object type. For files, this is always `"file"`. - `ID string` Unique object identifier. The format and length of IDs may change over time. - `CreatedAt Time` RFC 3339 datetime string representing when the file was created. format: date-time - `Filename string` Original filename of the uploaded file. minLength: 1, maxLength: 500 - `MimeType string` MIME type of the file. minLength: 1, maxLength: 255 - `SizeBytes int64` Size of the file in bytes. minimum: 0 - `Downloadable bool Optional` Whether the file can be downloaded. default: false - `ExpiresAt Time Optional` 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 ```go package main import ( "bytes" "context" "fmt" "io" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) fileMetadata, err := client.Files.Upload(context.TODO(), anthropic.FileUploadParams{ File: io.Reader(bytes.NewBuffer([]byte("Example data"))), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", fileMetadata.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" } ``` ## List Files `client.Files.List(ctx, params) (*PageCursor[FileMetadata], error)` **GET** `/v1/files` List Files ### Parameters - `params FileListParams` - `IDs []string Optional` (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. - `Limit param.Opt[int64] Optional` (query parameter) Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. minimum: 1, maximum: 1000 - `Page param.Opt[string] Optional` (query parameter) Opaque page cursor returned in a prior list response's `next_page`. Prefixed `page_`. - `WorkspaceID param.Opt[string] Optional` (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 - `type FileMetadata` - `Type File` Object type. For files, this is always `"file"`. - `ID string` Unique object identifier. The format and length of IDs may change over time. - `CreatedAt Time` RFC 3339 datetime string representing when the file was created. format: date-time - `Filename string` Original filename of the uploaded file. minLength: 1, maxLength: 500 - `MimeType string` MIME type of the file. minLength: 1, maxLength: 255 - `SizeBytes int64` Size of the file in bytes. minimum: 0 - `Downloadable bool Optional` Whether the file can be downloaded. default: false - `ExpiresAt Time Optional` 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 ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Files.List(context.TODO(), anthropic.FileListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### 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 `client.Files.Download(ctx, fileID, query) (*Response, error)` **GET** `/v1/files/{file_id}/content` Download File ### Parameters - `fileID string` (path parameter) ID of the File. - `query FileDownloadParams` - `WorkspaceID param.Opt[string] Optional` (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 - `type FileDownloadResponse interface{…}` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) response, err := client.Files.Download( context.TODO(), "file_id", anthropic.FileDownloadParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response) } ``` ## Get File Metadata `client.Files.GetMetadata(ctx, fileID, query) (*FileMetadata, error)` **GET** `/v1/files/{file_id}` Get File Metadata ### Parameters - `fileID string` (path parameter) ID of the File. - `query FileGetMetadataParams` - `WorkspaceID param.Opt[string] Optional` (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 - `type FileMetadata` - `Type File` Object type. For files, this is always `"file"`. - `ID string` Unique object identifier. The format and length of IDs may change over time. - `CreatedAt Time` RFC 3339 datetime string representing when the file was created. format: date-time - `Filename string` Original filename of the uploaded file. minLength: 1, maxLength: 500 - `MimeType string` MIME type of the file. minLength: 1, maxLength: 255 - `SizeBytes int64` Size of the file in bytes. minimum: 0 - `Downloadable bool Optional` Whether the file can be downloaded. default: false - `ExpiresAt Time Optional` 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 ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) fileMetadata, err := client.Files.GetMetadata( context.TODO(), "file_id", anthropic.FileGetMetadataParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", fileMetadata.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 `client.Files.Delete(ctx, fileID, body) (*DeletedFile, error)` **DELETE** `/v1/files/{file_id}` Delete File ### Parameters - `fileID string` (path parameter) ID of the File. - `body FileDeleteParams` - `WorkspaceID param.Opt[string] Optional` (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 - `type DeletedFile` - `Type DeletedFileType Optional` Deleted object type. For file deletion, this is always `"file_deleted"`. default: file_deleted - `ID string` ID of the deleted file. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) deletedFile, err := client.Files.Delete( context.TODO(), "file_id", anthropic.FileDeleteParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", deletedFile.ID) } ``` #### Response (200) ```json { "id": "file_011CNha8iCJcU1wXNR6q4V8w", "type": "file_deleted" } ``` ## Domain types ### Deleted File - `type DeletedFile` - `Type DeletedFileType Optional` Deleted object type. For file deletion, this is always `"file_deleted"`. default: file_deleted - `ID string` ID of the deleted file. ### File Metadata - `type FileMetadata` - `Type File` Object type. For files, this is always `"file"`. - `ID string` Unique object identifier. The format and length of IDs may change over time. - `CreatedAt Time` RFC 3339 datetime string representing when the file was created. format: date-time - `Filename string` Original filename of the uploaded file. minLength: 1, maxLength: 500 - `MimeType string` MIME type of the file. minLength: 1, maxLength: 255 - `SizeBytes int64` Size of the file in bytes. minimum: 0 - `Downloadable bool Optional` Whether the file can be downloaded. default: false - `ExpiresAt Time Optional` 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