Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ventra.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Every Currents endpoint except GET /v1/health requires a bearer API key in the Authorization header.

​
Key format

Keys are environment-prefixed so they are obvious on sight in logs and tickets:
EnvironmentPrefixExample
Sandboxcur_sk_test_cur_sk_test_EXAMPLEKEY123456789012345678901234
Productioncur_sk_live_cur_sk_live_EXAMPLEKEY123456789012345678901234
Keys are 12 characters of prefix + 32 URL-safe base64 characters. They are returned exactly once at creation, then stored only as a SHA-256 hash on our side. Treat them like a password.
A leaked key allows full read/write to your tenant’s data. Rotate immediately by contacting your account contact.

​
Requesting a sandbox key

Email noreply@ventrasystems.com with the subject Currents Sandbox Access and include your operating entity name, intended use, and the email of the technical contact who will receive the key. You will receive:
  • One sandbox API key (cur_sk_test_…)
  • One webhook signing secret (used to verify our webhooks — see Webhooks)

​
Making an authenticated request

curl https://sandbox.api.anunnakielite.com/v1/health
/v1/health is intentionally public — useful for connectivity checks before adding auth. Every other endpoint requires the header: 
curl https://sandbox.api.anunnakielite.com/v1/exclusions \
  -H "Authorization: Bearer cur_sk_test_EXAMPLEKEY123456789012345678901234" \
  -H "Content-Type: application/json"

​
Failure modes

StatusCodeCause
401missing_credentialsNo Authorization header.
401invalid_credentialsMalformed key, unknown key, revoked key, or tenant suspended.
429rate_limitedOver the per-key request rate.
Every authentication failure is recorded against your tenant’s audit log with the reason, the partial key prefix, and the request ID returned in the response.