取得檔案中繼資料

client.files.retrieveMetadata(fileID, params?, options?): FileMetadata

GET/v1/files/{file_id}

取得檔案中繼資料

Parameters

fileID: string⁠Path

ID of the File.

params: FileRetrieveMetadataParams { workspace_id }

workspace_id?: string⁠Header

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

interface FileMetadata { type: "file"; id; created_at; /* 5 more */ }

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.

created_at: string

RFC 3339 datetime string representing when the file was created.

formatdate-time

filename: string

Original filename of the uploaded file.

minLength1

maxLength500

mime_type: string

MIME type of the file.

minLength1

maxLength255

size_bytes: number

Size of the file in bytes.

minimum0

downloadable?: boolean

Whether the file can be downloaded.

defaultfalse

expires_at?: string | null

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.

formatdate-time

取得檔案中繼資料

import Anthropic from "@anthropic-ai/sdk";

const client = new Anthropic({
  apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted
});

const fileMetadata = await client.files.retrieveMetadata("file_id");

console.log(fileMetadata.id);

Response 200

{
  "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"
}

Returns Examples

Response 200

{
  "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"
}