Skip to main content
GET
Get Batch Output

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

Path Parameters

id
string
required

Batch ID.

Response

Batch output retrieved successfully

id
string
required

Batch request ID.

custom_id
string
required

Custom ID for the request.

response
object
required

Response details.

error
any

Error details, if any.