Create a batch

⚠️

Preview — this feature is being built; the design below is the spec.

POST https://app.syntic.ai/v1/batches

Submit up to 50,000 requests to run within 24 hours at half the usual token price. Send either an uploaded JSONL file (purpose: "batch") or up to 1,000 requests inline. Each line has your custom_id, the target endpoint and a normal request body without streaming.

For how this fits into a full workflow, see Batches.

Headers

Header	Required	Value
`Authorization`	Yes	`Bearer <key>`: a private inference key (`sk_live_...`). See Authentication.
`Content-Type`	Yes	`application/json`
`Idempotency-Key`	No	Up to 255 characters. Retrying with the same key within 24 hours returns the first result instead of creating a duplicate. See Idempotency.

Body parameters

Parameter	Type	Required	Notes
`input_file_id`	string	One of these two	A file uploaded with `purpose: "batch"`.
`requests`	array	One of these two	Up to 1,000 objects of the form `{custom_id, endpoint, body}`.
`completion_window`	string	No	Only `"24h"`.
`metadata`	object	No	Up to 16 string keys and values.

Response

201 Created, Content-Type: application/json

{
  "id": "batch_01JBXF3P8K",
  "object": "batch",
  "status": "validating",
  "input_file_id": "file_01JBXF1Z",
  "output_file_id": null,
  "error_file_id": null,
  "request_counts": {
    "total": 5000,
    "succeeded": 0,
    "failed": 0,
    "canceled": 0
  },
  "created_at": 1791820800,
  "started_at": null,
  "ends_by": 1791907200,
  "completed_at": null,
  "metadata": {
    "job": "october-tickets"
  }
}

Field	Type	Description
`id`	string	Starts with `batch_`.
`object`	string	Always `batch`.
`status`	string	`validating`, `in_progress`, `canceling`, `completed`, `expired`, `canceled` or `failed`.
`input_file_id`	string or null	The input file, or `null` for an inline batch.
`output_file_id`	string or null	Results file, set once the batch reaches a final state with any finished lines.
`error_file_id`	string or null	Set when validation found problems; lists them by line.
`request_counts`	object	`total`, `succeeded`, `failed` and `canceled`.
`created_at`	integer	Unix seconds.
`started_at`	integer or null	When the first request started.
`ends_by`	integer	The end of the 24-hour window.
`completed_at`	integer or null	When the batch reached a final state.
`metadata`	object	Your string pairs, returned unchanged.

Examples

curl -sS https://app.syntic.ai/v1/batches \
  -H "Authorization: Bearer $SYNTIC_API_KEY" \
  -H "Idempotency-Key: 8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69" \
  -H "Content-Type: application/json" \
  -d '{
      "input_file_id": "file_01JBXF1Z",
      "completion_window": "24h",
      "metadata": {
        "job": "october-tickets"
      }
    }'

import os
 
import requests
 
resp = requests.post(
    "https://app.syntic.ai/v1/batches",
    headers={
        "Authorization": f"Bearer {os.environ['SYNTIC_API_KEY']}",
        "Idempotency-Key": "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69",
    },
    json={
        "input_file_id": "file_01JBXF1Z",
        "completion_window": "24h",
        "metadata": {
            "job": "october-tickets",
        },
    },
    timeout=60,
)
data = resp.json()
if not resp.ok:
    raise RuntimeError(f"{resp.status_code} {data['error']['code']}: {data['error']['message']}")
print(data)

const res = await fetch('https://app.syntic.ai/v1/batches', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SYNTIC_API_KEY}`,
    'Idempotency-Key': '8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "input_file_id": "file_01JBXF1Z",
    "completion_window": "24h",
    "metadata": {
      "job": "october-tickets"
    }
  }),
})
const data = await res.json()
if (!res.ok) throw new Error(`${res.status} ${data.error.code}: ${data.error.message}`)
console.log(data)

package main
 
import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)
 
func main() {
	body := strings.NewReader(`{
  "input_file_id": "file_01JBXF1Z",
  "completion_window": "24h",
  "metadata": {
    "job": "october-tickets"
  }
}`)
	req, err := http.NewRequest("POST", "https://app.syntic.ai/v1/batches", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("SYNTIC_API_KEY"))
	req.Header.Set("Idempotency-Key", "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69")
	req.Header.Set("Content-Type", "application/json")
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, _ := io.ReadAll(resp.Body)
	if resp.StatusCode >= 300 {
		panic(fmt.Sprintf("%d: %s", resp.StatusCode, out))
	}
	fmt.Println(string(out))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
 
public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "input_file_id": "file_01JBXF1Z",
              "completion_window": "24h",
              "metadata": {
                "job": "october-tickets"
              }
            }
            """;
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://app.syntic.ai/v1/batches"))
            .header("Authorization", "Bearer " + System.getenv("SYNTIC_API_KEY"))
            .header("Idempotency-Key", "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        if (response.statusCode() >= 300) {
            throw new RuntimeException(response.statusCode() + ": " + response.body());
        }
        System.out.println(response.body());
    }
}

using System.Net.Http.Headers;
using System.Text;
 
using var http = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("POST"), "https://app.syntic.ai/v1/batches");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("SYNTIC_API_KEY"));
request.Headers.Add("Idempotency-Key", "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69");
request.Content = new StringContent("""
    {
      "input_file_id": "file_01JBXF1Z",
      "completion_window": "24h",
      "metadata": {
        "job": "october-tickets"
      }
    }
    """, Encoding.UTF8, "application/json");
 
using var response = await http.SendAsync(request);
var text = await response.Content.ReadAsStringAsync();
if (!response.IsSuccessStatusCode) throw new Exception($"{(int)response.StatusCode}: {text}");
Console.WriteLine(text);

<?php
$body = <<<'JSON'
{
  "input_file_id": "file_01JBXF1Z",
  "completion_window": "24h",
  "metadata": {
    "job": "october-tickets"
  }
}
JSON;
 
$ch = curl_init('https://app.syntic.ai/v1/batches');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('SYNTIC_API_KEY'),
        'Idempotency-Key: 8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => $body,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);
 
if ($status >= 300) {
    throw new RuntimeException("$status: $response");
}
print_r(json_decode($response, true));

require "json"
require "net/http"
require "uri"
 
uri = URI("https://app.syntic.ai/v1/batches")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch('SYNTIC_API_KEY')}"
req["Idempotency-Key"] = "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69"
req["Content-Type"] = "application/json"
req.body = <<~'JSON'
  {
    "input_file_id": "file_01JBXF1Z",
    "completion_window": "24h",
    "metadata": {
      "job": "october-tickets"
    }
  }
JSON
 
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
raise "#{res.code}: #{res.body}" unless res.is_a?(Net::HTTPSuccess)
puts JSON.pretty_generate(JSON.parse(res.body))

Errors

Errors use the error envelope and carry a request_id. Codes specific to this operation:

Status	`type`	`code`	When
400	`invalid_request_error`	`invalid_batch_file`	A line is not valid JSON or is missing a field; `message` gives the line number.
400	`invalid_request_error`	`duplicate_custom_id`	Two lines share a `custom_id`.
400	`invalid_request_error`	`streaming_not_allowed`	A body sets `stream: true`.
400	`invalid_request_error`	`too_many_requests_in_batch`	More than 50,000 lines or 500 MB.
404	`not_found_error`	`file_not_found`	`input_file_id` does not exist in this workspace.
429	`rate_limit_error`	`batch_queue_full`	Too many queued requests for your organization.
401	`authentication_error`	`invalid_api_key`	The key is missing, unknown, revoked or expired.
429	`rate_limit_error`	`rate_limited`	Too many requests; wait for `Retry-After`. See Rate-limit headers.

Batches List batches

Was this page helpful?