API Documentation

Complete reference for the Quar.tz REST API.

Introduction

The Quar.tz API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.

Base URL

https://api.quar.tz/v1

Errors

Quar.tz uses conventional HTTP response codes to indicate the success or failure of an API request.

Code Description
200 OK - Request succeeded
400 Bad Request - Invalid parameters
401 Unauthorized - Invalid API key
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error

Health

GET /health

Check the health status of the API.

Response

{
  "status": "healthy",
  "latency": 8,
  "region": "us-east-1",
  "timestamp": "2026-01-14T00:00:00Z"
}

Compute

POST /compute/execute

Execute a function on the edge runtime.

Request Body

{
  "function": "process-data",
  "payload": { ... },
  "timeout": 30000
}