Get Batch

GET

batches

:batch_id

Get Batch

curl --request GET \
  --url https://api.neosantara.xyz/v1/batches/:batch_id \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.neosantara.xyz/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.neosantara.xyz/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 => [
    "x-api-key: <api-key>"
  ],
]);

$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.neosantara.xyz/v1/batches/:batch_id"

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

	req.Header.Add("x-api-key", "<api-key>")

	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.neosantara.xyz/v1/batches/:batch_id")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "id": "<string>",
  "object": "<string>",
  "endpoint": "<string>",
  "errors": {},
  "input_file_id": "<string>",
  "completion_window": "<string>",
  "status": "<string>",
  "output_file_id": {},
  "error_file_id": {},
  "created_at": 123,
  "in_progress_at": {},
  "expires_at": 123,
  "finalizing_at": {},
  "completed_at": {},
  "failed_at": {},
  "expired_at": {},
  "cancelling_at": {},
  "cancelled_at": {},
  "request_counts": {
    "total": 123,
    "completed": 123,
    "failed": 123
  },
  "metadata": {}
}

Retrieve the status and details of a specific batch job.

string

required

The ID of the batch to retrieve (e.g., batch-abc123).

Returns

string

The unique identifier of the batch.

string

The object type, which is always batch.

string

The API endpoint used for all requests in the batch.

object or null

Any errors encountered during batch processing.

string

The ID of the input file.

string

The time window for batch completion.

string

The current status of the batch. See status values in Create Batch endpoint.

string or null

The ID of the output file with successful results.

string or null

The ID of the error file with failed requests.

integer

The Unix timestamp of when the batch was created.

integer or null

The Unix timestamp when processing started.

integer

The Unix timestamp when the batch expires.

integer or null

The Unix timestamp when finalizing started.

integer or null

The Unix timestamp when the batch completed.

integer or null

The Unix timestamp when the batch failed.

integer or null

The Unix timestamp when the batch expired.

integer or null

The Unix timestamp when cancellation was initiated.

integer or null

The Unix timestamp when the batch was cancelled.

object

Statistics about the batch requests.

Show request_counts properties

integer

Total number of requests.

integer

Number of successful requests.

integer

Number of failed requests.

object

Custom metadata for the batch.

{
  "id": "batch-abc123",
  "object": "batch",
  "endpoint": "/v1/chat/completions",
  "errors": null,
  "input_file_id": "file-xyz789",
  "completion_window": "24h",
  "status": "in_progress",
  "output_file_id": null,
  "error_file_id": null,
  "created_at": 1699564800,
  "in_progress_at": 1699565000,
  "expires_at": 1699651200,
  "finalizing_at": null,
  "completed_at": null,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 100,
    "completed": 45,
    "failed": 2
  },
  "metadata": {}
}

{
  "id": "batch-abc123",
  "object": "batch",
  "endpoint": "/v1/chat/completions",
  "errors": null,
  "input_file_id": "file-xyz789",
  "completion_window": "24h",
  "status": "completed",
  "output_file_id": "file-output-123",
  "error_file_id": "file-errors-456",
  "created_at": 1699564800,
  "in_progress_at": 1699565000,
  "expires_at": 1699651200,
  "finalizing_at": 1699568000,
  "completed_at": 1699568500,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 100,
    "completed": 98,
    "failed": 2
  },
  "metadata": {}
}

{
  "error": {
    "message": "Batch not found",
    "type": "invalid_request_error",
    "code": "batch_not_found"
  }
}

Get Batch

curl --request GET \
  --url https://api.neosantara.xyz/v1/batches/:batch_id \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.neosantara.xyz/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.neosantara.xyz/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 => [
    "x-api-key: <api-key>"
  ],
]);

$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.neosantara.xyz/v1/batches/:batch_id"

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

	req.Header.Add("x-api-key", "<api-key>")

	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.neosantara.xyz/v1/batches/:batch_id")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "id": "<string>",
  "object": "<string>",
  "endpoint": "<string>",
  "errors": {},
  "input_file_id": "<string>",
  "completion_window": "<string>",
  "status": "<string>",
  "output_file_id": {},
  "error_file_id": {},
  "created_at": 123,
  "in_progress_at": {},
  "expires_at": 123,
  "finalizing_at": {},
  "completed_at": {},
  "failed_at": {},
  "expired_at": {},
  "cancelling_at": {},
  "cancelled_at": {},
  "request_counts": {
    "total": 123,
    "completed": 123,
    "failed": 123
  },
  "metadata": {}
}

Using the APIs

API reference

Returns

​Returns

Returns