Authentication

All requests to the DomeAgent Enterprise API require an API key.

API Key

Send your API key in the X-API-Key header with every request:

curl -H "X-API-Key: dome_live_your_key_here" \
  https://staging-api.domeagent.com.au/v1/jobs

Key Format

API keys follow the format dome_live_ followed by a random string:

dome_live_a1b2c3d4e5f6g7h8i9j0

Security

  • Keep your API key secret. Do not expose it in client-side code.
  • All requests must be made over HTTPS.
  • If you believe your key has been compromised, contact support immediately for a replacement.

Rate Limits

Rate limits are applied per API key based on your plan:

PlanRequests/minRequests/day
Starter301,000
Growth10010,000
Enterprise500100,000

When you exceed the rate limit, the API returns a 429 Too Many Requests response with a Retry-After header.

Error Responses

Authentication failures return a 401 status code:

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-02-09T10:00:00.000Z"
  }
}

Base URL

All API requests should be sent to:

https://staging-api.domeagent.com.au/v1

Switch between staging and production using the toggle in the top nav. Contact your account manager for API credentials.