API Key Management
Key auth is used when this field is filled. If empty, tester falls back to legacy public endpoints.
| Key Prefix | Scopes | Created | Last Used | Status | Actions |
|---|---|---|---|---|---|
| Loading keys... | |||||
API Access
Key auth is used when this field is filled. If empty, tester falls back to legacy public endpoints.
| Key Prefix | Scopes | Created | Last Used | Status | Actions |
|---|---|---|---|---|---|
| Loading keys... | |||||
Base URL: http://localhost:3000
Process endpoint: POST /api/v1/process
Compliance endpoint: POST /api/v1/compliance
Async jobs: POST /api/v1/jobs,GET /api/v1/jobs/<jobId>
Dedicated endpoints:POST /api/v1/upscale,POST /api/v1/backgrounds/generate,POST /api/v1/relight/shadow
Auth header: x-api-key: <YOUR_API_KEY> (orAuthorization: Bearer <YOUR_API_KEY>)
Idempotency (recommended for POST): Idempotency-Key: <UNIQUE_KEY>
Rate limiting: responses include x-ratelimit-remaining, x-ratelimit-reset, and x-ratelimit-retry-after.
OpenAPI:/api/v1/openapi
Postman:/api/v1/postman
JavaScript Example
const form = new FormData();
form.append("image", fileInput.files[0]);
form.append("width", "2000");
form.append("height", "2000");
form.append("margin", "0.08");
form.append("jpegQuality", "92");
form.append("presetLabel", "api-test");
const response = await fetch("http://localhost:3000/api/v1/process", {
method: "POST",
headers: { "x-api-key": "<YOUR_API_KEY>" },
body: form,
});
const data = await response.json();Python Example
import requests
api_key = "<YOUR_API_KEY>"
url = "http://localhost:3000/api/v1/process"
files = {"image": open("/path/to/image.jpg", "rb")}
data = {
"width": 2000,
"height": 2000,
"margin": 0.08,
"jpegQuality": 92,
"presetLabel": "api-test"
}
response = requests.post(url, headers={"x-api-key": api_key}, files=files, data=data)
print(response.status_code)
print(response.json())Async + Webhook Example
curl -X POST http://localhost:3000/api/v1/jobs \ -H "x-api-key: <YOUR_API_KEY>" \ -F "image=@/path/to/image.jpg" \ -F "width=2000" \ -F "height=2000" \ -F "webhookUrl=https://example.com/vs-webhook" # Then poll: curl -H "x-api-key: <YOUR_API_KEY>" http://localhost:3000/api/v1/jobs/<jobId>
Tester endpoint currently selected:/api/v1/process
Marketplace Integrations
Connect Shopify, WooCommerce, and Amazon bridge endpoint. Save credentials per user and publish outputs directly.
Direct Publish
Select an output image to publish
Synced Catalog Preview
Run sync on any connected integration to load catalog items.
Recent Publish Activity
No publish events yet.
Showing 0-0 of 0
Org / Team Layer