> This page is for Gateway.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.merge.dev/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.merge.dev/_mcp/server.

# Create batch

POST https://api-gateway.merge.dev/v1/batches
Content-Type: application/json

Submit a batch of requests that run asynchronously on one model at batch rates.

Reference: https://docs.merge.dev/merge-gateway/api-overview/batches/create

## Authentication

- `Authorization` header (bearer token, required) — Your production key sent as a bearer token.

## Request

### Body (application/json)

This endpoint expects a BatchCreateRequestSchema.

- `endpoint` (string, required) — Request shape of every line: `/v1/chat/completions`, `/v1/embeddings`, `/v1/messages`, or `/v1/responses`.
- `model` (string, required) — Model every line runs on.
- `requests` (list of BatchRequestLineSchema, required) — Batch lines, each with a unique `custom_id`.
- `metadata` (map from string to any, optional, nullable) — Your metadata, echoed back unchanged.
- `provider` (BatchProviderSchema, optional, nullable) — Vendor restrictions for the batch, for example `{"only": ["anthropic"]}`.

## Response

### 202

The created batch.

- `id` (string, required) — Batch ID.
- `endpoint` (string, required) — Request shape of the batch lines.
- `model` (string, required) — Model the batch runs on.
- `status` (string, required) — One of `validating`, `in_progress`, `finalizing`, `cancelling`, `completed`, `failed`, `expired`, or `cancelled`.
- `request_counts` (map from string to integer, required) — Line counts by outcome.
- `created_at` (integer, required) — Unix timestamp in seconds.
- `expires_at` (integer, required) — Unix timestamp in seconds after which an unfinished batch expires.
- `object` ("batch", optional, default: batch)
- `completed_at` (integer, optional, nullable) — Unix timestamp in seconds when the batch finished.
- `usage` (map from string to any, optional, nullable) — Aggregate usage and cost, once known.
- `metadata` (map from string to any, optional, nullable) — Metadata you sent at creation.

## Errors

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

## Types

### BatchRequestLineSchema

One batch line.

- `custom_id` (string, required) — Your ID for this line, unique within the batch.
- `body` (map from string to any, required) — Request body in the shape the batch's `endpoint` accepts.

### BatchProviderSchema

Vendor restrictions for a batch; only `only` is supported and any other key returns 400.

- `only` (list of string, optional, nullable) — Vendors the batch may run on; narrows your organization's vendor restrictions and never widens them.

### ValidationError

Single field-level validation error. `loc` is the JSON path to the offending field, `msg` is a human-readable explanation, and `type` is a stable machine-readable error code.

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)
- `input` (any, optional)
- `ctx` (ValidationErrorCtx, optional)

### ValidationErrorLocItems

### ValidationErrorCtx

## Examples

**Request**

```json
{
  "endpoint": "string",
  "model": "string",
  "requests": [
    {
      "custom_id": "string",
      "body": {}
    }
  ]
}
```

**Response**

```json
{
  "id": "string",
  "endpoint": "string",
  "model": "string",
  "status": "string",
  "request_counts": {},
  "created_at": 1,
  "expires_at": 1,
  "object": "batch",
  "completed_at": 1,
  "usage": {},
  "metadata": {}
}
```

**SDK Code**

```python
import requests

url = "https://api-gateway.merge.dev/v1/batches"

payload = {
    "endpoint": "string",
    "model": "string",
    "requests": [
        {
            "custom_id": "string",
            "body": {}
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api-gateway.merge.dev/v1/batches';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"endpoint":"string","model":"string","requests":[{"custom_id":"string","body":{}}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-gateway.merge.dev/v1/batches"

	payload := strings.NewReader("{\n  \"endpoint\": \"string\",\n  \"model\": \"string\",\n  \"requests\": [\n    {\n      \"custom_id\": \"string\",\n      \"body\": {}\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api-gateway.merge.dev/v1/batches")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"endpoint\": \"string\",\n  \"model\": \"string\",\n  \"requests\": [\n    {\n      \"custom_id\": \"string\",\n      \"body\": {}\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api-gateway.merge.dev/v1/batches")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"endpoint\": \"string\",\n  \"model\": \"string\",\n  \"requests\": [\n    {\n      \"custom_id\": \"string\",\n      \"body\": {}\n    }\n  ]\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api-gateway.merge.dev/v1/batches', [
  'body' => '{
  "endpoint": "string",
  "model": "string",
  "requests": [
    {
      "custom_id": "string",
      "body": {}
    }
  ]
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api-gateway.merge.dev/v1/batches");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"endpoint\": \"string\",\n  \"model\": \"string\",\n  \"requests\": [\n    {\n      \"custom_id\": \"string\",\n      \"body\": {}\n    }\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "endpoint": "string",
  "model": "string",
  "requests": [
    [
      "custom_id": "string",
      "body": []
    ]
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api-gateway.merge.dev/v1/batches")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```