GET /
The GET / endpoint returns the standard Brookmimir Odin’s Eye API status envelope so you can verify that the service is reachable. It requires no authentication, does not consume credits, and responds with a StatusMessage containing the HTTP-style status and guidance text.
Request
Section titled “Request”- Method:
GET - Path:
/ - Authentication: Not required
- Headers: Optional
accept: application/json
GET https://api.brookmimir.com/accept: application/jsonSuccessful response
Section titled “Successful response”- HTTP status:
200 OK - Body schema:
StatusMessage
{ "status": 200, "message": "please choose an endpoint"}Field reference
Section titled “Field reference”| Field | Type | Description |
|---|---|---|
status | integer or null | Numeric indicator of the call result (expects 200). |
message | string or null | Textual hint describing the next actionable step. |
Error handling
Section titled “Error handling”While this route does not require authentication, transient network issues or platform outages may still occur. In those cases, you can expect standard HTTP error codes (5xx series). Retry logic with exponential backoff is recommended for automated monitors.
Recommended usage
Section titled “Recommended usage”- Health checks: Schedule periodic calls to
/from your infrastructure monitors (e.g., Pingdom, Datadog) to track availability. - Pre-flight validations: Invoke this endpoint before making high-cost operations to ensure the API is reachable.