Skip to main content
GET
CSharp (SDK)

Authorizations

Authorization
string
header
required

Send Authorization: Bearer , using an MKA1 API key for automation or an OAuth API access token for a signed-in application. Use a dynamic security callback to refresh OAuth access tokens. Browser session-only operations still require their declared cookie.

Headers

X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Path Parameters

batch_id
string
required

Response

200 - application/json

OK

id
string
required
object
any
required
endpoint
string
required
input_file_id
string
required
completion_window
string
required
status
enum<string>
required
Available options:
validating,
failed,
in_progress,
finalizing,
completed,
expired,
cancelling,
cancelled
created_at
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
request_counts
object
required
max_concurrency
integer
required

How many of this batch's lines may be in flight at once. Each line is admitted against its model's rate limits first.

Required range: -9007199254740991 <= x <= 9007199254740991
errors
object | null
output_file_id
string | null
error_file_id
string | null
in_progress_at
integer | null
Required range: -9007199254740991 <= x <= 9007199254740991
expires_at
integer | null
Required range: -9007199254740991 <= x <= 9007199254740991
finalizing_at
integer | null
Required range: -9007199254740991 <= x <= 9007199254740991
completed_at
integer | null
Required range: -9007199254740991 <= x <= 9007199254740991
failed_at
integer | null
Required range: -9007199254740991 <= x <= 9007199254740991
expired_at
integer | null
Required range: -9007199254740991 <= x <= 9007199254740991
cancelling_at
integer | null
Required range: -9007199254740991 <= x <= 9007199254740991
cancelled_at
integer | null
Required range: -9007199254740991 <= x <= 9007199254740991
metadata
object | null