DOCS & REFERENCE

Scale your media production with Articulait API

The Articulait API provides programmatic access to our enterprise-grade AI media engine. Automate virtual staging, HDR enhancement, and property walkthrough generation through a clean, RESTful interface.

Quickstart Guide

Getting Started

Follow these steps to integrate the Articulait engine into your existing real estate platform or CRM.

Generate your API Key

Navigate to your dashboard settings and generate a scoped API key. Keep this key confidential to prevent unauthorized staging credits usage.

Set up Webhooks

Media processing is asynchronous. Register an endpoint to receive POST requests once our AI completes the enhancements.

Authentication

All requests must include a Bearer token in the Authorization header.

# Include in every request
Authorization: Bearer <YOUR_API_KEY>

POST/v1/stage

Request Virtual Staging

Triggers an AI-powered furniture placement and room enhancement for a specific image asset.

Body Parameters

image_urlstring | required

The public URL of the high-res empty room photo.

style_presetstring

Design style: modern, scandinavian, etc.

resolutionstring

Output resolution: 2k, 4k, or 8k.

callback_urlstring

Webhook URL to receive the completed result.

GET/v1/projects

List Projects

Retrieves a paginated list of all media projects within your organization's environment.

POST/v1/export

Export Render

Exports a finalized media asset in the requested format and resolution for download or CDN delivery.

Event Types

Webhooks are fired for the following event types.

staging.completed

staging.failed

export.ready

project.created

Payload Security

Each webhook payload includes an X-Articulait-Signature header — an HMAC-SHA256 digest of the raw body signed with your webhook secret.

# Stage a new property image
curl -X POST https://api.articulait.com/v1/stage \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "image_url": "https://assets.site.com/listing-01.jpg",
    "style_preset": "modern_scandinavian",
    "resolution": "4k",
    "callback_url": "https://hooks.yourdomain.com/events"
  }'

# Success Response (202 Accepted)
{
  "id": "stg_9f82k0",
  "status": "processing",
  "estimated_time_ms": 45000
}