API Reference

Base URL & authentication

All API requests go to https://api.mrque.com. HTTPS is required — plain HTTP is rejected (not redirected). Requests to the API host over HTTP receive a 400 Bad Request.

Authenticate with a Bearer token in the Authorization header:

Authorization: Bearer mk_…your_key_here…

API keys start with mk_. Generate or regenerate yours in Settings → Integrations. The full key is shown once on generation — copy it immediately. API access requires a Pro or Agency plan.

Rate limit

100 requests per minute per API key. When the limit is exceeded you receive 429 Too Many Requests with a Retry-After header (seconds until the window resets).

Endpoints

{
  "id": "clx…",
  "url": "https://mrque.com/p/<slug>",
  "name": "my-project",
  "expires_at": "2026-07-18T00:00:00.000Z",
  "status": "active"
}

[
  {
    "id": "clx…",
    "url": "https://mrque.com/p/<slug>",
    "name": "landing-page-v3",
    "status": "active",
    "expires_at": "2026-07-18T00:00:00.000Z",
    "views": 14
  }
]

{
  "id": "clx…",
  "url": "https://mrque.com/p/<slug>",
  "name": "landing-page-v3",
  "status": "active",
  "expires_at": "2026-07-18T00:00:00.000Z",
  "views": 14,
  "comment_count": 3
}

{ "success": true, "message": "Preview revoked" }

Error codes

OpenAPI 3 spec available at https://api.mrque.com/openapi.json.

Code examples

Node.js — upload a project

// Node.js — upload a project ZIP via the Mrque API
import { readFileSync } from 'fs';

const API_KEY = process.env.MIRRCO_API_KEY; // mk_…

async function uploadPreview(zipPath, name) {
  const form = new FormData();
  form.append('file', new Blob([readFileSync(zipPath)], { type: 'application/zip' }), 'project.zip');
  form.append('name', name);
  form.append('expiresIn', '30');

  const res = await fetch('https://api.mrque.com/upload', {
    method: 'POST',
    headers: { Authorization: `Bearer ${API_KEY}` },
    body: form,
  });

  if (!res.ok) {
    const err = await res.json();
    throw new Error(err.error ?? `Upload failed: ${res.status}`);
  }

  const { url, expires_at } = await res.json();
  console.log('Preview ready:', url);
  console.log('Expires:', expires_at);
  return url;
}

uploadPreview('./dist.zip', 'My Landing Page v3');

Node.js — list + revoke previews

const API_KEY = process.env.MIRRCO_API_KEY;
const headers = { Authorization: `Bearer ${API_KEY}` };

// List active previews
const list = await fetch('https://api.mrque.com/previews?status=active', { headers });
const previews = await list.json();
console.log(previews.map(p => `${p.name}: ${p.url}`));

// Get one preview (includes comment_count)
const get = await fetch(`https://api.mrque.com/previews/${previews[0].id}`, { headers });
console.log(await get.json()); // { id, url, name, status, expires_at, views, comment_count }

// Revoke a preview
const del = await fetch(`https://api.mrque.com/previews/${previews[0].id}`, {
  method: 'DELETE', headers,
});
console.log(await del.json()); // { success: true, message: 'Preview revoked' }

Python — upload a project

# Python — upload a project ZIP via the Mrque API
import os
import requests

API_KEY = os.environ["MIRRCO_API_KEY"]  # mk_…
BASE    = "https://api.mrque.com"

def upload_preview(zip_path: str, name: str, expires_in: int = 30) -> str:
    with open(zip_path, "rb") as f:
        resp = requests.post(
            f"{BASE}/upload",
            headers={"Authorization": f"Bearer {API_KEY}"},
            files={"file": ("project.zip", f, "application/zip")},
            data={"name": name, "expiresIn": str(expires_in)},
        )
    resp.raise_for_status()
    data = resp.json()
    print(f"Preview ready: {data['url']}")
    print(f"Expires: {data['expires_at']}")
    return data["url"]

upload_preview("./dist.zip", "My Landing Page v3")

Python — list + revoke previews

import os, requests

API_KEY = os.environ["MIRRCO_API_KEY"]
BASE    = "https://api.mrque.com"
HEADERS = {"Authorization": f"Bearer {API_KEY}"}

# List active previews
previews = requests.get(f"{BASE}/previews?status=active", headers=HEADERS).json()
for p in previews:
    print(f"{p['name']}: {p['url']}")

# Get one preview (includes comment_count)
detail = requests.get(f"{BASE}/previews/{previews[0]['id']}", headers=HEADERS).json()
print(detail)  # {'id': …, 'url': …, 'comment_count': 2}

# Revoke a preview
result = requests.delete(f"{BASE}/previews/{previews[0]['id']}", headers=HEADERS).json()
print(result)  # {'success': True, 'message': 'Preview revoked'}

Using Mrque with AI coding agents

Mrque is designed to be AI-native. Tell your coding agent to upload your project and it will generate a shareable preview link automatically — no manual steps required.

Use the Mrque API (https://api.mrque.com) to upload this project and generate a preview link. API key: <YOUR_KEY>. POST to /upload with the project files as multipart/form-data.

# .cursorrules
# Mrque preview deployments
MIRRCO_API=https://api.mrque.com
MIRRCO_KEY=<YOUR_KEY>

When I ask you to "share", "preview", or "deploy" the current project:
1. Build / export the project to a dist/ or build/ directory.
2. Zip that directory.
3. POST the zip to https://api.mrque.com/upload as multipart/form-data with an Authorization: Bearer <YOUR_KEY> header.
4. Return the preview URL from the response JSON.

## Preview deployment
Use the Mrque API to share builds with clients.
- Base URL: https://api.mrque.com
- Auth: Authorization: Bearer <YOUR_KEY>
- Upload: POST /upload (multipart/form-data, field: file)
- Returns: { url, expires_at, status }

When asked to "preview", "share", or "deploy":
1. Run the project build command.
2. Zip the output directory.
3. Upload the zip to https://api.mrque.com/upload.
4. Return the preview URL.

<!-- .github/copilot-instructions.md -->
## Preview sharing
This project uses the Mrque API to create shareable preview links.
- API base: https://api.mrque.com
- Auth header: Authorization: Bearer <YOUR_KEY>
- Upload endpoint: POST /upload (multipart/form-data)
  - Required field: file (binary ZIP of the build output)
  - Optional: name (string), expiresIn (7 | 30 | 90)
- On success (201): returns { url, name, expires_at, status }

When I ask to "share" or "preview" the project, build it, zip the output, and POST it to /upload.