Scale AI

Scale AI Batch Jobs API

The Batch Jobs API from Scale AI — 2 operation(s) for batch jobs.

Documentation GitHub OpenAPI

Operations 3

POST /v1/batch-jobs Create Batch Job #

GET /v1/batch-jobs/{batch_job_id} Get Batch Job #

PUT /v1/batch-jobs/{batch_job_id} Update Batch Job #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/scale-ai:scale-ai-batch-jobs-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: launch Batch Jobs API
  version: 1.0.0
tags:
- name: Batch Jobs
paths:
  /v1/batch-jobs:
    post:
      summary: Create Batch Job
      description: Runs a batch job.
      operationId: create_batch_job_v1_batch_jobs_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBatchJobV1Request'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateBatchJobV1Response'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
      tags:
      - Batch Jobs
  /v1/batch-jobs/{batch_job_id}:
    get:
      summary: Get Batch Job
      description: Gets a batch job.
      operationId: get_batch_job_v1_batch_jobs__batch_job_id__get
      security:
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
      parameters:
      - name: batch_job_id
        in: path
        required: true
        schema:
          type: string
          title: Batch Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBatchJobV1Response'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Batch Jobs
    put:
      summary: Update Batch Job
      description: Updates a batch job.
      operationId: update_batch_job_v1_batch_jobs__batch_job_id__put
      security:
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
      parameters:
      - name: batch_job_id
        in: path
        required: true
        schema:
          type: string
          title: Batch Job Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBatchJobV1Request'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateBatchJobV1Response'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Batch Jobs
components:
  schemas:
    GpuType:
      type: string
      enum:
      - nvidia-tesla-t4
      - nvidia-ampere-a10
      - nvidia-ampere-a100
      - nvidia-ampere-a100e
      - nvidia-hopper-h100
      - nvidia-hopper-h100-1g20gb
      - nvidia-hopper-h100-3g40gb
      title: GpuType
      description: Lists allowed GPU types for Launch.
    CreateBatchJobV1Request:
      properties:
        model_bundle_id:
          type: string
          title: Model Bundle Id
        input_path:
          type: string
          title: Input Path
        serialization_format:
          $ref: '#/components/schemas/BatchJobSerializationFormat'
        labels:
          additionalProperties:
            type: string
          type: object
          title: Labels
        resource_requests:
          $ref: '#/components/schemas/CreateBatchJobResourceRequests'
        timeout_seconds:
          type: number
          title: Timeout Seconds
          default: 43200.0
      type: object
      required:
      - model_bundle_id
      - input_path
      - serialization_format
      - labels
      - resource_requests
      title: CreateBatchJobV1Request
    GetBatchJobV1Response:
      properties:
        status:
          $ref: '#/components/schemas/BatchJobStatus'
        result:
          anyOf:
          - type: string
          - type: 'null'
          title: Result
        duration:
          type: string
          format: duration
          title: Duration
        num_tasks_pending:
          anyOf:
          - type: integer
          - type: 'null'
          title: Num Tasks Pending
        num_tasks_completed:
          anyOf:
          - type: integer
          - type: 'null'
          title: Num Tasks Completed
      type: object
      required:
      - status
      - duration
      title: GetBatchJobV1Response
    BatchJobStatus:
      type: string
      enum:
      - PENDING
      - RUNNING
      - SUCCESS
      - FAILURE
      - CANCELLED
      - UNDEFINED
      - TIMEOUT
      title: BatchJobStatus
    BatchJobSerializationFormat:
      type: string
      enum:
      - JSON
      - PICKLE
      title: BatchJobSerializationFormat
    UpdateBatchJobV1Response:
      properties:
        success:
          type: boolean
          title: Success
      type: object
      required:
      - success
      title: UpdateBatchJobV1Response
    CreateBatchJobResourceRequests:
      properties:
        cpus:
          anyOf:
          - type: string
          - type: integer
          - type: number
          - type: 'null'
          title: Cpus
        memory:
          anyOf:
          - type: string
          - type: integer
          - type: number
          - type: 'null'
          title: Memory
        gpus:
          anyOf:
          - type: integer
          - type: 'null'
          title: Gpus
        gpu_type:
          anyOf:
          - $ref: '#/components/schemas/GpuType'
          - type: 'null'
        storage:
          anyOf:
          - type: string
          - type: integer
          - type: number
          - type: 'null'
          title: Storage
        max_workers:
          anyOf:
          - type: integer
          - type: 'null'
          title: Max Workers
        per_worker:
          anyOf:
          - type: integer
          - type: 'null'
          title: Per Worker
        concurrent_requests_per_worker:
          anyOf:
          - type: integer
          - type: 'null'
          title: Concurrent Requests Per Worker
      type: object
      title: CreateBatchJobResourceRequests
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CreateBatchJobV1Response:
      properties:
        job_id:
          type: string
          title: Job Id
      type: object
      required:
      - job_id
      title: CreateBatchJobV1Response
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    UpdateBatchJobV1Request:
      properties:
        cancel:
          type: boolean
          title: Cancel
      type: object
      required:
      - cancel
      title: UpdateBatchJobV1Request
  securitySchemes:
    HTTPBasic:
      type: http
      scheme: basic
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: token

Scale AI Batch Jobs API

Operations 3

Documentation

Specifications

SDKs

Schemas & Data