Getting Started

The DomeAgent Enterprise API lets you programmatically generate drone footage, enhance property images, create markup documents, and track job progress.

Base URL

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

Switch between staging and production using the toggle in the top nav.

Quick Start

1. Get your API key

Your API key is provided during partner onboarding. Keys start with dome_live_ and are sent via the X-API-Key header.

2. Make your first request

List your jobs:

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

3. Generate drone footage

curl -X POST \
  -H "X-API-Key: dome_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"address": "123 Collins Street, Melbourne VIC 3000"}' \
  https://staging-api.domeagent.com.au/v1/drone-footage/generate

Response:

{
  "data": {
    "job_id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "queued"
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-02-09T10:00:00.000Z"
  }
}

4. Poll for results

Jobs are asynchronous. Poll the job endpoint until the status is completed:

curl -H "X-API-Key: dome_live_your_key_here" \
  https://staging-api.domeagent.com.au/v1/jobs/550e8400-e29b-41d4-a716-446655440000

Available Endpoints

EndpointMethodDescription
/v1/jobsGETList all jobs
/v1/jobs/{jobId}GETGet a specific job
/v1/drone-footage/generatePOSTGenerate aerial drone footage
/v1/image-enhance/generatePOSTEnhance a property image
/v1/markup/generatePOSTGenerate a markup document
/v1/markup/jobs/{jobId}GETGet markup job status (multi-step)
/v1/markup/jobs/{jobId}/selectPOSTSelect markup orientation
/v1/markup/jobs/{jobId}/annotatePOSTSubmit boundary annotation
/v1/markup/jobs/{jobId}/videoPOSTGenerate cinematic markup video
/v1/virtual-staging/generatePOSTGenerate virtual staging
/v1/video-clip/generatePOSTGenerate a video clip from image
/v1/usageGETView usage and billing

Response Format

All responses follow a consistent envelope:

Success

{
  "data": { ... },
  "meta": {
    "request_id": "...",
    "timestamp": "..."
  }
}

Error

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "..."
  },
  "meta": {
    "request_id": "...",
    "timestamp": "..."
  }
}

Next Steps