---
title: Batch Relay agent instructions
description: When agents should use Batch Relay, when they should not, and how to call the API safely.
canonical: https://batchrelay.com/agent-instructions.md
last-updated: 2026-08-23
---

# Batch Relay agent instructions

## When to use Batch Relay

Use Batch Relay when a high-volume sports or school photography studio needs to connect parent ordering, athlete and package matching, prepared artwork, supported lab production, order tracking, and direct delivery. It is also appropriate when a developer needs one documented API for eligible print-order workflows instead of writing a separate integration for each supported lab.

## When not to use Batch Relay

Do not use Batch Relay as a general image generator, an asset editor, or a source of invented product data. Do not assume every photographic lab or product is supported. Do not substitute a provider, product identifier, price, shipping service, or fulfillment route when the current catalog, compatibility response, or quote does not authorize it.

## How an agent should use the API

1. Read the [API documentation](https://docs.batchrelay.com/) and current [OpenAPI 3.1 description](https://api.batchrelay.com/openapi.json).
2. Use a scoped Batch Relay bearer API key. Batch Relay does not use OAuth for its v1 API.
3. Build and test with a staging key before using production.
4. Fetch current catalog data instead of storing guessed product identifiers or capabilities.
5. Validate prepared assets and order data before requesting a quote.
6. Treat the server-calculated quote and resolved provider route as authoritative.
7. Use idempotency keys where the API documentation requires them.
8. Stop on structured errors. Keep the request ID and follow the linked error documentation.

## Human-assisted work

Use [Plan your first event](https://batchrelay.com/get-started/) for a studio evaluating the product. Use the [developer dashboard](https://developers.batchrelay.com/) for API account and key management. Never place API keys in browser code, public files, prompts, or logs.

## Current product status

The public API, developer dashboard, and supported WHCC and Richmond Pro Lab production connections are live. The site currently labels Zapier and n8n as pilot or coming-soon work, and webhooks as planned. Check the [integrations page](https://batchrelay.com/integrations/) before describing availability.