API Reference

Acme provides a RESTful API for managing pipelines, triggering runs, and monitoring status programmatically.

Base URL

https://your-acme-instance.com/api/v1

Authentication

All API requests require authentication. See Authentication for setup.

curl -H "Authorization: Bearer df_key_abc123..." \
  https://acme.example.com/api/v1/pipelines

API modules

Module	Description	Reference
Client	SDK initialization and configuration	Client
Pipeline	Create, update, run, and manage pipelines	Pipeline
Connector	Manage source and destination connectors	Connector
Transform	Register and manage transform functions	Transform
Scheduler	Schedule and trigger pipeline runs	Scheduler
Events	Subscribe to pipeline lifecycle events	Events

Response format

All API responses follow a consistent format:

{
  "data": { ... },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-02-15T06:00:00Z"
  }
}

Error responses

{
  "error": {
    "code": "PIPELINE_NOT_FOUND",
    "message": "Pipeline 'user-analytics' not found",
    "details": {
      "pipeline_name": "user-analytics"
    }
  },
  "meta": {
    "request_id": "req_def456",
    "timestamp": "2026-02-15T06:00:01Z"
  }
}

Rate limits

Plan	Requests/min	Burst
Free	60	10
Pro	600	100
Enterprise	Unlimited	Unlimited

Rate limit headers

Every response includes rate limit headers:

X-RateLimit-Limit: 600
X-RateLimit-Remaining: 594
X-RateLimit-Reset: 1708934460

SDKs

Official client libraries:

# Python
pip install acme-sdk

# JavaScript/TypeScript
npm install @acme/sdk

# Go
go get github.com/acme/acme-go

See Client for SDK usage examples.