Sign in
gateway.openapi_Gateway

Create Batch Inference Job

post/v1/accounts/{account_id}/batchInferenceJobs

Path parameters

account_idstring required

The Account Id

Query parameters

batchInferenceJobIdstring

ID of the batch inference job.

Request body

namestring
displayNamestring
createTimestring date-time

The creation time of the batch inference job.

createdBystring

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

state'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'

JobState represents the state an asynchronous job can be in.

  • JOB_STATE_PAUSED: Job is paused, typically due to account suspension or manual intervention.
modelstring

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

inputDatasetIdstring

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

outputDatasetIdstring

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

updateTimestring date-time

The update time for the batch inference job.

precision'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'
continuedFromJobNamestring

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

Response

A successful response.

namestring
displayNamestring
createTimestring date-time

The creation time of the batch inference job.

createdBystring

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

state'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'

JobState represents the state an asynchronous job can be in.

  • JOB_STATE_PAUSED: Job is paused, typically due to account suspension or manual intervention.
modelstring

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

inputDatasetIdstring

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

outputDatasetIdstring

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

updateTimestring date-time

The update time for the batch inference job.

precision'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'
continuedFromJobNamestring

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

Changes

Changed in 3 of the 27 revisions of this API.36

  • 4506ec9d12ff11See the full diff
    • ●

      added the new JOB_STATE_PAUSED enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new JOB_STATE_PAUSED enum value to the request property

      request-property-enum-value-added

  • 824e683281d411See the full diff
    • ●

      added the new JOB_STATE_EARLY_STOPPED enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new JOB_STATE_EARLY_STOPPED enum value to the request property

      request-property-enum-value-added

  • 311efdb2fa5714See the full diff
    • ●

      added the new JOB_STATE_CANCELLING enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      the endpoint scheme security BearerAuth was added to the API

      api-security-added

    • ○

      api tag gateway.openapi_Gateway added

      api-tag-added

    • ○

      api tag Gateway removed

      api-tag-removed

    • ○

      added the new JOB_STATE_CANCELLING enum value to the request property

      request-property-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog