Scale AI

Scale AI Checkpoints API

The Checkpoints API from Scale AI — 5 operation(s) for checkpoints.

Documentation GitHub OpenAPI

Operations 5

POST /checkpoints/get-tuple Get Checkpoint Tuple #

POST /checkpoints/put Put Checkpoint #

POST /checkpoints/put-writes Put Writes #

POST /checkpoints/list List Checkpoints #

POST /checkpoints/delete-thread Delete Thread #

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-checkpoints-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: Agentex Checkpoints API
  version: 0.1.0
tags:
- name: Checkpoints
paths:
  /checkpoints/get-tuple:
    post:
      tags:
      - Checkpoints
      summary: Get Checkpoint Tuple
      operationId: get_checkpoint_tuple_checkpoints_get_tuple_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetCheckpointTupleRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/CheckpointTupleResponse'
                - type: 'null'
                title: Response Get Checkpoint Tuple Checkpoints Get Tuple Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /checkpoints/put:
    post:
      tags:
      - Checkpoints
      summary: Put Checkpoint
      operationId: put_checkpoint_checkpoints_put_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutCheckpointRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutCheckpointResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /checkpoints/put-writes:
    post:
      tags:
      - Checkpoints
      summary: Put Writes
      operationId: put_writes_checkpoints_put_writes_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutWritesRequest'
        required: true
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /checkpoints/list:
    post:
      tags:
      - Checkpoints
      summary: List Checkpoints
      operationId: list_checkpoints_checkpoints_list_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListCheckpointsRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CheckpointListItem'
                type: array
                title: Response List Checkpoints Checkpoints List Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /checkpoints/delete-thread:
    post:
      tags:
      - Checkpoints
      summary: Delete Thread
      operationId: delete_thread_checkpoints_delete_thread_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteThreadRequest'
        required: true
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ListCheckpointsRequest:
      properties:
        thread_id:
          type: string
          title: Thread ID
        checkpoint_ns:
          anyOf:
          - type: string
          - type: 'null'
          title: Checkpoint namespace
        before_checkpoint_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Before checkpoint ID
        filter_metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Metadata filter (JSONB @>)
        limit:
          type: integer
          maximum: 1000.0
          minimum: 1.0
          title: Max results
          default: 100
      type: object
      required:
      - thread_id
      title: ListCheckpointsRequest
    WriteResponse:
      properties:
        task_id:
          type: string
          title: Task Id
        idx:
          type: integer
          title: Idx
        channel:
          type: string
          title: Channel
        type:
          anyOf:
          - type: string
          - type: 'null'
          title: Type
        blob:
          anyOf:
          - type: string
          - type: 'null'
          title: Blob
      type: object
      required:
      - task_id
      - idx
      - channel
      title: WriteResponse
    BlobResponse:
      properties:
        channel:
          type: string
          title: Channel
        version:
          type: string
          title: Version
        type:
          type: string
          title: Type
        blob:
          anyOf:
          - type: string
          - type: 'null'
          title: Blob
      type: object
      required:
      - channel
      - version
      - type
      title: BlobResponse
    BlobData:
      properties:
        channel:
          type: string
          title: Channel name
        version:
          type: string
          title: Channel version
        type:
          type: string
          title: Serialization type tag
        blob:
          anyOf:
          - type: string
          - type: 'null'
          title: Base64-encoded binary data
      type: object
      required:
      - channel
      - version
      - type
      title: BlobData
    DeleteThreadRequest:
      properties:
        thread_id:
          type: string
          title: Thread ID
      type: object
      required:
      - thread_id
      title: DeleteThreadRequest
    WriteData:
      properties:
        task_id:
          type: string
          title: Task ID
        idx:
          type: integer
          title: Write index
        channel:
          type: string
          title: Channel name
        type:
          anyOf:
          - type: string
          - type: 'null'
          title: Serialization type tag
        blob:
          type: string
          title: Base64-encoded binary data
        task_path:
          type: string
          title: Task path
          default: ''
      type: object
      required:
      - task_id
      - idx
      - channel
      - blob
      title: WriteData
    PutWritesRequest:
      properties:
        thread_id:
          type: string
          title: Thread ID
        checkpoint_ns:
          type: string
          title: Checkpoint namespace
          default: ''
        checkpoint_id:
          type: string
          title: Checkpoint ID
        writes:
          items:
            $ref: '#/components/schemas/WriteData'
          type: array
          title: Write data
        upsert:
          type: boolean
          title: Upsert mode
          default: false
      type: object
      required:
      - thread_id
      - checkpoint_id
      - writes
      title: PutWritesRequest
    CheckpointTupleResponse:
      properties:
        thread_id:
          type: string
          title: Thread Id
        checkpoint_ns:
          type: string
          title: Checkpoint Ns
        checkpoint_id:
          type: string
          title: Checkpoint Id
        parent_checkpoint_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Parent Checkpoint Id
        checkpoint:
          additionalProperties: true
          type: object
          title: Checkpoint
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
        blobs:
          items:
            $ref: '#/components/schemas/BlobResponse'
          type: array
          title: Blobs
        pending_writes:
          items:
            $ref: '#/components/schemas/WriteResponse'
          type: array
          title: Pending Writes
      type: object
      required:
      - thread_id
      - checkpoint_ns
      - checkpoint_id
      - checkpoint
      - metadata
      title: CheckpointTupleResponse
    PutCheckpointRequest:
      properties:
        thread_id:
          type: string
          title: Thread ID
        checkpoint_ns:
          type: string
          title: Checkpoint namespace
          default: ''
        checkpoint_id:
          type: string
          title: Checkpoint ID
        parent_checkpoint_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Parent checkpoint ID
        checkpoint:
          additionalProperties: true
          type: object
          title: Checkpoint JSONB payload
        metadata:
          additionalProperties: true
          type: object
          title: Checkpoint metadata
        blobs:
          items:
            $ref: '#/components/schemas/BlobData'
          type: array
          title: Channel blob data
      type: object
      required:
      - thread_id
      - checkpoint_id
      - checkpoint
      title: PutCheckpointRequest
    GetCheckpointTupleRequest:
      properties:
        thread_id:
          type: string
          title: Thread ID
        checkpoint_ns:
          type: string
          title: Checkpoint namespace
          default: ''
        checkpoint_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Checkpoint ID (None = latest)
      type: object
      required:
      - thread_id
      title: GetCheckpointTupleRequest
    PutCheckpointResponse:
      properties:
        thread_id:
          type: string
          title: Thread Id
        checkpoint_ns:
          type: string
          title: Checkpoint Ns
        checkpoint_id:
          type: string
          title: Checkpoint Id
      type: object
      required:
      - thread_id
      - checkpoint_ns
      - checkpoint_id
      title: PutCheckpointResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
    CheckpointListItem:
      properties:
        thread_id:
          type: string
          title: Thread Id
        checkpoint_ns:
          type: string
          title: Checkpoint Ns
        checkpoint_id:
          type: string
          title: Checkpoint Id
        parent_checkpoint_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Parent Checkpoint Id
        checkpoint:
          additionalProperties: true
          type: object
          title: Checkpoint
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
      type: object
      required:
      - thread_id
      - checkpoint_ns
      - checkpoint_id
      - checkpoint
      - metadata
      title: CheckpointListItem

Scale AI Checkpoints API

Operations 5

Documentation

Specifications

SDKs

Schemas & Data