Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
CallbackURL | *string | ➖ | HTTPS URL that receives a batch.completed, batch.failed, batch.cancelled or batch.expired webhook event when the batch reaches a terminal status. Must appear before requests in the request body. | |
CompletionWindow | *components.BatchSubmitBodyCompletionWindow | ➖ | N/A | |
Endpoint | components.Endpoint | ✔️ | N/A | |
Input | *components.BatchInputReference | ➖ | A batch input file or table in your own storage, named in place of requests. Available to allowlisted callers on Google Vertex BYOK endpoints only. | |
Model | string | ✔️ | N/A | |
Provider | optionalnullable.OptionalNullable[components.BatchProviderPreferences] | ➖ | Batch provider routing preferences. Only provider.only and provider.allow_fallbacks are supported. | { “only”: [ “google-vertex” ] } |
Requests | []components.Request | ➖ | The batch requests. Send exactly one of requests or input; requests must be the last field in the request body. |