Retrieve Batch

GET

batches

{batch_id}

Retrieve a batch

curl --request GET \
  --url https://api.morphllm.com/v1/batches/{batch_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.morphllm.com/v1/batches/{batch_id}', 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/{batch_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.morphllm.com/v1/batches/{batch_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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": "completed",
  "model": "morph-glm53flash",
  "output_file_id": "file_0e7d6c5b-4a39-4281-9f7e-6d5c4b3a2918",
  "error_file_id": "file_7f6e5d4c-3b2a-4190-8e7d-6c5b4a392817",
  "in_progress_at": 1780000012,
  "finalizing_at": 1780005460,
  "completed_at": 1780005470,
  "failed_at": null,
  "expired_at": null,
  "expires_at": 1780086400,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 2,
    "completed": 2,
    "failed": 0
  },
  "errors": null,
  "usage": {
    "input_tokens": 824,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 36,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 860
  }
}

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

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

{
  "error": {
    "code": "not_found",
    "message": "No fine-tuning job found with id ftjob-8f2k1."
  }
}

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

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

Overview

Returns the batch with live request_counts. Once status is completed, failed, expired, or cancelled, download output_file_id and error_file_id from the content endpoint. Poll every 30 to 60 seconds; there is no webhook.

Authorizations

Authorization

string

header

required

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

Path Parameters

batch_id

string

required

Identifies the batch to read. The batch_ prefixed id returned when the batch was created.

Example:

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

Response

The batch.

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"

Retrieve a batch

curl --request GET \
  --url https://api.morphllm.com/v1/batches/{batch_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.morphllm.com/v1/batches/{batch_id}', 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/{batch_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.morphllm.com/v1/batches/{batch_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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": "completed",
  "model": "morph-glm53flash",
  "output_file_id": "file_0e7d6c5b-4a39-4281-9f7e-6d5c4b3a2918",
  "error_file_id": "file_7f6e5d4c-3b2a-4190-8e7d-6c5b4a392817",
  "in_progress_at": 1780000012,
  "finalizing_at": 1780005460,
  "completed_at": 1780005470,
  "failed_at": null,
  "expired_at": null,
  "expires_at": 1780086400,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 2,
    "completed": 2,
    "failed": 0
  },
  "errors": null,
  "usage": {
    "input_tokens": 824,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 36,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 860
  }
}

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

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

{
  "error": {
    "code": "not_found",
    "message": "No fine-tuning job found with id ftjob-8f2k1."
  }
}

{
  "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

Path Parameters

Response

​Overview

Authorizations

Path Parameters

Response

Overview