REST API Overview & Base URL
Architectural overview, base URL, versioning, and standards for the BehaviorSim cloud REST API.
The BehaviorSim Cloud REST API provides hosted access to simulation execution, registered preset catalogs, usage quotas, and developer API key lifecycle management.
Base URL & HTTPS
All REST interactions occur exclusively over HTTPS:
In local development, the API typically binds to http://localhost:8000.
API Versioning (/v1)
Core simulation and management endpoints are strictly versioned under the /v1 prefix (for example, /v1/simulations or /v1/presets). Non-versioned endpoints are reserved for process probes (/health, /ready).
Request Correlation IDs (X-Request-ID)
Every response returned by the API includes a unique correlation identifier in the X-Request-ID HTTP header. If you encounter an unexpected error, include this ID when reporting issues to allow trace identification in system logs.
Format & Envelopes
- Request Body: Standard JSON payload (
Content-Type: application/json). - Response Body: Standard JSON format (
Content-Type: application/json). - Timestamps: Formatted in ISO-8601 UTC string format (e.g.
2026-09-14T00:00:00Z).
Interactive Testing
Try out live requests directly in your browser using the public Interactive API Explorer.