REST API
The Peach REST API exposes previews, builds, test runs, and cloud session
metering at https://peachsim.com/api/v1. Every request uses an account-scoped
Peach API key or a session Bearer token from peach login. Every created result
links to a hosted page on https://peachsim.com.
terminal
API keys are available in Billing → API Keys on Peach. Choose only the scopes an integration needs and set an expiration for production automation. The Peach CLI can use its existing login session.
Resources
- +Authentication and scopes
- +Preview uploads
- +GitHub builds
- +Test runs
- +Cloud sessions
- +Billing and rate limits
- +Request rate limits
- +Error reference
All request and response bodies are JSON unless an upload URL explicitly asks for artifact bytes. Stored timestamps in resource responses are Unix milliseconds. API-key creation and expiration dates are ISO 8601 strings.