POST
/
batches
Create Batch
curl --request POST \
  --url https://{controlPlaneURL}/api/llm/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "input_file_id": "<string>",
  "completion_window": "<string>",
  "endpoint": "<string>",
  "job_name": "<string>"
}'
{
  "id": "<string>",
  "object": "<string>",
  "endpoint": "<string>",
  "errors": "<any>",
  "input_file_id": "<string>",
  "completion_window": "<string>",
  "status": "<string>",
  "output_file_id": "<string>",
  "error_file_id": "<string>",
  "created_at": 123,
  "in_progress_at": 123,
  "expires_at": 123,
  "finalizing_at": 123,
  "completed_at": 123,
  "failed_at": 123,
  "expired_at": 123,
  "cancelling_at": 123,
  "cancelled_at": 123,
  "request_counts": {
    "total": 123,
    "completed": 123,
    "failed": 123
  },
  "metadata": "<any>"
}

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

Body

application/json

Batch processing parameters

input_file_id
string
required

The ID of the input file to process.

endpoint
string
required

The API endpoint to be used.

completion_window
string | null

Time window for completion.

job_name
string | null

Name for the job.

Response

Batch created successfully

id
string
required

Batch ID.

object
string
required

Object type.

endpoint
string
required

API endpoint.

input_file_id
string
required

Input file ID.

completion_window
string
required

Completion window.

status
string
required

Batch status.

output_file_id
string | null
required

Output file ID.

error_file_id
string | null
required

Error file ID.

created_at
number
required

Creation timestamp.

in_progress_at
number | null
required

In-progress timestamp.

expires_at
number
required

Expiration timestamp.

finalizing_at
number | null
required

Finalizing timestamp.

completed_at
number | null
required

Completion timestamp.

failed_at
number | null
required

Failure timestamp.

expired_at
number | null
required

Expiration timestamp.

cancelling_at
number | null
required

Cancelling timestamp.

cancelled_at
number | null
required

Cancelled timestamp.

request_counts
object
required

Request counts.

errors
any

Errors associated with the batch.

metadata
any

Additional metadata.