List Files

FileListPageResponse Beta.Files.List(, )

GET/v1/files

List Files

ParametersExpand Collapse

FileListParams parameters

string afterID

Query param: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.

string beforeID

Query param: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.

Long limit

Query param: Number of items to return per page.

Defaults to 20. Ranges from 1 to 1000.

maximum1000

minimum1

IReadOnlyList<AnthropicBeta> betas

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

ReturnsExpand Collapse

class FileListPageResponse:

required IReadOnlyList<FileMetadata> Data

List of file metadata objects.

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.

string? FirstID

ID of the first file in this page of results.

Boolean HasMore

Whether there are more results available.

string? LastID

ID of the last file in this page of results.

List Files

FileListParams parameters = new();

var page = await client.Beta.Files.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

Response 200

{
  "data": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "filename": "x",
      "mime_type": "x",
      "size_bytes": 0,
      "type": "file",
      "downloadable": true
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}

Returns Examples

Response 200

{
  "data": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "filename": "x",
      "mime_type": "x",
      "size_bytes": 0,
      "type": "file",
      "downloadable": true
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}

{ "data": [ { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "filename": "x", "mime_type": "x", "size_bytes": 0, "type": "file", "downloadable": true } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" }