Scale AI

Scale AI Docker Image Batch Jobs API

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

Documentation GitHub OpenAPI

Operations 4

POST /v1/docker-image-batch-jobs Create Docker Image Batch Job #

GET /v1/docker-image-batch-jobs List Docker Image Batch Jobs #

GET /v1/docker-image-batch-jobs/{batch_job_id} Get Docker Image Batch Job #

PUT /v1/docker-image-batch-jobs/{batch_job_id} Update Docker Image 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-docker-image-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 Docker Image Batch Jobs API
  version: 1.0.0
tags:
- name: Docker Image Batch Jobs
paths:
  /v1/docker-image-batch-jobs:
    post:
      summary: Create Docker Image Batch Job
      operationId: create_docker_image_batch_job_v1_docker_image_batch_jobs_post
      security:
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDockerImageBatchJobV1Request'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDockerImageBatchJobV1Response'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Docker Image Batch Jobs
    get:
      summary: List Docker Image Batch Jobs
      description: Lists docker image batch jobs spawned by trigger with given ID
      operationId: list_docker_image_batch_jobs_v1_docker_image_batch_jobs_get
      security:
      - HTTPBasic: []
      - OAuth2PasswordBearer: []
      parameters:
      - name: trigger_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Trigger Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDockerImageBatchJobsV1Response'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Docker Image Batch Jobs
  /v1/docker-image-batch-jobs/{batch_job_id}:
    get:
      summary: Get Docker Image Batch Job
      operationId: get_docker_image_batch_job_v1_docker_image_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/GetDockerImageBatchJobV1Response'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Docker Image Batch Jobs
    put:
      summary: Update Docker Image Batch Job
      operationId: update_docker_image_batch_job_v1_docker_image_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/UpdateDockerImageBatchJobV1Request'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDockerImageBatchJobV1Response'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Docker Image Batch Jobs
components:
  schemas:
    UpdateDockerImageBatchJobV1Response:
      properties:
        success:
          type: boolean
          title: Success
      type: object
      required:
      - success
      title: UpdateDockerImageBatchJobV1Response
    ListDockerImageBatchJobsV1Response:
      properties:
        jobs:
          items:
            $ref: '#/components/schemas/DockerImageBatchJob'
          type: array
          title: Jobs
      type: object
      required:
      - jobs
      title: ListDockerImageBatchJobsV1Response
    CreateDockerImageBatchJobV1Request:
      properties:
        docker_image_batch_job_bundle_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Docker Image Batch Job Bundle Name
        docker_image_batch_job_bundle_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Docker Image Batch Job Bundle Id
        job_config:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Job Config
        labels:
          additionalProperties:
            type: string
          type: object
          title: Labels
        resource_requests:
          $ref: '#/components/schemas/CreateDockerImageBatchJobResourceRequests'
          default: {}
        override_job_max_runtime_s:
          anyOf:
          - type: integer
          - type: 'null'
          title: Override Job Max Runtime S
      type: object
      required:
      - labels
      title: CreateDockerImageBatchJobV1Request
    CreateDockerImageBatchJobResourceRequests:
      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
        nodes_per_worker:
          anyOf:
          - type: integer
          - type: 'null'
          title: Nodes Per Worker
      type: object
      title: CreateDockerImageBatchJobResourceRequests
    CreateDockerImageBatchJobV1Response:
      properties:
        job_id:
          type: string
          title: Job Id
      type: object
      required:
      - job_id
      title: CreateDockerImageBatchJobV1Response
    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.
    UpdateDockerImageBatchJobV1Request:
      properties:
        cancel:
          type: boolean
          title: Cancel
      type: object
      required:
      - cancel
      title: UpdateDockerImageBatchJobV1Request
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    GetDockerImageBatchJobV1Response:
      properties:
        status:
          $ref: '#/components/schemas/BatchJobStatus'
      type: object
      required:
      - status
      title: GetDockerImageBatchJobV1Response
    BatchJobStatus:
      type: string
      enum:
      - PENDING
      - RUNNING
      - SUCCESS
      - FAILURE
      - CANCELLED
      - UNDEFINED
      - TIMEOUT
      title: BatchJobStatus
    DockerImageBatchJob:
      properties:
        id:
          type: string
          title: Id
        created_by:
          type: string
          title: Created By
        owner:
          type: string
          title: Owner
        created_at:
          type: string
          format: date-time
          title: Created At
        completed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Completed At
        status:
          $ref: '#/components/schemas/BatchJobStatus'
        annotations:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Annotations
        override_job_max_runtime_s:
          anyOf:
          - type: integer
          - type: 'null'
          title: Override Job Max Runtime S
        num_workers:
          anyOf:
          - type: integer
          - type: 'null'
          title: Num Workers
          default: 1
      type: object
      required:
      - id
      - created_by
      - owner
      - created_at
      - status
      title: DockerImageBatchJob
      description: 'This is the entity-layer class for a Docker Image Batch Job, i.e. a batch job

        created via the "supply a docker image for a k8s job" API.'
    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
  securitySchemes:
    HTTPBasic:
      type: http
      scheme: basic
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: token

Scale AI Docker Image Batch Jobs API

Operations 4

Documentation

Specifications

SDKs

Schemas & Data