custom_id

API

Definition

A field in the Message Batches API request body that lets you correlate each batch request with its response. Must be unique within a batch. Essential for matching asynchronous results back to originating requests when processing thousands of items.

Example Usage

Set custom_id to the PR number or file path so you can match batch results back to the correct review target when results arrive hours later.

Related Concepts

Batch Processing Strategy & API Selection

Prompt Engineering

Batch API saves 50% but has up to 24-hour processing with no latency SLA

Related Terms

Message Batches API

← Back to Glossary