Upload File

beta().files().upload(, ) : FileMetadata

post/v1/files

Upload File

ParametersExpand Collapse

params: FileUploadParams

betas: Optional<List<AnthropicBeta>>

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")

file: String

The file to upload

formatbinary

ReturnsExpand Collapse

class FileMetadata:

id: String

Unique object identifier.

The format and length of IDs may change over time.

createdAt: LocalDateTime

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: Long

Size of the file in bytes.

minimum0

type: JsonValue;

Object type.

For files, this is always "file".

Accepts one of the following:

FILE("file")

downloadable: Optional<Boolean>

Whether the file can be downloaded.

Upload File

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

fun main() {
    val client: AnthropicClient = AnthropicOkHttpClient.fromEnv()

    val params: FileUploadParams = FileUploadParams.builder()
        .file("some content".byteInputStream())
        .build()
    val fileMetadata: FileMetadata = client.beta().files().upload(params)
}

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
}

Upload File

beta().files().upload(, ) : FileMetadata

post/v1/files

Upload File

ParametersExpand Collapse

params: FileUploadParams

betas: Optional<List<AnthropicBeta>>

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")

file: String

The file to upload

formatbinary

ReturnsExpand Collapse

class FileMetadata:

id: String

Unique object identifier.

The format and length of IDs may change over time.

createdAt: LocalDateTime

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: Long

Size of the file in bytes.

minimum0

type: JsonValue;

Object type.

For files, this is always "file".

Accepts one of the following:

FILE("file")

downloadable: Optional<Boolean>

Whether the file can be downloaded.

Upload File

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

fun main() {
    val client: AnthropicClient = AnthropicOkHttpClient.fromEnv()

    val params: FileUploadParams = FileUploadParams.builder()
        .file("some content".byteInputStream())
        .build()
    val fileMetadata: FileMetadata = client.beta().files().upload(params)
}

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
}