API Keys

Loading API keys...

Name	Key	Scopes	Last Used	Expires	Status	Actions

Security Notice: API keys provide full access to submit and manage video processing jobs. Keys are only shown once when created. Store them securely.

MIRAGE API Reference

REST API JSON

Base URL: https://api.easychroma.com/v1

Authentication

All API requests require a Bearer token in the Authorization header:

HTTP Header

Authorization: Bearer YOUR_API_KEY

Quick Start

Create an API key from the API Keys tab
Get a presigned upload URL using POST /mirage/upload-url
Upload your video to the presigned URL (PUT request)
Submit the job using POST /mirage/submit
Poll status using GET /mirage/status/:taskId
Download outputs using GET /mirage/outputs/:taskId

Endpoints

POST /mirage/upload-url

Get a presigned S3 URL to upload your video

curl

curl -X POST https://api.easychroma.com/v1/mirage/upload-url \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"filename": "video.mp4"}'

POST /mirage/submit

Submit a video for background removal processing

curl

curl -X POST https://api.easychroma.com/v1/mirage/submit \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"sourceKey": "KEY_FROM_UPLOAD", "filename": "video.mp4"}'

GET /mirage/status/:taskId

Check the status of a processing job

curl

curl https://api.easychroma.com/v1/mirage/status/TASK_ID \
  -H 'Authorization: Bearer YOUR_API_KEY'

Rate Limits

Plan	Requests/min	Concurrent Jobs
Starter	60	2
Pro	300	10
Enterprise	Custom	Custom

Error Codes

Code	Description
`400`	Bad Request - Invalid parameters
`401`	Unauthorized - Invalid or missing API key
`429`	Rate Limited - Too many requests
`500`	Server Error - Something went wrong