Loading...
    • Developer Guide
    • API Reference
    • MCP
    • Resources
    • Release Notes
    Search...
    ⌘K
    Using the API
    Features overviewClient SDKsBeta headersErrors
    Messages
    Create a Message
    Count tokens in a Message
    Models
    List Models
    Get a Model
    Beta
    Upload File
    List Files
    Download File
    Get File Metadata
    Delete File
    Admin
    Completions
    Create a Text Completion
    Support & configuration
    Rate limitsService tiersVersionsIP addressesSupported regionsOpenAI SDK compatibility
    Console
    Log in

    Upload File

    client.Beta.Files.Upload(ctx, params) (*FileMetadata, error)
    post/v1/files

    Upload File

    ParametersExpand Collapse
    params BetaFileUploadParams
    File param.Field[Reader]

    Body param: The file to upload

    formatbinary
    Betas param.Field[[]AnthropicBeta]optional

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

    string
    type AnthropicBeta string
    Accepts one of the following:
    const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"
    const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"
    const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"
    const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"
    const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"
    const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"
    const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"
    const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"
    const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"
    const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"
    const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"
    const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"
    const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"
    const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"
    const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"
    const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"
    const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"
    const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"
    const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"
    ReturnsExpand Collapse
    type FileMetadata struct{…}
    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.

    formatdate-time
    Filename string

    Original filename of the uploaded file.

    maxLength500
    minLength1
    MimeType string

    MIME type of the file.

    maxLength255
    minLength1
    SizeBytes int64

    Size of the file in bytes.

    minimum0
    Type File

    Object type.

    For files, this is always "file".

    Accepts one of the following:
    const FileFile File = "file"
    Downloadable booloptional

    Whether the file can be downloaded.

    Upload File
    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.Beta.Files.Upload(context.TODO(), anthropic.BetaFileUploadParams{
        File: io.Reader(bytes.NewBuffer([]byte("some file contents"))),
      })
      if err != nil {
        panic(err.Error())
      }
      fmt.Printf("%+v\n", fileMetadata.ID)
    }
    
    Response 200
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "filename": "x",
      "mime_type": "x",
      "size_bytes": 0,
      "type": "file",
      "downloadable": true
    }
    Returns Examples
    Response 200
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "filename": "x",
      "mime_type": "x",
      "size_bytes": 0,
      "type": "file",
      "downloadable": true
    }

    Solutions

    • AI agents
    • Code modernization
    • Coding
    • Customer support
    • Education
    • Financial services
    • Government
    • Life sciences

    Partners

    • Amazon Bedrock
    • Google Cloud's Vertex AI

    Learn

    • Blog
    • Catalog
    • Courses
    • Use cases
    • Connectors
    • Customer stories
    • Engineering at Anthropic
    • Events
    • Powered by Claude
    • Service partners
    • Startups program

    Company

    • Anthropic
    • Careers
    • Economic Futures
    • Research
    • News
    • Responsible Scaling Policy
    • Security and compliance
    • Transparency

    Learn

    • Blog
    • Catalog
    • Courses
    • Use cases
    • Connectors
    • Customer stories
    • Engineering at Anthropic
    • Events
    • Powered by Claude
    • Service partners
    • Startups program

    Help and security

    • Availability
    • Status
    • Support
    • Discord

    Terms and policies

    • Privacy policy
    • Responsible disclosure policy
    • Terms of service: Commercial
    • Terms of service: Consumer
    • Usage policy