Get File Metadata

FileMetadata Beta.Files.RetrieveMetadata(, )

GET/v1/files/{file_id}

Get File Metadata

ParametersExpand Collapse

FileRetrieveMetadataParams parameters

required string fileID

ID of the File.

IReadOnlyList<AnthropicBeta> betas

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

ReturnsExpand Collapse

class FileMetadata:

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.

required string Filename

Original filename of the uploaded file.

required string MimeType

MIME type of the file.

required Long SizeBytes

Size of the file in bytes.

JsonElement Type

Object type.

For files, this is always "file".

Boolean Downloadable

Whether the file can be downloaded.

Get File Metadata

FileRetrieveMetadataParams parameters = new() { FileID = "file_id" };

var fileMetadata = await client.Beta.Files.RetrieveMetadata(parameters);

Console.WriteLine(fileMetadata);

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
}

Get File Metadata

FileMetadata Beta.Files.RetrieveMetadata(, )

GET/v1/files/{file_id}

Get File Metadata

ParametersExpand Collapse

FileRetrieveMetadataParams parameters

required string fileID

ID of the File.

IReadOnlyList<AnthropicBeta> betas

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

ReturnsExpand Collapse

class FileMetadata:

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.

required string Filename

Original filename of the uploaded file.

required string MimeType

MIME type of the file.

required Long SizeBytes

Size of the file in bytes.

JsonElement Type

Object type.

For files, this is always "file".

Boolean Downloadable

Whether the file can be downloaded.

Get File Metadata

FileRetrieveMetadataParams parameters = new() { FileID = "file_id" };

var fileMetadata = await client.Beta.Files.RetrieveMetadata(parameters);

Console.WriteLine(fileMetadata);

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
}