Batches

Create batch

$ openai batches create

post /batches

Create batch

Parameters

--completion-window: "24h"

The time frame within which the batch should be processed. Currently only 24h is supported.
--endpoint: "/v1/responses" or "/v1/chat/completions" or "/v1/embeddings" or 5 more

The endpoint to be used for all requests in the batch. Currently /v1/responses, /v1/chat/completions, /v1/embeddings, /v1/completions, /v1/moderations, /v1/images/generations, /v1/images/edits, and /v1/videos are supported. Note that /v1/embeddings batches are also restricted to a maximum of 50,000 embedding inputs across all requests in the batch.
--input-file-id: string

The ID of an uploaded file that contains requests for the new batch.

See upload file for how to upload a file.

Your input file must be formatted as a JSONL file, and must be uploaded with the purpose batch. The file can contain up to 50,000 requests, and can be up to 200 MB in size.
--metadata: optional map[string]

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
--output-expires-after: optional object { anchor, seconds }

The expiration policy for the output and/or error file that are generated for a batch.

Returns

batch: object { id, completion_window, created_at, 19 more }
- id: string
- completion_window: string
  
  The time frame within which the batch should be processed.
- created_at: number
  
  The Unix timestamp (in seconds) for when the batch was created.
- endpoint: string
  
  The OpenAI API endpoint used by the batch.
- input_file_id: string
  
  The ID of the input file for the batch.
- object: "batch"
  
  The object type, which is always batch.
- status: "validating" or "failed" or "in_progress" or 5 more
  
  The current status of the batch.
  - "validating"
  - "failed"
  - "in_progress"
  - "finalizing"
  - "completed"
  - "expired"
  - "cancelling"
  - "cancelled"
- cancelled_at: optional number
  
  The Unix timestamp (in seconds) for when the batch was cancelled.
- cancelling_at: optional number
  
  The Unix timestamp (in seconds) for when the batch started cancelling.
- completed_at: optional number
  
  The Unix timestamp (in seconds) for when the batch was completed.
- error_file_id: optional string
  
  The ID of the file containing the outputs of requests with errors.
- errors: optional object { data, object }
  - data: optional array of unknown
  - object: optional string
    
    The object type, which is always list.
- expired_at: optional number
  
  The Unix timestamp (in seconds) for when the batch expired.
- expires_at: optional number
  
  The Unix timestamp (in seconds) for when the batch will expire.
- failed_at: optional number
  
  The Unix timestamp (in seconds) for when the batch failed.
- finalizing_at: optional number
  
  The Unix timestamp (in seconds) for when the batch started finalizing.
- in_progress_at: optional number
  
  The Unix timestamp (in seconds) for when the batch started processing.
- metadata: optional map[string]
  
  Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.
  
  Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
- model: optional string
  
  Model ID used to process the batch, like gpt-5-2025-08-07. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.
- output_file_id: optional string
  
  The ID of the file containing the outputs of successfully executed requests.
- request_counts: optional unknown
- usage: optional object { input_tokens, input_tokens_details, output_tokens, 2 more }
  
  Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. Only populated on batches created after September 7, 2025.
  - input_tokens: number
    
    The number of input tokens.
  - input_tokens_details: object { cached_tokens }
    
    A detailed breakdown of the input tokens.
    - cached_tokens: number
      
      The number of tokens that were retrieved from the cache. More on prompt caching.
  - output_tokens: number
    
    The number of output tokens.
  - output_tokens_details: object { reasoning_tokens }
    
    A detailed breakdown of the output tokens.
    - reasoning_tokens: number
      
      The number of reasoning tokens.
  - total_tokens: number
    
    The total number of tokens used.

Example

openai batches create \
  --api-key 'My API Key' \
  --completion-window 24h \
  --endpoint /v1/responses \
  --input-file-id input_file_id

Response

{
  "id": "id",
  "completion_window": "completion_window",
  "created_at": 0,
  "endpoint": "endpoint",
  "input_file_id": "input_file_id",
  "object": "batch",
  "status": "validating",
  "cancelled_at": 0,
  "cancelling_at": 0,
  "completed_at": 0,
  "error_file_id": "error_file_id",
  "errors": {
    "data": [
      {}
    ],
    "object": "object"
  },
  "expired_at": 0,
  "expires_at": 0,
  "failed_at": 0,
  "finalizing_at": 0,
  "in_progress_at": 0,
  "metadata": {
    "foo": "string"
  },
  "model": "model",
  "output_file_id": "output_file_id",
  "request_counts": {},
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 0,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 0
  }
}

Retrieve batch

$ openai batches retrieve

get /batches/{batch_id}

Retrieve batch

Parameters

--batch-id: string

The ID of the batch to retrieve.

Returns

batch: object { id, completion_window, created_at, 19 more }
- id: string
- completion_window: string
  
  The time frame within which the batch should be processed.
- created_at: number
  
  The Unix timestamp (in seconds) for when the batch was created.
- endpoint: string
  
  The OpenAI API endpoint used by the batch.
- input_file_id: string
  
  The ID of the input file for the batch.
- object: "batch"
  
  The object type, which is always batch.
- status: "validating" or "failed" or "in_progress" or 5 more
  
  The current status of the batch.
  - "validating"
  - "failed"
  - "in_progress"
  - "finalizing"
  - "completed"
  - "expired"
  - "cancelling"
  - "cancelled"
- cancelled_at: optional number
  
  The Unix timestamp (in seconds) for when the batch was cancelled.
- cancelling_at: optional number
  
  The Unix timestamp (in seconds) for when the batch started cancelling.
- completed_at: optional number
  
  The Unix timestamp (in seconds) for when the batch was completed.
- error_file_id: optional string
  
  The ID of the file containing the outputs of requests with errors.
- errors: optional object { data, object }
  - data: optional array of unknown
  - object: optional string
    
    The object type, which is always list.
- expired_at: optional number
  
  The Unix timestamp (in seconds) for when the batch expired.
- expires_at: optional number
  
  The Unix timestamp (in seconds) for when the batch will expire.
- failed_at: optional number
  
  The Unix timestamp (in seconds) for when the batch failed.
- finalizing_at: optional number
  
  The Unix timestamp (in seconds) for when the batch started finalizing.
- in_progress_at: optional number
  
  The Unix timestamp (in seconds) for when the batch started processing.
- metadata: optional map[string]
  
  Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.
  
  Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
- model: optional string
  
  Model ID used to process the batch, like gpt-5-2025-08-07. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.
- output_file_id: optional string
  
  The ID of the file containing the outputs of successfully executed requests.
- request_counts: optional unknown
- usage: optional object { input_tokens, input_tokens_details, output_tokens, 2 more }
  
  Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. Only populated on batches created after September 7, 2025.
  - input_tokens: number
    
    The number of input tokens.
  - input_tokens_details: object { cached_tokens }
    
    A detailed breakdown of the input tokens.
    - cached_tokens: number
      
      The number of tokens that were retrieved from the cache. More on prompt caching.
  - output_tokens: number
    
    The number of output tokens.
  - output_tokens_details: object { reasoning_tokens }
    
    A detailed breakdown of the output tokens.
    - reasoning_tokens: number
      
      The number of reasoning tokens.
  - total_tokens: number
    
    The total number of tokens used.

Example

openai batches retrieve \
  --api-key 'My API Key' \
  --batch-id batch_id

Response

{
  "id": "id",
  "completion_window": "completion_window",
  "created_at": 0,
  "endpoint": "endpoint",
  "input_file_id": "input_file_id",
  "object": "batch",
  "status": "validating",
  "cancelled_at": 0,
  "cancelling_at": 0,
  "completed_at": 0,
  "error_file_id": "error_file_id",
  "errors": {
    "data": [
      {}
    ],
    "object": "object"
  },
  "expired_at": 0,
  "expires_at": 0,
  "failed_at": 0,
  "finalizing_at": 0,
  "in_progress_at": 0,
  "metadata": {
    "foo": "string"
  },
  "model": "model",
  "output_file_id": "output_file_id",
  "request_counts": {},
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 0,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 0
  }
}

Cancel batch

$ openai batches cancel

post /batches/{batch_id}/cancel

Cancel batch

Parameters

--batch-id: string

The ID of the batch to cancel.

Returns

batch: object { id, completion_window, created_at, 19 more }
- id: string
- completion_window: string
  
  The time frame within which the batch should be processed.
- created_at: number
  
  The Unix timestamp (in seconds) for when the batch was created.
- endpoint: string
  
  The OpenAI API endpoint used by the batch.
- input_file_id: string
  
  The ID of the input file for the batch.
- object: "batch"
  
  The object type, which is always batch.
- status: "validating" or "failed" or "in_progress" or 5 more
  
  The current status of the batch.
  - "validating"
  - "failed"
  - "in_progress"
  - "finalizing"
  - "completed"
  - "expired"
  - "cancelling"
  - "cancelled"
- cancelled_at: optional number
  
  The Unix timestamp (in seconds) for when the batch was cancelled.
- cancelling_at: optional number
  
  The Unix timestamp (in seconds) for when the batch started cancelling.
- completed_at: optional number
  
  The Unix timestamp (in seconds) for when the batch was completed.
- error_file_id: optional string
  
  The ID of the file containing the outputs of requests with errors.
- errors: optional object { data, object }
  - data: optional array of unknown
  - object: optional string
    
    The object type, which is always list.
- expired_at: optional number
  
  The Unix timestamp (in seconds) for when the batch expired.
- expires_at: optional number
  
  The Unix timestamp (in seconds) for when the batch will expire.
- failed_at: optional number
  
  The Unix timestamp (in seconds) for when the batch failed.
- finalizing_at: optional number
  
  The Unix timestamp (in seconds) for when the batch started finalizing.
- in_progress_at: optional number
  
  The Unix timestamp (in seconds) for when the batch started processing.
- metadata: optional map[string]
  
  Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.
  
  Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
- model: optional string
  
  Model ID used to process the batch, like gpt-5-2025-08-07. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.
- output_file_id: optional string
  
  The ID of the file containing the outputs of successfully executed requests.
- request_counts: optional unknown
- usage: optional object { input_tokens, input_tokens_details, output_tokens, 2 more }
  
  Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. Only populated on batches created after September 7, 2025.
  - input_tokens: number
    
    The number of input tokens.
  - input_tokens_details: object { cached_tokens }
    
    A detailed breakdown of the input tokens.
    - cached_tokens: number
      
      The number of tokens that were retrieved from the cache. More on prompt caching.
  - output_tokens: number
    
    The number of output tokens.
  - output_tokens_details: object { reasoning_tokens }
    
    A detailed breakdown of the output tokens.
    - reasoning_tokens: number
      
      The number of reasoning tokens.
  - total_tokens: number
    
    The total number of tokens used.

Example

openai batches cancel \
  --api-key 'My API Key' \
  --batch-id batch_id

Response

{
  "id": "id",
  "completion_window": "completion_window",
  "created_at": 0,
  "endpoint": "endpoint",
  "input_file_id": "input_file_id",
  "object": "batch",
  "status": "validating",
  "cancelled_at": 0,
  "cancelling_at": 0,
  "completed_at": 0,
  "error_file_id": "error_file_id",
  "errors": {
    "data": [
      {}
    ],
    "object": "object"
  },
  "expired_at": 0,
  "expires_at": 0,
  "failed_at": 0,
  "finalizing_at": 0,
  "in_progress_at": 0,
  "metadata": {
    "foo": "string"
  },
  "model": "model",
  "output_file_id": "output_file_id",
  "request_counts": {},
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 0,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 0
  }
}

List batches

$ openai batches list

get /batches

List batches

Parameters

--after: optional string

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
--limit: optional number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

Returns

ListBatchesResponse: object { data, has_more, object, 2 more }
- data: array of Batch
  - id: string
  - completion_window: string
    
    The time frame within which the batch should be processed.
  - created_at: number
    
    The Unix timestamp (in seconds) for when the batch was created.
  - endpoint: string
    
    The OpenAI API endpoint used by the batch.
  - input_file_id: string
    
    The ID of the input file for the batch.
  - object: "batch"
    
    The object type, which is always batch.
  - status: "validating" or "failed" or "in_progress" or 5 more
    
    The current status of the batch.
    - "validating"
    - "failed"
    - "in_progress"
    - "finalizing"
    - "completed"
    - "expired"
    - "cancelling"
    - "cancelled"
  - cancelled_at: optional number
    
    The Unix timestamp (in seconds) for when the batch was cancelled.
  - cancelling_at: optional number
    
    The Unix timestamp (in seconds) for when the batch started cancelling.
  - completed_at: optional number
    
    The Unix timestamp (in seconds) for when the batch was completed.
  - error_file_id: optional string
    
    The ID of the file containing the outputs of requests with errors.
  - errors: optional object { data, object }
    - data: optional array of unknown
    - object: optional string
      
      The object type, which is always list.
  - expired_at: optional number
    
    The Unix timestamp (in seconds) for when the batch expired.
  - expires_at: optional number
    
    The Unix timestamp (in seconds) for when the batch will expire.
  - failed_at: optional number
    
    The Unix timestamp (in seconds) for when the batch failed.
  - finalizing_at: optional number
    
    The Unix timestamp (in seconds) for when the batch started finalizing.
  - in_progress_at: optional number
    
    The Unix timestamp (in seconds) for when the batch started processing.
  - metadata: optional map[string]
    
    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.
    
    Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
  - model: optional string
    
    Model ID used to process the batch, like gpt-5-2025-08-07. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.
  - output_file_id: optional string
    
    The ID of the file containing the outputs of successfully executed requests.
  - request_counts: optional unknown
  - usage: optional object { input_tokens, input_tokens_details, output_tokens, 2 more }
    
    Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. Only populated on batches created after September 7, 2025.
    - input_tokens: number
      
      The number of input tokens.
    - input_tokens_details: object { cached_tokens }
      
      A detailed breakdown of the input tokens.
      - cached_tokens: number
        
        The number of tokens that were retrieved from the cache. More on prompt caching.
    - output_tokens: number
      
      The number of output tokens.
    - output_tokens_details: object { reasoning_tokens }
      
      A detailed breakdown of the output tokens.
      - reasoning_tokens: number
        
        The number of reasoning tokens.
    - total_tokens: number
      
      The total number of tokens used.
- has_more: boolean
- object: "list"
- first_id: optional string
- last_id: optional string

Example

openai batches list \
  --api-key 'My API Key'

Response

{
  "data": [
    {
      "id": "id",
      "completion_window": "completion_window",
      "created_at": 0,
      "endpoint": "endpoint",
      "input_file_id": "input_file_id",
      "object": "batch",
      "status": "validating",
      "cancelled_at": 0,
      "cancelling_at": 0,
      "completed_at": 0,
      "error_file_id": "error_file_id",
      "errors": {
        "data": [
          {}
        ],
        "object": "object"
      },
      "expired_at": 0,
      "expires_at": 0,
      "failed_at": 0,
      "finalizing_at": 0,
      "in_progress_at": 0,
      "metadata": {
        "foo": "string"
      },
      "model": "model",
      "output_file_id": "output_file_id",
      "request_counts": {},
      "usage": {
        "input_tokens": 0,
        "input_tokens_details": {
          "cached_tokens": 0
        },
        "output_tokens": 0,
        "output_tokens_details": {
          "reasoning_tokens": 0
        },
        "total_tokens": 0
      }
    }
  ],
  "has_more": true,
  "object": "list",
  "first_id": "batch_abc123",
  "last_id": "batch_abc456"
}

Domain Types

Batch

batch: object { id, completion_window, created_at, 19 more }
- id: string
- completion_window: string
  
  The time frame within which the batch should be processed.
- created_at: number
  
  The Unix timestamp (in seconds) for when the batch was created.
- endpoint: string
  
  The OpenAI API endpoint used by the batch.
- input_file_id: string
  
  The ID of the input file for the batch.
- object: "batch"
  
  The object type, which is always batch.
- status: "validating" or "failed" or "in_progress" or 5 more
  
  The current status of the batch.
  - "validating"
  - "failed"
  - "in_progress"
  - "finalizing"
  - "completed"
  - "expired"
  - "cancelling"
  - "cancelled"
- cancelled_at: optional number
  
  The Unix timestamp (in seconds) for when the batch was cancelled.
- cancelling_at: optional number
  
  The Unix timestamp (in seconds) for when the batch started cancelling.
- completed_at: optional number
  
  The Unix timestamp (in seconds) for when the batch was completed.
- error_file_id: optional string
  
  The ID of the file containing the outputs of requests with errors.
- errors: optional object { data, object }
  - data: optional array of unknown
  - object: optional string
    
    The object type, which is always list.
- expired_at: optional number
  
  The Unix timestamp (in seconds) for when the batch expired.
- expires_at: optional number
  
  The Unix timestamp (in seconds) for when the batch will expire.
- failed_at: optional number
  
  The Unix timestamp (in seconds) for when the batch failed.
- finalizing_at: optional number
  
  The Unix timestamp (in seconds) for when the batch started finalizing.
- in_progress_at: optional number
  
  The Unix timestamp (in seconds) for when the batch started processing.
- metadata: optional map[string]
  
  Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.
  
  Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
- model: optional string
  
  Model ID used to process the batch, like gpt-5-2025-08-07. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.
- output_file_id: optional string
  
  The ID of the file containing the outputs of successfully executed requests.
- request_counts: optional unknown
- usage: optional object { input_tokens, input_tokens_details, output_tokens, 2 more }
  
  Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. Only populated on batches created after September 7, 2025.
  - input_tokens: number
    
    The number of input tokens.
  - input_tokens_details: object { cached_tokens }
    
    A detailed breakdown of the input tokens.
    - cached_tokens: number
      
      The number of tokens that were retrieved from the cache. More on prompt caching.
  - output_tokens: number
    
    The number of output tokens.
  - output_tokens_details: object { reasoning_tokens }
    
    A detailed breakdown of the output tokens.
    - reasoning_tokens: number
      
      The number of reasoning tokens.
  - total_tokens: number
    
    The total number of tokens used.

Batch Error

batch_error: unknown

Batch Request Counts

batch_request_counts: unknown

Batch Usage

batch_usage: object { input_tokens, input_tokens_details, output_tokens, 2 more }

Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. Only populated on batches created after September 7, 2025.
- input_tokens: number
  
  The number of input tokens.
- input_tokens_details: object { cached_tokens }
  
  A detailed breakdown of the input tokens.
  - cached_tokens: number
    
    The number of tokens that were retrieved from the cache. More on prompt caching.
- output_tokens: number
  
  The number of output tokens.
- output_tokens_details: object { reasoning_tokens }
  
  A detailed breakdown of the output tokens.
  - reasoning_tokens: number
    
    The number of reasoning tokens.
- total_tokens: number
  
  The total number of tokens used.

cli/resources/batches/index.md +1103 −0 created

1# Batches

3## Create batch

5`$ openai batches create`

7**post** `/batches`

9Create batch

11### Parameters

13- `--completion-window: "24h"`

15 The time frame within which the batch should be processed. Currently only `24h` is supported.

17- `--endpoint: "/v1/responses" or "/v1/chat/completions" or "/v1/embeddings" or 5 more`

19 The endpoint to be used for all requests in the batch. Currently `/v1/responses`, `/v1/chat/completions`, `/v1/embeddings`, `/v1/completions`, `/v1/moderations`, `/v1/images/generations`, `/v1/images/edits`, and `/v1/videos` are supported. Note that `/v1/embeddings` batches are also restricted to a maximum of 50,000 embedding inputs across all requests in the batch.

21- `--input-file-id: string`

23 The ID of an uploaded file that contains requests for the new batch.

25 See [upload file](https://platform.openai.com/docs/api-reference/files/create) for how to upload a file.

27 Your input file must be formatted as a [JSONL file](https://platform.openai.com/docs/api-reference/batch/request-input), and must be uploaded with the purpose `batch`. The file can contain up to 50,000 requests, and can be up to 200 MB in size.

29- `--metadata: optional map[string]`

31 Set of 16 key-value pairs that can be attached to an object. This can be

32 useful for storing additional information about the object in a structured

33 format, and querying for objects via API or the dashboard.

35 Keys are strings with a maximum length of 64 characters. Values are strings

36 with a maximum length of 512 characters.

38- `--output-expires-after: optional object { anchor, seconds }`

40 The expiration policy for the output and/or error file that are generated for a batch.

42### Returns

44- `batch: object { id, completion_window, created_at, 19 more }`

46 - `id: string`

48 - `completion_window: string`

50 The time frame within which the batch should be processed.

52 - `created_at: number`

54 The Unix timestamp (in seconds) for when the batch was created.

56 - `endpoint: string`

58 The OpenAI API endpoint used by the batch.

60 - `input_file_id: string`

62 The ID of the input file for the batch.

64 - `object: "batch"`

66 The object type, which is always `batch`.

68 - `status: "validating" or "failed" or "in_progress" or 5 more`

70 The current status of the batch.

72 - `"validating"`

74 - `"failed"`

76 - `"in_progress"`

78 - `"finalizing"`

80 - `"completed"`

82 - `"expired"`

84 - `"cancelling"`

86 - `"cancelled"`

88 - `cancelled_at: optional number`

90 The Unix timestamp (in seconds) for when the batch was cancelled.

92 - `cancelling_at: optional number`

94 The Unix timestamp (in seconds) for when the batch started cancelling.

96 - `completed_at: optional number`

98 The Unix timestamp (in seconds) for when the batch was completed.

100 - `error_file_id: optional string`

101

102 The ID of the file containing the outputs of requests with errors.

103

104 - `errors: optional object { data, object }`

105

106 - `data: optional array of unknown`

107

108 - `object: optional string`

109

110 The object type, which is always `list`.

111

112 - `expired_at: optional number`

113

114 The Unix timestamp (in seconds) for when the batch expired.

115

116 - `expires_at: optional number`

117

118 The Unix timestamp (in seconds) for when the batch will expire.

119

120 - `failed_at: optional number`

121

122 The Unix timestamp (in seconds) for when the batch failed.

123

124 - `finalizing_at: optional number`

125

126 The Unix timestamp (in seconds) for when the batch started finalizing.

127

128 - `in_progress_at: optional number`

129

130 The Unix timestamp (in seconds) for when the batch started processing.

131

132 - `metadata: optional map[string]`

133

134 Set of 16 key-value pairs that can be attached to an object. This can be

135 useful for storing additional information about the object in a structured

136 format, and querying for objects via API or the dashboard.

137

138 Keys are strings with a maximum length of 64 characters. Values are strings

139 with a maximum length of 512 characters.

140

141 - `model: optional string`

142

143 Model ID used to process the batch, like `gpt-5-2025-08-07`. OpenAI

144 offers a wide range of models with different capabilities, performance

145 characteristics, and price points. Refer to the [model

146 guide](https://platform.openai.com/docs/models) to browse and compare available models.

147

148 - `output_file_id: optional string`

149

150 The ID of the file containing the outputs of successfully executed requests.

151

152 - `request_counts: optional unknown`

153

154 - `usage: optional object { input_tokens, input_tokens_details, output_tokens, 2 more }`

155

156 Represents token usage details including input tokens, output tokens, a

157 breakdown of output tokens, and the total tokens used. Only populated on

158 batches created after September 7, 2025.

159

160 - `input_tokens: number`

161

162 The number of input tokens.

163

164 - `input_tokens_details: object { cached_tokens }`

165

166 A detailed breakdown of the input tokens.

167

168 - `cached_tokens: number`

169

170 The number of tokens that were retrieved from the cache. [More on

171 prompt caching](https://platform.openai.com/docs/guides/prompt-caching).

172

173 - `output_tokens: number`

174

175 The number of output tokens.

176

177 - `output_tokens_details: object { reasoning_tokens }`

178

179 A detailed breakdown of the output tokens.

180

181 - `reasoning_tokens: number`

182

183 The number of reasoning tokens.

184

185 - `total_tokens: number`

186

187 The total number of tokens used.

188

189### Example

190

191```cli

192openai batches create \

193 --api-key 'My API Key' \

194 --completion-window 24h \

195 --endpoint /v1/responses \

196 --input-file-id input_file_id

197```

198

199#### Response

200

201```json

202{

203 "id": "id",

204 "completion_window": "completion_window",

205 "created_at": 0,

206 "endpoint": "endpoint",

207 "input_file_id": "input_file_id",

208 "object": "batch",

209 "status": "validating",

210 "cancelled_at": 0,

211 "cancelling_at": 0,

212 "completed_at": 0,

213 "error_file_id": "error_file_id",

214 "errors": {

215 "data": [

216 {}

217 ],

218 "object": "object"

219 },

220 "expired_at": 0,

221 "expires_at": 0,

222 "failed_at": 0,

223 "finalizing_at": 0,

224 "in_progress_at": 0,

225 "metadata": {

226 "foo": "string"

227 },

228 "model": "model",

229 "output_file_id": "output_file_id",

230 "request_counts": {},

231 "usage": {

232 "input_tokens": 0,

233 "input_tokens_details": {

234 "cached_tokens": 0

235 },

236 "output_tokens": 0,

237 "output_tokens_details": {

238 "reasoning_tokens": 0

239 },

240 "total_tokens": 0

241 }

242}

243```

244

245## Retrieve batch

246

247`$ openai batches retrieve`

248

249**get** `/batches/{batch_id}`

250

251Retrieve batch

252

253### Parameters

254

255- `--batch-id: string`

256

257 The ID of the batch to retrieve.

258

259### Returns

260

261- `batch: object { id, completion_window, created_at, 19 more }`

262

263 - `id: string`

264

265 - `completion_window: string`

266

267 The time frame within which the batch should be processed.

268

269 - `created_at: number`

270

271 The Unix timestamp (in seconds) for when the batch was created.

272

273 - `endpoint: string`

274

275 The OpenAI API endpoint used by the batch.

276

277 - `input_file_id: string`

278

279 The ID of the input file for the batch.

280

281 - `object: "batch"`

282

283 The object type, which is always `batch`.

284

285 - `status: "validating" or "failed" or "in_progress" or 5 more`

286

287 The current status of the batch.

288

289 - `"validating"`

290

291 - `"failed"`

292

293 - `"in_progress"`

294

295 - `"finalizing"`

296

297 - `"completed"`

298

299 - `"expired"`

300

301 - `"cancelling"`

302

303 - `"cancelled"`

304

305 - `cancelled_at: optional number`

306

307 The Unix timestamp (in seconds) for when the batch was cancelled.

308

309 - `cancelling_at: optional number`

310

311 The Unix timestamp (in seconds) for when the batch started cancelling.

312

313 - `completed_at: optional number`

314

315 The Unix timestamp (in seconds) for when the batch was completed.

316

317 - `error_file_id: optional string`

318

319 The ID of the file containing the outputs of requests with errors.

320

321 - `errors: optional object { data, object }`

322

323 - `data: optional array of unknown`

324

325 - `object: optional string`

326

327 The object type, which is always `list`.

328

329 - `expired_at: optional number`

330

331 The Unix timestamp (in seconds) for when the batch expired.

332

333 - `expires_at: optional number`

334

335 The Unix timestamp (in seconds) for when the batch will expire.

336

337 - `failed_at: optional number`

338

339 The Unix timestamp (in seconds) for when the batch failed.

340

341 - `finalizing_at: optional number`

342

343 The Unix timestamp (in seconds) for when the batch started finalizing.

344

345 - `in_progress_at: optional number`

346

347 The Unix timestamp (in seconds) for when the batch started processing.

348

349 - `metadata: optional map[string]`

350

351 Set of 16 key-value pairs that can be attached to an object. This can be

352 useful for storing additional information about the object in a structured

353 format, and querying for objects via API or the dashboard.

354

355 Keys are strings with a maximum length of 64 characters. Values are strings

356 with a maximum length of 512 characters.

357

358 - `model: optional string`

359

360 Model ID used to process the batch, like `gpt-5-2025-08-07`. OpenAI

361 offers a wide range of models with different capabilities, performance

362 characteristics, and price points. Refer to the [model

363 guide](https://platform.openai.com/docs/models) to browse and compare available models.

364

365 - `output_file_id: optional string`

366

367 The ID of the file containing the outputs of successfully executed requests.

368

369 - `request_counts: optional unknown`

370

371 - `usage: optional object { input_tokens, input_tokens_details, output_tokens, 2 more }`

372

373 Represents token usage details including input tokens, output tokens, a

374 breakdown of output tokens, and the total tokens used. Only populated on

375 batches created after September 7, 2025.

376

377 - `input_tokens: number`

378

379 The number of input tokens.

380

381 - `input_tokens_details: object { cached_tokens }`

382

383 A detailed breakdown of the input tokens.

384

385 - `cached_tokens: number`

386

387 The number of tokens that were retrieved from the cache. [More on

388 prompt caching](https://platform.openai.com/docs/guides/prompt-caching).

389

390 - `output_tokens: number`

391

392 The number of output tokens.

393

394 - `output_tokens_details: object { reasoning_tokens }`

395

396 A detailed breakdown of the output tokens.

397

398 - `reasoning_tokens: number`

399

400 The number of reasoning tokens.

401

402 - `total_tokens: number`

403

404 The total number of tokens used.

405

406### Example

407

408```cli

409openai batches retrieve \

410 --api-key 'My API Key' \

411 --batch-id batch_id

412```

413

414#### Response

415

416```json

417{

418 "id": "id",

419 "completion_window": "completion_window",

420 "created_at": 0,

421 "endpoint": "endpoint",

422 "input_file_id": "input_file_id",

423 "object": "batch",

424 "status": "validating",

425 "cancelled_at": 0,

426 "cancelling_at": 0,

427 "completed_at": 0,

428 "error_file_id": "error_file_id",

429 "errors": {

430 "data": [

431 {}

432 ],

433 "object": "object"

434 },

435 "expired_at": 0,

436 "expires_at": 0,

437 "failed_at": 0,

438 "finalizing_at": 0,

439 "in_progress_at": 0,

440 "metadata": {

441 "foo": "string"

442 },

443 "model": "model",

444 "output_file_id": "output_file_id",

445 "request_counts": {},

446 "usage": {

447 "input_tokens": 0,

448 "input_tokens_details": {

449 "cached_tokens": 0

450 },

451 "output_tokens": 0,

452 "output_tokens_details": {

453 "reasoning_tokens": 0

454 },

455 "total_tokens": 0

456 }

457}

458```

459

460## Cancel batch

461

462`$ openai batches cancel`

463

464**post** `/batches/{batch_id}/cancel`

465

466Cancel batch

467

468### Parameters

469

470- `--batch-id: string`

471

472 The ID of the batch to cancel.

473

474### Returns

475

476- `batch: object { id, completion_window, created_at, 19 more }`

477

478 - `id: string`

479

480 - `completion_window: string`

481

482 The time frame within which the batch should be processed.

483

484 - `created_at: number`

485

486 The Unix timestamp (in seconds) for when the batch was created.

487

488 - `endpoint: string`

489

490 The OpenAI API endpoint used by the batch.

491

492 - `input_file_id: string`

493

494 The ID of the input file for the batch.

495

496 - `object: "batch"`

497

498 The object type, which is always `batch`.

499

500 - `status: "validating" or "failed" or "in_progress" or 5 more`

501

502 The current status of the batch.

503

504 - `"validating"`

505

506 - `"failed"`

507

508 - `"in_progress"`

509

510 - `"finalizing"`

511

512 - `"completed"`

513

514 - `"expired"`

515

516 - `"cancelling"`

517

518 - `"cancelled"`

519

520 - `cancelled_at: optional number`

521

522 The Unix timestamp (in seconds) for when the batch was cancelled.

523

524 - `cancelling_at: optional number`

525

526 The Unix timestamp (in seconds) for when the batch started cancelling.

527

528 - `completed_at: optional number`

529

530 The Unix timestamp (in seconds) for when the batch was completed.

531

532 - `error_file_id: optional string`

533

534 The ID of the file containing the outputs of requests with errors.

535

536 - `errors: optional object { data, object }`

537

538 - `data: optional array of unknown`

539

540 - `object: optional string`

541

542 The object type, which is always `list`.

543

544 - `expired_at: optional number`

545

546 The Unix timestamp (in seconds) for when the batch expired.

547

548 - `expires_at: optional number`

549

550 The Unix timestamp (in seconds) for when the batch will expire.

551

552 - `failed_at: optional number`

553

554 The Unix timestamp (in seconds) for when the batch failed.

555

556 - `finalizing_at: optional number`

557

558 The Unix timestamp (in seconds) for when the batch started finalizing.

559

560 - `in_progress_at: optional number`

561

562 The Unix timestamp (in seconds) for when the batch started processing.

563

564 - `metadata: optional map[string]`

565

566 Set of 16 key-value pairs that can be attached to an object. This can be

567 useful for storing additional information about the object in a structured

568 format, and querying for objects via API or the dashboard.

569

570 Keys are strings with a maximum length of 64 characters. Values are strings

571 with a maximum length of 512 characters.

572

573 - `model: optional string`

574

575 Model ID used to process the batch, like `gpt-5-2025-08-07`. OpenAI

576 offers a wide range of models with different capabilities, performance

577 characteristics, and price points. Refer to the [model

578 guide](https://platform.openai.com/docs/models) to browse and compare available models.

579

580 - `output_file_id: optional string`

581

582 The ID of the file containing the outputs of successfully executed requests.

583

584 - `request_counts: optional unknown`

585

586 - `usage: optional object { input_tokens, input_tokens_details, output_tokens, 2 more }`

587

588 Represents token usage details including input tokens, output tokens, a

589 breakdown of output tokens, and the total tokens used. Only populated on

590 batches created after September 7, 2025.

591

592 - `input_tokens: number`

593

594 The number of input tokens.

595

596 - `input_tokens_details: object { cached_tokens }`

597

598 A detailed breakdown of the input tokens.

599

600 - `cached_tokens: number`

601

602 The number of tokens that were retrieved from the cache. [More on

603 prompt caching](https://platform.openai.com/docs/guides/prompt-caching).

604

605 - `output_tokens: number`

606

607 The number of output tokens.

608

609 - `output_tokens_details: object { reasoning_tokens }`

610

611 A detailed breakdown of the output tokens.

612

613 - `reasoning_tokens: number`

614

615 The number of reasoning tokens.

616

617 - `total_tokens: number`

618

619 The total number of tokens used.

620

621### Example

622

623```cli

624openai batches cancel \

625 --api-key 'My API Key' \

626 --batch-id batch_id

627```

628

629#### Response

630

631```json

632{

633 "id": "id",

634 "completion_window": "completion_window",

635 "created_at": 0,

636 "endpoint": "endpoint",

637 "input_file_id": "input_file_id",

638 "object": "batch",

639 "status": "validating",

640 "cancelled_at": 0,

641 "cancelling_at": 0,

642 "completed_at": 0,

643 "error_file_id": "error_file_id",

644 "errors": {

645 "data": [

646 {}

647 ],

648 "object": "object"

649 },

650 "expired_at": 0,

651 "expires_at": 0,

652 "failed_at": 0,

653 "finalizing_at": 0,

654 "in_progress_at": 0,

655 "metadata": {

656 "foo": "string"

657 },

658 "model": "model",

659 "output_file_id": "output_file_id",

660 "request_counts": {},

661 "usage": {

662 "input_tokens": 0,

663 "input_tokens_details": {

664 "cached_tokens": 0

665 },

666 "output_tokens": 0,

667 "output_tokens_details": {

668 "reasoning_tokens": 0

669 },

670 "total_tokens": 0

671 }

672}

673```

674

675## List batches

676

677`$ openai batches list`

678

679**get** `/batches`

680

681List batches

682

683### Parameters

684

685- `--after: optional string`

686

687 A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

688

689- `--limit: optional number`

690

691 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

692

693### Returns

694

695- `ListBatchesResponse: object { data, has_more, object, 2 more }`

696

697 - `data: array of Batch`

698

699 - `id: string`

700

701 - `completion_window: string`

702

703 The time frame within which the batch should be processed.

704

705 - `created_at: number`

706

707 The Unix timestamp (in seconds) for when the batch was created.

708

709 - `endpoint: string`

710

711 The OpenAI API endpoint used by the batch.

712

713 - `input_file_id: string`

714

715 The ID of the input file for the batch.

716

717 - `object: "batch"`

718

719 The object type, which is always `batch`.

720

721 - `status: "validating" or "failed" or "in_progress" or 5 more`

722

723 The current status of the batch.

724

725 - `"validating"`

726

727 - `"failed"`

728

729 - `"in_progress"`

730

731 - `"finalizing"`

732

733 - `"completed"`

734

735 - `"expired"`

736

737 - `"cancelling"`

738

739 - `"cancelled"`

740

741 - `cancelled_at: optional number`

742

743 The Unix timestamp (in seconds) for when the batch was cancelled.

744

745 - `cancelling_at: optional number`

746

747 The Unix timestamp (in seconds) for when the batch started cancelling.

748

749 - `completed_at: optional number`

750

751 The Unix timestamp (in seconds) for when the batch was completed.

752

753 - `error_file_id: optional string`

754

755 The ID of the file containing the outputs of requests with errors.

756

757 - `errors: optional object { data, object }`

758

759 - `data: optional array of unknown`

760

761 - `object: optional string`

762

763 The object type, which is always `list`.

764

765 - `expired_at: optional number`

766

767 The Unix timestamp (in seconds) for when the batch expired.

768

769 - `expires_at: optional number`

770

771 The Unix timestamp (in seconds) for when the batch will expire.

772

773 - `failed_at: optional number`

774

775 The Unix timestamp (in seconds) for when the batch failed.

776

777 - `finalizing_at: optional number`

778

779 The Unix timestamp (in seconds) for when the batch started finalizing.

780

781 - `in_progress_at: optional number`

782

783 The Unix timestamp (in seconds) for when the batch started processing.

784

785 - `metadata: optional map[string]`

786

787 Set of 16 key-value pairs that can be attached to an object. This can be

788 useful for storing additional information about the object in a structured

789 format, and querying for objects via API or the dashboard.

790

791 Keys are strings with a maximum length of 64 characters. Values are strings

792 with a maximum length of 512 characters.

793

794 - `model: optional string`

795

796 Model ID used to process the batch, like `gpt-5-2025-08-07`. OpenAI

797 offers a wide range of models with different capabilities, performance

798 characteristics, and price points. Refer to the [model

799 guide](https://platform.openai.com/docs/models) to browse and compare available models.

800

801 - `output_file_id: optional string`

802

803 The ID of the file containing the outputs of successfully executed requests.

804

805 - `request_counts: optional unknown`

806

807 - `usage: optional object { input_tokens, input_tokens_details, output_tokens, 2 more }`

808

809 Represents token usage details including input tokens, output tokens, a

810 breakdown of output tokens, and the total tokens used. Only populated on

811 batches created after September 7, 2025.

812

813 - `input_tokens: number`

814

815 The number of input tokens.

816

817 - `input_tokens_details: object { cached_tokens }`

818

819 A detailed breakdown of the input tokens.

820

821 - `cached_tokens: number`

822

823 The number of tokens that were retrieved from the cache. [More on

824 prompt caching](https://platform.openai.com/docs/guides/prompt-caching).

825

826 - `output_tokens: number`

827

828 The number of output tokens.

829

830 - `output_tokens_details: object { reasoning_tokens }`

831

832 A detailed breakdown of the output tokens.

833

834 - `reasoning_tokens: number`

835

836 The number of reasoning tokens.

837

838 - `total_tokens: number`

839

840 The total number of tokens used.

841

842 - `has_more: boolean`

843

844 - `object: "list"`

845

846 - `first_id: optional string`

847

848 - `last_id: optional string`

849

850### Example

851

852```cli

853openai batches list \

854 --api-key 'My API Key'

855```

856

857#### Response

858

859```json

860{

861 "data": [

862 {

863 "id": "id",

864 "completion_window": "completion_window",

865 "created_at": 0,

866 "endpoint": "endpoint",

867 "input_file_id": "input_file_id",

868 "object": "batch",

869 "status": "validating",

870 "cancelled_at": 0,

871 "cancelling_at": 0,

872 "completed_at": 0,

873 "error_file_id": "error_file_id",

874 "errors": {

875 "data": [

876 {}

877 ],

878 "object": "object"

879 },

880 "expired_at": 0,

881 "expires_at": 0,

882 "failed_at": 0,

883 "finalizing_at": 0,

884 "in_progress_at": 0,

885 "metadata": {

886 "foo": "string"

887 },

888 "model": "model",

889 "output_file_id": "output_file_id",

890 "request_counts": {},

891 "usage": {

892 "input_tokens": 0,

893 "input_tokens_details": {

894 "cached_tokens": 0

895 },

896 "output_tokens": 0,

897 "output_tokens_details": {

898 "reasoning_tokens": 0

899 },

900 "total_tokens": 0

901 }

902 }

903 ],

904 "has_more": true,

905 "object": "list",

906 "first_id": "batch_abc123",

907 "last_id": "batch_abc456"

908}

909```

910

911## Domain Types

912

913### Batch

914

915- `batch: object { id, completion_window, created_at, 19 more }`

916

917 - `id: string`

918

919 - `completion_window: string`

920

921 The time frame within which the batch should be processed.

922

923 - `created_at: number`

924

925 The Unix timestamp (in seconds) for when the batch was created.

926

927 - `endpoint: string`

928

929 The OpenAI API endpoint used by the batch.

930

931 - `input_file_id: string`

932

933 The ID of the input file for the batch.

934

935 - `object: "batch"`

936

937 The object type, which is always `batch`.

938

939 - `status: "validating" or "failed" or "in_progress" or 5 more`

940

941 The current status of the batch.

942

943 - `"validating"`

944

945 - `"failed"`

946

947 - `"in_progress"`

948

949 - `"finalizing"`

950

951 - `"completed"`

952

953 - `"expired"`

954

955 - `"cancelling"`

956

957 - `"cancelled"`

958

959 - `cancelled_at: optional number`

960

961 The Unix timestamp (in seconds) for when the batch was cancelled.

962

963 - `cancelling_at: optional number`

964

965 The Unix timestamp (in seconds) for when the batch started cancelling.

966

967 - `completed_at: optional number`

968

969 The Unix timestamp (in seconds) for when the batch was completed.

970

971 - `error_file_id: optional string`

972

973 The ID of the file containing the outputs of requests with errors.

974

975 - `errors: optional object { data, object }`

976

977 - `data: optional array of unknown`

978

979 - `object: optional string`

980

981 The object type, which is always `list`.

982

983 - `expired_at: optional number`

984

985 The Unix timestamp (in seconds) for when the batch expired.

986

987 - `expires_at: optional number`

988

989 The Unix timestamp (in seconds) for when the batch will expire.

990

991 - `failed_at: optional number`

992

993 The Unix timestamp (in seconds) for when the batch failed.

994

995 - `finalizing_at: optional number`

996

997 The Unix timestamp (in seconds) for when the batch started finalizing.

998

999 - `in_progress_at: optional number`

1000

1001 The Unix timestamp (in seconds) for when the batch started processing.

1002

1003 - `metadata: optional map[string]`

1004

1005 Set of 16 key-value pairs that can be attached to an object. This can be

1006 useful for storing additional information about the object in a structured

1007 format, and querying for objects via API or the dashboard.

1008

1009 Keys are strings with a maximum length of 64 characters. Values are strings

1010 with a maximum length of 512 characters.

1011

1012 - `model: optional string`

1013

1014 Model ID used to process the batch, like `gpt-5-2025-08-07`. OpenAI

1015 offers a wide range of models with different capabilities, performance

1016 characteristics, and price points. Refer to the [model

1017 guide](https://platform.openai.com/docs/models) to browse and compare available models.

1018

1019 - `output_file_id: optional string`

1020

1021 The ID of the file containing the outputs of successfully executed requests.

1022

1023 - `request_counts: optional unknown`

1024

1025 - `usage: optional object { input_tokens, input_tokens_details, output_tokens, 2 more }`

1026

1027 Represents token usage details including input tokens, output tokens, a

1028 breakdown of output tokens, and the total tokens used. Only populated on

1029 batches created after September 7, 2025.

1030

1031 - `input_tokens: number`

1032

1033 The number of input tokens.

1034

1035 - `input_tokens_details: object { cached_tokens }`

1036

1037 A detailed breakdown of the input tokens.

1038

1039 - `cached_tokens: number`

1040

1041 The number of tokens that were retrieved from the cache. [More on

1042 prompt caching](https://platform.openai.com/docs/guides/prompt-caching).

1043

1044 - `output_tokens: number`

1045

1046 The number of output tokens.

1047

1048 - `output_tokens_details: object { reasoning_tokens }`

1049

1050 A detailed breakdown of the output tokens.

1051

1052 - `reasoning_tokens: number`

1053

1054 The number of reasoning tokens.

1055

1056 - `total_tokens: number`

1057

1058 The total number of tokens used.

1059

1060### Batch Error

1061

1062- `batch_error: unknown`

1063

1064### Batch Request Counts

1065

1066- `batch_request_counts: unknown`

1067

1068### Batch Usage

1069

1070- `batch_usage: object { input_tokens, input_tokens_details, output_tokens, 2 more }`

1071

1072 Represents token usage details including input tokens, output tokens, a

1073 breakdown of output tokens, and the total tokens used. Only populated on

1074 batches created after September 7, 2025.

1075

1076 - `input_tokens: number`

1077

1078 The number of input tokens.

1079

1080 - `input_tokens_details: object { cached_tokens }`

1081

1082 A detailed breakdown of the input tokens.

1083

1084 - `cached_tokens: number`

1085

1086 The number of tokens that were retrieved from the cache. [More on

1087 prompt caching](https://platform.openai.com/docs/guides/prompt-caching).

1088

1089 - `output_tokens: number`

1090

1091 The number of output tokens.

1092

1093 - `output_tokens_details: object { reasoning_tokens }`

1094

1095 A detailed breakdown of the output tokens.

1096

1097 - `reasoning_tokens: number`

1098

1099 The number of reasoning tokens.

1100

1101 - `total_tokens: number`

1102

1103 The total number of tokens used.

cli/resources/batches/index.md 2026-07-07 08:02 UTC to 2026-07-09 20:58 UTC

Batches

Create batch

Parameters

Returns

Example

Response

Retrieve batch

Parameters

Returns

Example

Response

Cancel batch

Parameters

Returns

Example

Response

List batches

Parameters

Returns

Example

Response

Domain Types

Batch

Batch Error

Batch Request Counts

Batch Usage