Claude · Schema

BatchRequestItem

A single request within a message batch.

Artificial IntelligenceChatbotConversational AIGenerative AILarge Language ModelsMachine LearningNatural Language Processing

Properties

Name	Type	Description
custom_id	string	Developer-provided identifier for this request. Must be unique within the batch. Used to match results to requests.
params	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BatchRequestItem",
  "title": "BatchRequestItem",
  "type": "object",
  "description": "A single request within a message batch.",
  "required": [
    "custom_id",
    "params"
  ],
  "properties": {
    "custom_id": {
      "type": "string",
      "description": "Developer-provided identifier for this request. Must be unique within the batch. Used to match results to requests.",
      "example": "request-1"
    },
    "params": {
      "$ref": "#/components/schemas/CreateMessageRequest"
    }
  }
}