Complete API Reference

# Paginate: page 2 with 10 items per page
GET https://utilityforges.com/api/mock/inventory?limit=10&skip=10

# Sort by price, descending
GET https://utilityforges.com/api/mock/inventory?sortBy=price&order=desc

# Filter Electronics items, pick 3 fields only
GET https://utilityforges.com/api/mock/inventory?category=Electronics&select=id,name,price

# Search + paginate + sort together
GET https://utilityforges.com/api/mock/articles?q=technology&sortBy=views&order=desc&limit=5

# Random 3 movies (for a "random picks" feature)
GET https://utilityforges.com/api/mock/movies?shuffle=true&limit=3

const res = await fetch('https://utilityforges.com/api/mock/auth/login', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ username: 'john', password: 'pass123' })
});
const data = await res.json();
// Returns:
// {
//   token: "eyJhbGciOiJIUzI1NiIsInR5...",
//   user: { id: 1, username: "john", email: "john@example.com", role: "user" },
//   expiresIn: 3600
// }

<!-- 600x400 grey placeholder -->
<img src="https://utilityforges.com/api/mock/image?w=600&h=400" />

<!-- Custom colors and label -->
<img src="https://utilityforges.com/api/mock/image?w=300&h=200&bg=1a1a2e&text=ffffff&label=Product+Photo" />

// Parameters:
// w      - width in pixels (default: 400)
// h      - height in pixels (default: 300)
// bg     - background hex color (no #, default: cccccc)
// text   - text color hex (no #, default: 666666)
// label  - custom label text (default: WxH)

const res = await fetch('https://utilityforges.com/api/mock/graphql', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    query: `{ inventory { id name price category } }`
  })
});
const { data } = await res.json();
// data.inventory = [ { id: 1, name: "...", price: 299.99, category: "..." }, ... ]

// Supported query fields: inventory, accounts, articles, feedback, tasks, citations, restaurants, movies

const res = await fetch('https://utilityforges.com/api/mock/generate', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    count: 5,
    schema: {
      id: "number",
      name: "string",
      email: "email",
      active: "boolean",
      score: "number",
      createdAt: "date"
    }
  })
});
const { data } = await res.json();
// Returns 5 objects matching your schema with generated values

const formData = new FormData();
formData.append('file', fileInput.files[0]);
formData.append('userId', '42');

const res = await fetch('https://utilityforges.com/api/mock/upload', {
  method: 'POST',
  body: formData  // No Content-Type header needed — browser sets it
});
const data = await res.json();
// Returns:
// {
//   message: "File uploaded successfully (simulated)",
//   file: { name: "photo.jpg", size: 204800, type: "image/jpeg" },
//   url: "https://mock-cdn.utilityforges.com/uploads/photo.jpg",
//   uploadedAt: "2026-02-27T14:00:00.000Z"
// }

const res = await fetch('https://utilityforges.com/api/mock/echo?debug=true&env=production', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json', 'X-Custom-Header': 'my-value' },
  body: JSON.stringify({ action: 'test', userId: 99 })
});
const data = await res.json();
// Returns your full request back:
// {
//   method: "POST",
//   url: "/api/mock/echo?debug=true&env=production",
//   headers: { "content-type": "application/json", "x-custom-header": "my-value", ... },
//   query: { debug: "true", env: "production" },
//   body: { action: "test", userId: 99 },
//   ip: "203.0.113.42",
//   receivedAt: "2026-02-27T14:00:00.000Z"
// }

// Step 1: Store your custom JSON
const res = await fetch('https://utilityforges.com/api/mock/custom', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    userId: 42,
    plan: 'enterprise',
    features: ['sso', 'audit-log', 'custom-domain'],
    _meta: { status: 200, headers: { 'X-Plan': 'enterprise' } }
  })
});
const { alias, url } = await res.json();
// alias: "my-custom-abc123"
// url: "https://utilityforges.com/api/mock/custom/my-custom-abc123"

// Step 2: Fetch it back from anywhere (GET)
const userData = await fetch(url).then(r => r.json());
// Returns your original JSON with your custom status and headers

// Step 1: Create a new inbox
const { inboxId, inboxUrl } = await fetch('https://utilityforges.com/api/mock/webhook/register', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ name: 'My App Events' })
}).then(r => r.json());
// inboxUrl: "https://utilityforges.com/api/mock/webhook/inbox/abc12345"

// Step 2: Configure your app to send webhooks to inboxUrl
// (copy-paste inboxUrl into your app's webhook settings)

// Step 3: Read all captured events
const { events } = await fetch(inboxUrl).then(r => r.json());
// events = [
//   { id: "evt_1709040012345", method: "POST", headers: {...}, body: {...}, receivedAt: "..." },
//   ...
// ]

// Step 4: Clear the inbox
await fetch(inboxUrl, { method: 'DELETE' });

// Will succeed for the first 3 calls, then return 429
const fetchWithRetry = async (attempts = 0) => {
  const res = await fetch('https://utilityforges.com/api/mock/inventory?rateLimit=3');

  if (res.status === 429) {
    const { retryAfterMs } = await res.json();
    console.log(`Rate limited! Retry in ${retryAfterMs}ms`);
    // res.headers.get('Retry-After') → seconds to wait
    // res.headers.get('X-RateLimit-Limit') → the configured limit
    // res.headers.get('X-RateLimit-Remaining') → "0"
    await new Promise(r => setTimeout(r, retryAfterMs));
    return fetchWithRetry(attempts + 1);
  }

  return res.json();
};