Skip to content
HalvorAI mark HalvorAI mark HalvorAI

API reference

The pages in this section are generated from the OpenAPI 3.1 document, so they always match the API.

  • Sandbox: https://api.sandbox.halvorai.com/v1
  • Production: https://api.halvorai.com/v1

The same document is served by each deployment at /v1/openapi.json, so you can generate your own client. Use test keys with the sandbox and live keys with production.

Before you start, read authentication, errors and pagination.

Conventions

Section titled “Conventions”
  • Format. JSON only, with UTF-8 bodies up to 1 MB.
  • Identifiers. Prefixed ULIDs such as evt_, agt_, alr_, cas_ and pck_.
  • Money. Integer minor units with an ISO 4217 code, or atomic units with an asset id. Never floats.
  • Time. UTC, RFC 3339 with milliseconds.
  • Idempotency. For events the event id is the key. Other POST endpoints accept an Idempotency-Key header.
  • Request ids. Every response carries a Request-Id header, and every error body repeats it as request_id.

Where to start

Section titled “Where to start”

Most integrations only need three endpoints: POST /v1/events/validate while building, POST /v1/events in production, and GET /v1/events to confirm what arrived. The quickstart walks through all three, and the send events guide covers batching and per-event results.