Create Batch Request
Headers
Your Fireworks API key, e.g. Authorization=FIREWORKS_API_KEY
. Alternatively, can be provided as a query param.
Path Parameters
The relative route of the target API operation (e.g. "v1/audio/transcriptions"
, "v1/audio/translations"
). This should correspond to a valid route supported by the backend service.
Query Parameters
Identifies the target backend service or model to handle the request. Currently supported:
Body
Request body fields vary depending on the selected endpoint_id
and path
.
The request body must conform to the schema defined by the corresponding synchronous API.
For example, transcription requests typically accept fields such as model
, diarize
, and response_format
.
Refer to the relevant synchronous API for required fields:
Response
The status of the batch request submission.
A value of "submitted"
indicates the batch request was accepted and queued for processing.
A unique identifier assigned to the batch job. This ID can be used to check job status or retrieve results later.
The unique identifier of the account associated with the batch job.
The backend service selected to process the request.
This typically matches the endpoint_id
used during submission.
A human-readable message describing the result of the submission.
Typically "Request submitted successfully"
if accepted.
The status of the batch request submission.
A value of "submitted"
indicates the batch request was accepted and queued for processing.
A unique identifier assigned to the batch job. This ID can be used to check job status or retrieve results later.
The unique identifier of the account associated with the batch job.
The backend service selected to process the request.
This typically matches the endpoint_id
used during submission.
A human-readable message describing the result of the submission.
Typically "Request submitted successfully"
if accepted.
To check the status of your batch request, use the Check Batch Status endpoint with the returned batch_id
.