Skip to main content
GET
List Batches

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-tfy-metadata
string

Optional metadata for the request

x-tfy-provider-name
string

Name of the provider

x-tfy-azure-api-version
string

Azure OpenAI API version for the deployment

x-tfy-vertex-storage-bucket-name
string

Vertex AI storage bucket name

x-tfy-vertex-region
string

Vertex AI region (e.g., europe-west4)

x-tfy-provider-model
string

Provider-specific model identifier

x-tfy-aws-s3-bucket
string

AWS S3 bucket name (Bedrock batch)

x-tfy-aws-bedrock-model
string

AWS Bedrock model identifier

Response

200 - application/json

Batches retrieved successfully

object
string
required

Object type.

data
object[]
required

List of batches.

first_id
string
required

ID of the first batch.

last_id
string
required

ID of the last batch.

has_more
boolean
required

Indicates if there are more batches.