Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.batchrelay.com/llms.txt

Use this file to discover all available pages before exploring further.

The Batch Relay API is fully described by an OpenAPI 3.x contract that acts as the single source of truth for every integration you build — from hand-rolled API clients to auto-generated SDKs, and even the behaviour of the planned n8n node. Rather than reading scattered documentation and hoping it stays current, you can point your tooling directly at the specification file and derive clients, type definitions, and mocks automatically.

​
Specification Location

The canonical, always-up-to-date OpenAPI file is published at: 
https://docs.batchrelay.com/openapi.yaml
If you are working on Batch Relay itself or running a local documentation server, the file is also available in the repository at: 
public/openapi.yaml
Prefer the hosted URL for any external tooling so that you always pull the latest version of the contract.

​
Generating API Clients

You can feed the specification into any OpenAPI-compatible code generator to produce a client in your language of choice. A few common options:

OpenAPI Generator

Supports 50+ languages and frameworks. Run it locally with the CLI or Docker, or use the hosted generator at openapi-generator.tech.

Fern

Generates idiomatic SDKs with first-class TypeScript, Python, and Go support directly from your OpenAPI file.

Speakeasy

Produces production-ready SDKs with built-in retry logic, pagination helpers, and OAuth support.

Stainless

Turns your OpenAPI spec into fully maintained, versioned SDKs — used by Stripe, OpenAI, and others.
For a quick example using the OpenAPI Generator CLI, point it at the hosted file: 
openapi-generator-cli generate \
  -i https://docs.batchrelay.com/openapi.yaml \
  -g typescript-fetch \
  -o ./sdk/typescript
Replace typescript-fetch with any supported generator name (for example, python, go, java, ruby) and adjust the output path to suit your project layout.

​
Using the Spec as Source of Truth

Treating the OpenAPI contract as your source of truth means your integrations stay accurate as the API evolves. Practical ways to use it:
  • Validation — run requests and responses through a spec validator (such as Spectral) in your CI pipeline to catch breaking changes early
  • Mocking — tools like Prism can spin up a live mock server directly from the YAML, letting you develop and test without hitting the real API
  • Documentation — import the file into Postman, Insomnia, or any OpenAPI-aware tool to get a fully explorable reference automatically
  • n8n node behaviour — the planned Batch Relay n8n node derives its available operations and field schemas from this same contract, so the node and the raw API stay in sync by design

​
Keeping Your Client Up to Date

When Batch Relay publishes a new version of the API, the spec at https://docs.batchrelay.com/openapi.yaml is updated at the same time. You can automate re-generation as part of your CI/CD pipeline by fetching the file on each build and re-running your generator, ensuring your client always reflects the current surface area without any manual intervention.