XaiFiles

Namespace: Vercel.AI.Xai

public sealed class XaiFiles : IFileStore

xAI Files API at {base}/files.

Inheritance: object

Implements: IFileStore

View source

Constructors

`XaiFiles(HttpClient, string, Func<IReadOnlyDictionary<string, string?>>?, string?)`

public XaiFiles(HttpClient httpClient, string baseUrl, Func<IReadOnlyDictionary<string, string?>>? headers, string? provider = null)

Creates a file client.

Parameters

Name	Type	Description
`httpClient`	HttpClient
`baseUrl`	string
`headers`	Func<IReadOnlyDictionary<string, string>>
`provider`	string

View source

Fields

MaximumExpiresAfter

public const int MaximumExpiresAfter = 2592000

Longest accepted expires_after, in seconds.

Value: int

View source

MinimumExpiresAfter

public const int MinimumExpiresAfter = 3600

Shortest accepted expires_after, in seconds.

Value: int

View source

Properties

Provider

public string Provider { get; }

Provider id.

Value: string

View source

SpecificationVersion

public string SpecificationVersion { get; }

Specification version.

Value: string

View source

Methods

`DeleteAsync(IReadOnlyDictionary<string, string?>, CancellationToken)`

public Task<XaiFileDeleteResult> DeleteAsync(IReadOnlyDictionary<string, string?> file, CancellationToken cancellationToken)

Deletes a file.

Parameters

Name	Type	Description
`file`	IReadOnlyDictionary<string, string>
`cancellationToken`	CancellationToken

Returns: Task<XaiFileDeleteResult>

View source

`DownloadAsync(IReadOnlyDictionary<string, string?>, CancellationToken)`

public Task<XaiFileDownload> DownloadAsync(IReadOnlyDictionary<string, string?> file, CancellationToken cancellationToken)

Downloads file bytes.

Parameters

Name	Type	Description
`file`	IReadOnlyDictionary<string, string>
`cancellationToken`	CancellationToken

Returns: Task<XaiFileDownload>

View source

`GetMetadataAsync(IReadOnlyDictionary<string, string?>, CancellationToken)`

public Task<XaiFileResult> GetMetadataAsync(IReadOnlyDictionary<string, string?> file, CancellationToken cancellationToken)

Reads file metadata.

Parameters

Name	Type	Description
`file`	IReadOnlyDictionary<string, string>
`cancellationToken`	CancellationToken

Returns: Task<XaiFileResult>

View source

UploadAsync(XaiFileUpload, CancellationToken)

public Task<XaiFileResult> UploadAsync(XaiFileUpload upload, CancellationToken cancellationToken)

Posts multipart file contents to /files.

Parameters

Name	Type	Description
`upload`	XaiFileUpload
`cancellationToken`	CancellationToken

Returns: Task<XaiFileResult>

View source

UploadFileAsync(string, byte[], string, CancellationToken)

public Task<UploadedFile> UploadFileAsync(string fileName, byte[] data, string mediaType, CancellationToken cancellationToken)

Uploads a file.

Parameters

Name	Type	Description
`fileName`	string
`data`	byte[]
`mediaType`	string
`cancellationToken`	CancellationToken

Returns: Task<UploadedFile>

View source