BehaviorSim REST API & Interactive Explorer
Execute simulation workloads, discover registered presets, and manage developer API keys over standard HTTPS. Test live public endpoints directly in your browser.
Looking for the local Python library? Use pip install behaviorsim and see the Python API Reference. This page documents the cloud REST service hosted at api.behavioursim.vedaangsharma.in.
Interactive Public Explorer
Safely inspect responses from public endpoints (liveness, readiness, and preset catalogs) without requiring an account.
REST API Documentation Guides
Comprehensive specifications covering authentication, quotas, rate limits, and endpoint schemas.
REST Overview
Base URL, versioning (/v1), HTTPS requirements, request correlation IDs, and standard envelopes.
Authentication
Google & GitHub OAuth initiation, callback handshakes, and HttpOnly session cookie handling.
API Key Lifecycle
bs_live_ keys, Bearer token authorization, generation, revocation, and security practices.
Endpoint Catalog
Full reference for /health, /ready, /presets, /account, /usage, /api-keys, and /simulations.
Errors & Status Codes
Structured error format, status codes (400, 401, 403, 404, 409, 422, 429), and X-Request-ID.
Rate Limits & Quotas
Free plan entitlements (5 req/min, 100 req/mo, 10,000 interactions/mo), and Retry-After header.