# API Access | AIM Previz

https://aimpreviz.com/api

[Previz](https://aimpreviz.com/) / API

# Production-grade API

Integrate the platform's visual-first generation directly into your VFX pipeline, asset management system, or creative workflow.

Early access · by request Open on every plan — keys are minted in your account

[Request API access](https://aimpreviz.com/help?topic=api#contact)

Frames made in Previz. Everything the interface does — camera, continuity, coverage, look — is what the endpoints below address.

## Core capabilities

Every control the rooms expose, addressable programmatically — the same routing, the same continuity, the same cost preview.

01

### Spatial camera control

Programmatic access to 3D camera positioning — azimuth, elevation, focal length, and depth of field parameters via structured JSON.

02

### Continuity Lock

Maintain subject identity across batch generations. Lock character features, wardrobe, and environmental elements for consistent sequences.

03

### Look profiles

Apply and manage cinematic look profiles programmatically. Reference existing looks or upload custom style references.

04

### Batch processing

Generate multiple frames in parallel with coverage templates. Ideal for storyboard automation and pre-visualization pipelines.

05

### Webhooks and events

Real-time notifications for job completion, queue status, and error handling. Integrate with your existing production tracking systems.

06

### Enterprise security

API keys with granular permissions, rate limiting, IP whitelisting, and audit logs for compliance requirements.

## API preview

Clean, predictable endpoints designed for production workflows.

generate-with-camera.ts POST /v1/generate

```
// Generate frames with spatial camera control
const response = await fetch('https://api.aimpreviz.com/v1/generate', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    reference_url: 'https://storage.example.com/reference.jpg',

    // Spatial camera parameters
    camera: {
      azimuth: 45,           // Horizontal angle (0-360°)
      elevation: 15,         // Vertical angle (-90 to 90°)
      focal_length: 35,      // Lens focal length in mm
      aperture: 2.8,         // f-stop for depth of field
      shot_size: 'medium'    // extreme_close, close, medium, wide, extreme_wide
    },

    // Consistency controls
    continuity_lock: true,
    look_profile: 'cinematic_noir',

    // Output settings
    batch_size: 6,
    aspect_ratio: '2.39:1',
    resolution: '2048x858'
  })
});

const { job_id, status, estimated_time } = await response.json();
```

coverage-template.ts POST /v1/coverage

```
// Generate complete coverage using industry templates
const coverage = await fetch('https://api.aimpreviz.com/v1/coverage', {
  method: 'POST',
  headers: { 'Authorization': 'Bearer YOUR_API_KEY' },
  body: JSON.stringify({
    reference_url: 'https://storage.example.com/scene-reference.jpg',

    // Use predefined coverage template
    template: 'dialogue_scene',  // master, dialogue_scene, action_sequence, interview

    // Or define custom coverage
    shots: [
      { name: 'Master', azimuth: 0, elevation: 5, shot_size: 'wide' },
      { name: 'OTS_A', azimuth: -30, elevation: 10, shot_size: 'medium' },
      { name: 'OTS_B', azimuth: 30, elevation: 10, shot_size: 'medium' },
      { name: 'CU_A', azimuth: -15, elevation: 0, shot_size: 'close' },
      { name: 'CU_B', azimuth: 15, elevation: 0, shot_size: 'close' }
    ],

    continuity_lock: true
  })
});
```

<30s

Average generation time

100+

Concurrent jobs

Per project

Vendor and jurisdiction routing

## Integration scenarios

Built for how production teams actually work.

01

### VFX pipeline integration

Connect AIM Previz to your existing pipeline tools — Shotgun, ftrack, or custom asset management systems.

02

### Automated storyboarding

Generate complete shot sequences from script breakdowns. Map scene descriptions to camera coverage automatically.

03

### Real-time collaboration

Enable multiple team members to generate frames simultaneously with shared look profiles and continuity settings.

Made with Previz

## What the endpoints return

Frames made in Previz. A batch call returns work of this kind, with its generation metadata attached.

## Join the API beta

We are onboarding studios and production teams for early API access. Priority goes to teams with existing pipeline integration needs.

- Full REST API with TypeScript SDK
- Webhook integration for async workflows
- Dedicated API keys with usage analytics
- Priority support and integration assistance
- Early access to new endpoints

[Request API access](https://aimpreviz.com/help?topic=api#contact) [Read the manual](https://aimpreviz.com/documentation)