Create Batch

POST

batches

Create a batch

curl --request POST \
  --url https://api.morphllm.com/v1/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input_file_id": "file_9c2c1c3e-5b6a-4f0e-8d0f-2a1b3c4d5e6f",
  "endpoint": "/v1/chat/completions",
  "completion_window": "24h",
  "metadata": {
    "job": "nightly-summaries"
  }
}
'

import requests

url = "https://api.morphllm.com/v1/batches"

payload = {
    "input_file_id": "file_9c2c1c3e-5b6a-4f0e-8d0f-2a1b3c4d5e6f",
    "endpoint": "/v1/chat/completions",
    "completion_window": "24h",
    "metadata": { "job": "nightly-summaries" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    input_file_id: 'file_9c2c1c3e-5b6a-4f0e-8d0f-2a1b3c4d5e6f',
    endpoint: '/v1/chat/completions',
    completion_window: '24h',
    metadata: {job: 'nightly-summaries'}
  })
};

fetch('https://api.morphllm.com/v1/batches', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.morphllm.com/v1/batches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'input_file_id' => 'file_9c2c1c3e-5b6a-4f0e-8d0f-2a1b3c4d5e6f',
    'endpoint' => '/v1/chat/completions',
    'completion_window' => '24h',
    'metadata' => [
        'job' => 'nightly-summaries'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.morphllm.com/v1/batches"

	payload := strings.NewReader("{\n  \"input_file_id\": \"file_9c2c1c3e-5b6a-4f0e-8d0f-2a1b3c4d5e6f\",\n  \"endpoint\": \"/v1/chat/completions\",\n  \"completion_window\": \"24h\",\n  \"metadata\": {\n    \"job\": \"nightly-summaries\"\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(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.morphllm.com/v1/batches")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"input_file_id\": \"file_9c2c1c3e-5b6a-4f0e-8d0f-2a1b3c4d5e6f\",\n  \"endpoint\": \"/v1/chat/completions\",\n  \"completion_window\": \"24h\",\n  \"metadata\": {\n    \"job\": \"nightly-summaries\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.morphllm.com/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  \"input_file_id\": \"file_9c2c1c3e-5b6a-4f0e-8d0f-2a1b3c4d5e6f\",\n  \"endpoint\": \"/v1/chat/completions\",\n  \"completion_window\": \"24h\",\n  \"metadata\": {\n    \"job\": \"nightly-summaries\"\n  }\n}"

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

{
  "id": "batch_5f4e3d2c-1b0a-4f9e-8d7c-6b5a4f3e2d1c",
  "object": "batch",
  "endpoint": "/v1/chat/completions",
  "input_file_id": "file_9c2c1c3e-5b6a-4f0e-8d0f-2a1b3c4d5e6f",
  "completion_window": "24h",
  "metadata": {
    "job": "nightly-summaries"
  },
  "created_at": 1780000000,
  "status": "validating",
  "model": "morph-glm53flash",
  "output_file_id": null,
  "error_file_id": null,
  "in_progress_at": null,
  "finalizing_at": null,
  "completed_at": null,
  "failed_at": null,
  "expired_at": null,
  "expires_at": 1780086400,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 0,
    "completed": 0,
    "failed": 0
  },
  "errors": null,
  "usage": null
}

{
  "error": {
    "code": "invalid_request_error",
    "message": "The request body is missing the `model` field."
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key provided."
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry in 12 seconds."
  }
}

{
  "error": {
    "code": "internal_error",
    "message": "Something went wrong on our side."
  }
}

Overview

Creates a batch over a file uploaded with purpose: batch and returns it in validating. Poll GET /v1/batches/{batch_id} until status is terminal. Every line must target /v1/chat/completions and name the same model, custom_id must be unique within the file, and stream: true is rejected. Completed requests are billed at half the model’s synchronous rate; see the Batch guide for the full contract.

Authorizations

Authorization

string

header

required

Morph API key, passed as Authorization: Bearer sk-.... Create keys at https://www.morphllm.com/dashboard/api-keys.

Body

application/json

Which file to process and how long to keep its results.

Start a batch over an uploaded input file.

input_file_id

string

required

Id of a file uploaded with purpose: batch.

Example:

"file_9c2c1c3e-5b6a-4f0e-8d0f-2a1b3c4d5e6f"

endpoint

enum<string>

required

Must be /v1/chat/completions; every input line must use the same url.

Available options:

/v1/chat/completions

Example:

"/v1/chat/completions"

completion_window

enum<string>

required

Must be 24h. Requests not finished by then are expired, and the completed ones are still returned.

Available options:

24h

Example:

"24h"

metadata

object

Up to 16 string pairs to tag the batch. Keys up to 64 characters, values up to 512.

Show child attributes

Example:

{ "job": "nightly-summaries" }

output_expires_after

object

Expiry policy for the output and error files. Defaults to 30 days.

Show child attributes

Example:

{ "anchor": "created_at", "seconds": 604800 }

Response

The new batch, in validating.

A batch and where it is in its lifecycle.

string

required

Batch identifier, batch_ prefixed.

Example:

"batch_5f4e3d2c-1b0a-4f9e-8d7c-6b5a4f3e2d1c"

object

string

required

Object type, always batch.

Example:

"batch"

endpoint

string

required

The endpoint every line targets. Always /v1/chat/completions.

Example:

"/v1/chat/completions"

input_file_id

string

required

The file the batch reads its requests from.

Example:

"file_9c2c1c3e-5b6a-4f0e-8d0f-2a1b3c4d5e6f"

completion_window

string

required

Always 24h. Requests still queued when the window closes are written to the error file as batch_expired.

Example:

"24h"

metadata

object | null

required

The key-value pairs you attached at creation, or null.

Show child attributes

Example:

{ "job": "nightly-summaries" }

created_at

integer

required

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

Example:

1780000000

status

enum<string>

required

Lifecycle state. completed, failed, expired, and cancelled are terminal. expired and cancelled batches still expose partial output.

Available options:

validating,

in_progress,

finalizing,

completed,

failed,

expired,

cancelling,

cancelled

Example:

"in_progress"

output_file_id

string | null

required

File holding one BatchOutputLine per request the model answered. Set once the batch is terminal; null before that and when nothing completed.

Example:

null

error_file_id

string | null

required

File holding one BatchErrorLine per request that never got a model response. Set once the batch is terminal; null before that and when nothing failed.

Example:

null

in_progress_at

integer | null

required

Unix timestamp (seconds) for when processing started. null until it happens.

Example:

1780000012

finalizing_at

integer | null

required

Unix timestamp (seconds) for when output files started being written. null until it happens.

Example:

null

completed_at

integer | null

required

Unix timestamp (seconds) for when the batch completed. null until it happens.

Example:

null

failed_at

integer | null

required

Unix timestamp (seconds) for when the batch failed. null until it happens.

Example:

null

expired_at

integer | null

required

Unix timestamp (seconds) for when the batch expired. null until it happens.

Example:

null

expires_at

integer | null

required

Unix timestamp (seconds) for when the completion window closes. null until it happens.

Example:

1780086400

cancelling_at

integer | null

required

Unix timestamp (seconds) for when cancellation was requested. null until it happens.

Example:

null

cancelled_at

integer | null

required

Unix timestamp (seconds) for when cancellation finished. null until it happens.

Example:

null

request_counts

object

required

Progress counters. Advance while the batch is in_progress; final once it is terminal.

Show child attributes

Example:

{ "total": 2, "completed": 1, "failed": 0 }

errors

object | null

required

Why the batch failed validation, or null.

Show child attributes

Example:

null

usage

object | null

required

Token totals so far, or null before any request has completed.

Show child attributes

Example:

{
  "input_tokens": 824,
  "input_tokens_details": { "cached_tokens": 0 },
  "output_tokens": 36,
  "output_tokens_details": { "reasoning_tokens": 0 },
  "total_tokens": 860
}

model

string

The model the batch runs on, once validation has read it from the input file.

Example:

"morph-glm53flash"

Create a batch

curl --request POST \
  --url https://api.morphllm.com/v1/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input_file_id": "file_9c2c1c3e-5b6a-4f0e-8d0f-2a1b3c4d5e6f",
  "endpoint": "/v1/chat/completions",
  "completion_window": "24h",
  "metadata": {
    "job": "nightly-summaries"
  }
}
'

import requests

url = "https://api.morphllm.com/v1/batches"

payload = {
    "input_file_id": "file_9c2c1c3e-5b6a-4f0e-8d0f-2a1b3c4d5e6f",
    "endpoint": "/v1/chat/completions",
    "completion_window": "24h",
    "metadata": { "job": "nightly-summaries" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    input_file_id: 'file_9c2c1c3e-5b6a-4f0e-8d0f-2a1b3c4d5e6f',
    endpoint: '/v1/chat/completions',
    completion_window: '24h',
    metadata: {job: 'nightly-summaries'}
  })
};

fetch('https://api.morphllm.com/v1/batches', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.morphllm.com/v1/batches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'input_file_id' => 'file_9c2c1c3e-5b6a-4f0e-8d0f-2a1b3c4d5e6f',
    'endpoint' => '/v1/chat/completions',
    'completion_window' => '24h',
    'metadata' => [
        'job' => 'nightly-summaries'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.morphllm.com/v1/batches"

	payload := strings.NewReader("{\n  \"input_file_id\": \"file_9c2c1c3e-5b6a-4f0e-8d0f-2a1b3c4d5e6f\",\n  \"endpoint\": \"/v1/chat/completions\",\n  \"completion_window\": \"24h\",\n  \"metadata\": {\n    \"job\": \"nightly-summaries\"\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(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.morphllm.com/v1/batches")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"input_file_id\": \"file_9c2c1c3e-5b6a-4f0e-8d0f-2a1b3c4d5e6f\",\n  \"endpoint\": \"/v1/chat/completions\",\n  \"completion_window\": \"24h\",\n  \"metadata\": {\n    \"job\": \"nightly-summaries\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.morphllm.com/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  \"input_file_id\": \"file_9c2c1c3e-5b6a-4f0e-8d0f-2a1b3c4d5e6f\",\n  \"endpoint\": \"/v1/chat/completions\",\n  \"completion_window\": \"24h\",\n  \"metadata\": {\n    \"job\": \"nightly-summaries\"\n  }\n}"

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

{
  "id": "batch_5f4e3d2c-1b0a-4f9e-8d7c-6b5a4f3e2d1c",
  "object": "batch",
  "endpoint": "/v1/chat/completions",
  "input_file_id": "file_9c2c1c3e-5b6a-4f0e-8d0f-2a1b3c4d5e6f",
  "completion_window": "24h",
  "metadata": {
    "job": "nightly-summaries"
  },
  "created_at": 1780000000,
  "status": "validating",
  "model": "morph-glm53flash",
  "output_file_id": null,
  "error_file_id": null,
  "in_progress_at": null,
  "finalizing_at": null,
  "completed_at": null,
  "failed_at": null,
  "expired_at": null,
  "expires_at": 1780086400,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 0,
    "completed": 0,
    "failed": 0
  },
  "errors": null,
  "usage": null
}

{
  "error": {
    "code": "invalid_request_error",
    "message": "The request body is missing the `model` field."
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key provided."
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry in 12 seconds."
  }
}

{
  "error": {
    "code": "internal_error",
    "message": "Something went wrong on our side."
  }
}

Get Started

Models

API Reference

Integrations

Overview

Authorizations

Body

Response

​Overview

Authorizations

Body

Response

Overview