Skip to main content
GET
Get Batch Inference Job

Authorizations

Authorization
string
header
required

Bearer authentication using your Fireworks API key. Format: Bearer <API_KEY>

Path Parameters

account_id
string
required

The Account Id

batch_inference_job_id
string
required

The Batch Inference Job Id

Query Parameters

readMask
string

The fields to be returned in the response. If empty or "*", all fields will be returned.

Response

200 - application/json

A successful response.

name
string
read-only
displayName
string
createTime
string<date-time>
read-only

The creation time of the batch inference job.

createdBy
string
read-only

The email address of the user who initiated this batch inference job.

state
enum<string>
default:JOB_STATE_UNSPECIFIED
read-only

JobState represents the state an asynchronous job can be in.

Available options:
JOB_STATE_UNSPECIFIED,
JOB_STATE_CREATING,
JOB_STATE_RUNNING,
JOB_STATE_COMPLETED,
JOB_STATE_FAILED,
JOB_STATE_CANCELLED,
JOB_STATE_DELETING,
JOB_STATE_WRITING_RESULTS,
JOB_STATE_VALIDATING,
JOB_STATE_DELETING_CLEANING_UP,
JOB_STATE_PENDING,
JOB_STATE_EXPIRED,
JOB_STATE_RE_QUEUEING,
JOB_STATE_CREATING_INPUT_DATASET,
JOB_STATE_IDLE,
JOB_STATE_CANCELLING,
JOB_STATE_EARLY_STOPPED,
JOB_STATE_PAUSED,
JOB_STATE_DELETED
status
Mimics [https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto] · object
read-only
model
string

The name of the model to use for inference. This is required, except when continued_from_job_name is specified.

inputDatasetId
string

The name of the dataset used for inference. This is required, except when continued_from_job_name is specified.

outputDatasetId
string

The name of the dataset used for storing the results. This will also contain the error file.

inferenceParameters
BIJ inference parameters · object

Parameters controlling the inference process.

updateTime
string<date-time>
read-only

The update time for the batch inference job.

precision
enum<string>
default:PRECISION_UNSPECIFIED

The precision with which the model should be served. If PRECISION_UNSPECIFIED, a default will be chosen based on the model.

Available options:
PRECISION_UNSPECIFIED,
FP16,
FP8,
FP8_MM,
FP8_AR,
FP8_MM_KV_ATTN,
FP8_KV,
FP8_MM_V2,
FP8_V2,
FP8_MM_KV_ATTN_V2,
NF4,
FP4,
BF16,
FP4_BLOCKSCALED_MM,
FP4_MX_MOE
jobProgress
object
read-only

Job progress.

continuedFromJobName
string

The resource name of the batch inference job that this job continues from. Used for lineage tracking to understand job continuation chains.