API Reference

The Sporeline REST API gives you programmatic access to blocks, batches, recipes, harvests, deliveries, and more. Use it to push data from external systems, build custom dashboards, or automate routine tasks.

Get started

• API Quickstart — create a key and make your first call.
• Managing API Keys — create, rotate, and revoke credentials.

Base URL

All requests go to:

https://9uvbgolte1.execute-api.us-east-1.amazonaws.com/prod

Authentication

Every request must include an Authorization header with your API key, using the ApiKey scheme:

Authorization: ApiKey mt_live_...

API keys are tenant-scoped — they only access data in the tenant that created them — and run with the Manager role. See Authentication.

Rate limits

• Per address: 300 requests in any 5 minutes from one IP address. Going over returns 403 until the rate drops.
• API throttle: 25 requests/second with bursts up to 50, shared by every caller. Going over returns 429.
• There is no monthly request quota on any plan.

See Rate Limits.

Response envelope

Every successful response is wrapped in a data envelope:

{
  "data": { ... }
}

List endpoints paginate with a cursor:

{
  "data": [ ... ],
  "next_token": "01J..."
}

Pass next_token as a query parameter on the next call to continue.

Errors

Errors return a structured envelope:

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "weight_g must be >= 0.01",
    "request_id": "2f1c7d6e-4b0a-4f8e-9d1a-3c5b7e9f0a12",
    "retry": false
  }
}

Errors with retry: true are transient — retry with exponential backoff. Errors with retry: false require correcting the request before trying again. See Error Codes for every status and code.

Endpoints

See the Endpoint Reference for a grouped listing of every REST endpoint available in the API, organized by domain (blocks, batches, lab, logistics, etc.).