Check Batch Status
This endpoint allows you to check the current status of a previously submitted batch request, and retrieve the final result if available.
Headers
Your Fireworks API key. e.g. Authorization=FIREWORKS_API_KEY. Alternatively, can be provided as a query param.
Path Parameters
The identifier of your Fireworks account. Must match the account used when the batch request was submitted.
The unique identifier of the batch job to check.
This should match the batch_id returned when the batch request was originally submitted.
Response
The response includes the status of the batch job and, if completed, the final result.
The status of the batch job at the time of the request.
Possible values include "completed" and "processing".
The unique identifier of the batch job whose status is being retrieved.
This ID matches the one provided in the original request.
A human-readable message describing the current state of the batch job.
This field is typically null when the job has completed successfully.
The original content type of the response body.
This value can be used to determine how to parse the string in the body field.
The serialized result of the batch job, this field is only present when status is "completed".
The format of this string depends on the content_type field and may vary across endpoints.
Clients should use content_type to determine how to parse or interpret the value.
The status of the batch job at the time of the request.
Possible values include "completed" and "processing".
The unique identifier of the batch job whose status is being retrieved.
This ID matches the one provided in the original request.
A human-readable message describing the current state of the batch job.
This field is typically null when the job has completed successfully.
The original content type of the response body.
This value can be used to determine how to parse the string in the body field.
The serialized result of the batch job, this field is only present when status is "completed".
The format of this string depends on the content_type field and may vary across endpoints.
Clients should use content_type to determine how to parse or interpret the value.