API Documentation

Integrate StepBeam into your application using our REST API and SDKs.

Base URL: /api/v1 — All endpoints require authentication unless noted otherwise.

Authentication

All API requests must include your API key in the Authorization header. You can find your API key in Settings › General (REST API Keys section) or Profile › API Tokens.

Request Header

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Example Request

curl -X GET "/api/v1/guides" \
  -H "Authorization: Bearer pk_live_abc123def456" \
  -H "Content-Type: application/json"

Rate Limits

API requests are limited to 1,000 requests per minute per API key. Rate limit headers are included in every response: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.