BatchRequestOptions

public sealed class BatchRequestOptions : OperationRequest

Options for batch operations.

Inheritance: object → OperationRequest

Properties

public BatchReference? Batch { get; set; }

Batch reference.

Value: BatchReference

public string? Cursor { get; set; }

Page cursor.

Value: string

public Func<string, CancellationToken, Task<DownloadedMedia>>? Download { get; set; }

Downloads file URLs inside results.

Value: Func<string, CancellationToken, Task<DownloadedMedia>>

public int? Limit { get; set; }

Page size.

Value: int?

public ApiOrProvider<IBatchApi, IBatchProvider>? Provider { get; set; }

Batch API or a provider that exposes one. Null uses Default.

Value: ApiOrProvider<IBatchApi, IBatchProvider>

public IReadOnlyList<BatchRequest>? Requests { get; set; }

Requests to start.

Value: IReadOnlyList<BatchRequest>

public int? TimeoutMs { get; set; }

Total timeout in milliseconds.

Value: int?

public IReadOnlyList<BatchTool>? Tools { get; set; }

Tools used to parse client tool calls. They are not executed.

Value: IReadOnlyList<BatchTool>

public string? WebhookUrl { get; set; }

Webhook URL.

Value: string