Documentation

export BASE_URL="https://api.batchrouter.com"
export OB_API_KEY="ob_live_your_api_key"
export MANIFEST='{"sla_tier":"standard","routing_mode":"sla_aware","privacy_tier":"standard","allowed_regions":["global"],"items":[{"customer_item_id":"support_rollup_001","operation":"responses","model":"gpt-5.4-mini","model_options":["gpt-5.4-mini","gpt-5.4"],"input":{"input":[{"role":"user","content":"Summarize yesterday'\''s support queue into five bullets."}]}}]}'
export CREATE_PAYLOAD='{"quote_id":"qlock_replace_with_quote_id","sla_tier":"standard","routing_mode":"sla_aware","privacy_tier":"standard","allowed_regions":["global"],"items":[{"customer_item_id":"support_rollup_001","operation":"responses","model":"gpt-5.4-mini","model_options":["gpt-5.4-mini","gpt-5.4"],"input":{"input":[{"role":"user","content":"Summarize yesterday'\''s support queue into five bullets."}]}}]}'

# Lock the price first. Copy quote_id from the response into CREATE_PAYLOAD.
curl -sS "$BASE_URL/v1/quotes/model" \
  -X POST \
  -H "Authorization: Bearer $OB_API_KEY" \
  -H "Content-Type: application/json" \
  -d "$MANIFEST"

# Replace qlock_replace_with_quote_id before creating the paid batch.
curl -sS "$BASE_URL/v1/batches" \
  -X POST \
  -H "Authorization: Bearer $OB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-batch-001" \
  -d "$CREATE_PAYLOAD"

curl -sS "$BASE_URL/v1/batches/{batch_id}" \
  -H "Authorization: Bearer $OB_API_KEY"

curl -sS "$BASE_URL/v1/batches/{batch_id}/results" \
  -H "Authorization: Bearer $OB_API_KEY"

curl -sS "$BASE_URL/v1/batches/{batch_id}/artifact-url?kind=output" \
  -H "Authorization: Bearer $OB_API_KEY"

curl -sS "$BASE_URL/v1/batches/optimization-report?import_provider=openai" \
  -H "Authorization: Bearer $OB_API_KEY"

const BASE_URL = "https://api.batchrouter.com";
const API_KEY = process.env.BATCHROUTER_API_KEY ?? "ob_live_your_api_key";

const manifest = {
  sla_tier: "standard",
  routing_mode: "sla_aware",
  privacy_tier: "standard",
  allowed_regions: ["global"],
  webhook: {
    url: "https://example.com/batchrouter/webhook",
    secret: "whsec_replace_with_real_secret"
  },
  items: [
    {
      customer_item_id: "ticket_digest_001",
      operation: "responses",
      model: "gpt-5.4-mini",
      model_options: ["gpt-5.4-mini", "gpt-5.4"],
      input: {
        input: [
          {
            role: "user",
            content: "Summarize today's open support tickets into priorities."
          }
        ]
      }
    }
  ]
};

async function batchrouter(path, options = {}) {
  const response = await fetch(`${BASE_URL}${path}`, {
    ...options,
    headers: {
      Authorization: `Bearer ${API_KEY}`,
      "Content-Type": "application/json",
      ...options.headers
    }
  });
  const body = await response.json();
  if (!response.ok) throw new Error(JSON.stringify(body));
  return body;
}

const quote = await batchrouter("/v1/quotes/model", {
  method: "POST",
  body: JSON.stringify(manifest)
});

console.log("quoted", quote.pricing_estimate?.total ?? quote.pricingEstimate?.total);

const created = await batchrouter("/v1/batches", {
  method: "POST",
  headers: { "Idempotency-Key": "support-digest-" + new Date().toISOString().slice(0, 10) },
  body: JSON.stringify({ ...manifest, quote_id: quote.quote_id })
});

let batch = created.batch ?? created;
while (!["completed", "failed", "canceled", "expired"].includes(batch.state)) {
  await new Promise((resolve) => setTimeout(resolve, 30_000));
  const status = await batchrouter(`/v1/batches/${batch.id}`, { method: "GET" });
  batch = status.batch ?? status;
}

if (batch.state !== "completed") {
  throw new Error(`Batch ended as ${batch.state}`);
}

const results = await batchrouter(`/v1/batches/${batch.id}/results`, { method: "GET" });
console.log(results);