API Overview
Relay exposes a JSON REST API for managing functions, executions, and tenant resources. The authoritative OpenAPI schema is available in the repository at docs/api/openapi.yaml.
Base URL
https://api.deployrelay.com
All endpoints require an API key or JWT obtained from the Relay console.
Resources
- Functions – Create, version, and publish reusable functions.
- Executions – Trigger synchronous or asynchronous executions and inspect logs.
- Marketplace – Discover, purchase, and review shared functions.
- Telemetry – Stream metrics and health information for your tenants.
OpenAPI Schema
Download the schema directly:
curl -o openapi.yaml https://raw.githubusercontent.com/kfrrst/Relay_Protocol/main/docs/api/openapi.yaml
Import the file into Postman, Insomnia, or any OpenAPI-compatible tool to explore the full contract.
Rate Limits
The production API enforces the following defaults (per API key):
| Endpoint Group | Burst | Sustained |
|---|---|---|
| Functions & Executions | 30 req/s | 300 req/min |
| Marketplace | 10 req/s | 120 req/min |
| Telemetry | 5 req/s | 60 req/min |
Contact Relay support for higher limits or enterprise SLAs.