File size: 51,825 Bytes
06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a 7a00ea1 06c8c6a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 | <!DOCTYPE html>
<html lang="en" class="antialiased scroll-smooth">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>APIarium | API Documentation</title>
<meta name="description" content="APIarium API documentation β OpenAI-compatible endpoints, supported models (Veo 3 video, Gemini 3 image, GPT, Claude, etc.), and code examples.">
<!-- Professional Typography -->
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500;600&display=swap" rel="stylesheet">
<!-- Tailwind CSS -->
<script src="https://cdn.tailwindcss.com"></script>
<script>
tailwind.config = {
theme: {
extend: {
fontFamily: {
sans: ['Inter', 'sans-serif'],
mono: ['JetBrains Mono', 'monospace'],
},
colors: {
gray: {
900: '#0A0A0A',
800: '#171717',
700: '#262626',
600: '#404040',
}
}
}
}
}
</script>
<style>
body {
background-color: #000000;
color: #ededed;
}
::-webkit-scrollbar { width: 8px; height: 8px; }
::-webkit-scrollbar-track { background: transparent; }
::-webkit-scrollbar-thumb { background: #262626; border-radius: 4px; }
::-webkit-scrollbar-thumb:hover { background: #404040; }
@keyframes slideUp {
from { transform: translate(-50%, 100%); opacity: 0; }
to { transform: translate(-50%, 0); opacity: 1; }
}
.toast-enter { animation: slideUp 0.3s cubic-bezier(0.16, 1, 0.3, 1) forwards; }
.bg-grid-pattern {
background-image: linear-gradient(to right, #ffffff05 1px, transparent 1px),
linear-gradient(to bottom, #ffffff05 1px, transparent 1px);
background-size: 40px 40px;
mask-image: radial-gradient(circle at center, black, transparent 80%);
-webkit-mask-image: radial-gradient(circle at center, black, transparent 80%);
}
/* Code block styling */
pre {
font-family: 'JetBrains Mono', monospace;
font-size: 12.5px;
line-height: 1.55;
white-space: pre;
overflow-x: auto;
color: #d4d4d4;
}
pre .tk-key { color: #93c5fd; } /* JSON keys β light blue */
pre .tk-str { color: #86efac; } /* strings β green */
pre .tk-num { color: #fbbf24; } /* numbers β amber */
pre .tk-bool { color: #f0abfc; } /* booleans β pink */
pre .tk-cmt { color: #6b7280; font-style: italic; }
pre .tk-fn { color: #fbbf24; } /* function names */
pre .tk-kw { color: #c4b5fd; } /* keywords */
/* Anchor offset under sticky header */
section[id] { scroll-margin-top: 80px; }
/* TOC active state */
.toc-link.active {
color: #fff;
background: rgba(255,255,255,0.05);
border-left-color: #fbbf24;
}
</style>
</head>
<body class="min-h-screen flex flex-col relative">
<div class="absolute inset-0 bg-grid-pattern pointer-events-none z-0"></div>
<header class="sticky top-0 z-50 bg-black/80 backdrop-blur-md border-b border-white/10">
<div class="max-w-7xl mx-auto px-6 h-16 flex items-center justify-between">
<a href="/" class="flex items-center gap-3 group">
<span class="text-2xl" aria-label="APIarium">π</span>
<span class="font-semibold text-lg tracking-tight group-hover:text-amber-300 transition-colors">APIarium</span>
<span class="ml-2 px-2 py-0.5 text-[10px] font-mono font-medium bg-white/10 text-white rounded-full border border-white/20">v1.0.0</span>
</a>
<nav class="hidden sm:flex items-center gap-6 text-sm font-medium text-gray-400">
<a href="/" class="hover:text-white transition-colors">Home</a>
<a href="/docs" class="text-white">Documentation</a>
<a href="/openapi-docs" class="hover:text-white transition-colors">Swagger</a>
</nav>
</div>
</header>
<main class="flex-grow w-full max-w-7xl mx-auto px-6 py-12 relative z-10">
<!-- Hero -->
<section class="pb-10 border-b border-gray-800 mb-10">
<div class="flex items-center gap-2 text-xs font-mono uppercase tracking-wider text-amber-400 mb-3">
<span class="w-1.5 h-1.5 rounded-full bg-amber-400"></span>
Reference
</div>
<h1 class="text-4xl sm:text-5xl font-semibold tracking-tight text-white mb-4 leading-tight">
API Documentation
</h1>
<p class="text-lg text-gray-400 leading-relaxed max-w-3xl">
Everything you need to integrate with APIarium β an OpenAI-compatible gateway that fans out to GPT, Claude, Gemini, DeepSeek, Veo 3 video, Gemini 3 image and more, behind a single Bearer token.
</p>
<div class="flex flex-wrap gap-2 mt-6">
<span class="px-3 py-1 text-xs font-mono bg-blue-500/10 text-blue-300 border border-blue-500/20 rounded-md">OpenAI-compatible</span>
<span class="px-3 py-1 text-xs font-mono bg-emerald-500/10 text-emerald-300 border border-emerald-500/20 rounded-md">Streaming</span>
<span class="px-3 py-1 text-xs font-mono bg-amber-500/10 text-amber-300 border border-amber-500/20 rounded-md">Veo 3 video</span>
<span class="px-3 py-1 text-xs font-mono bg-fuchsia-500/10 text-fuchsia-300 border border-fuchsia-500/20 rounded-md">Gemini 3 image</span>
<span class="px-3 py-1 text-xs font-mono bg-white/5 text-gray-300 border border-white/10 rounded-md">IP-bound keys</span>
</div>
</section>
<div class="grid grid-cols-1 lg:grid-cols-[220px_1fr] gap-12">
<!-- TOC sidebar -->
<aside class="hidden lg:block">
<nav class="sticky top-24 space-y-1 text-sm">
<p class="text-[10px] font-mono uppercase tracking-wider text-gray-500 mb-3 px-3">On this page</p>
<a href="#quickstart" class="toc-link block px-3 py-1.5 border-l border-gray-800 text-gray-400 hover:text-white transition-colors">Quick start</a>
<a href="#auth" class="toc-link block px-3 py-1.5 border-l border-gray-800 text-gray-400 hover:text-white transition-colors">Authentication</a>
<a href="#base-url" class="toc-link block px-3 py-1.5 border-l border-gray-800 text-gray-400 hover:text-white transition-colors">Base URL</a>
<a href="#endpoints" class="toc-link block px-3 py-1.5 border-l border-gray-800 text-gray-400 hover:text-white transition-colors">Endpoints</a>
<a href="#models" class="toc-link block px-3 py-1.5 border-l border-gray-800 text-gray-400 hover:text-white transition-colors">Models catalog</a>
<a href="#chat" class="toc-link block px-3 py-1.5 border-l border-gray-800 text-gray-400 hover:text-white transition-colors">Chat completions</a>
<a href="#veo3" class="toc-link block px-3 py-1.5 border-l border-gray-800 text-gray-400 hover:text-white transition-colors">Veo 3 β video</a>
<a href="#gemini3-image" class="toc-link block px-3 py-1.5 border-l border-gray-800 text-gray-400 hover:text-white transition-colors">Gemini 3 β image</a>
<a href="#gemini3-text" class="toc-link block px-3 py-1.5 border-l border-gray-800 text-gray-400 hover:text-white transition-colors">Gemini 3 β text</a>
<a href="#gpt-image" class="toc-link block px-3 py-1.5 border-l border-gray-800 text-gray-400 hover:text-white transition-colors">gpt-image-*</a>
<a href="#errors" class="toc-link block px-3 py-1.5 border-l border-gray-800 text-gray-400 hover:text-white transition-colors">Errors & limits</a>
<a href="#sdks" class="toc-link block px-3 py-1.5 border-l border-gray-800 text-gray-400 hover:text-white transition-colors">SDK examples</a>
</nav>
</aside>
<!-- Content -->
<article class="space-y-16 min-w-0">
<!-- QUICK START -->
<section id="quickstart">
<h2 class="text-2xl font-semibold text-white mb-2">Quick start</h2>
<p class="text-gray-400 mb-6">Three steps and you're sending requests.</p>
<ol class="space-y-5">
<li class="flex gap-4">
<span class="shrink-0 w-7 h-7 rounded-full bg-amber-500/10 border border-amber-500/30 text-amber-300 text-xs font-mono flex items-center justify-center">1</span>
<div>
<p class="text-sm font-medium text-white mb-1">Grab an API key</p>
<p class="text-sm text-gray-400">Visit <a class="text-amber-300 hover:underline" href="/">the homepage</a> β a key is automatically generated for your IP. Keys are bound to that IP.</p>
</div>
</li>
<li class="flex gap-4">
<span class="shrink-0 w-7 h-7 rounded-full bg-amber-500/10 border border-amber-500/30 text-amber-300 text-xs font-mono flex items-center justify-center">2</span>
<div>
<p class="text-sm font-medium text-white mb-1">Point your OpenAI SDK at us</p>
<p class="text-sm text-gray-400">Override <code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">base_url</code> and you're done β everything else is identical to OpenAI.</p>
</div>
</li>
<li class="flex gap-4">
<span class="shrink-0 w-7 h-7 rounded-full bg-amber-500/10 border border-amber-500/30 text-amber-300 text-xs font-mono flex items-center justify-center">3</span>
<div>
<p class="text-sm font-medium text-white mb-1">Pick any model</p>
<p class="text-sm text-gray-400">From <code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">gpt-5</code> to <code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">veo-3</code>. See the <a class="text-amber-300 hover:underline" href="#models">full catalog</a>.</p>
</div>
</li>
</ol>
<div class="mt-8 bg-gray-900 border border-gray-800 rounded-xl overflow-hidden">
<div class="px-4 py-2.5 border-b border-gray-800 flex items-center justify-between">
<span class="text-[10px] font-mono uppercase tracking-wider text-gray-500">curl Β· Generate a Veo 3 video</span>
<button class="copy-btn text-[10px] font-mono uppercase tracking-wider text-gray-500 hover:text-white transition-colors px-2 py-1 rounded border border-gray-800">Copy</button>
</div>
<pre class="px-4 py-4"><span class="tk-cmt"># Returns OpenAI-shaped { "data": [{ "url": "https://β¦/video.mp4" }] }</span>
curl <span class="tk-str">"<span id="base-url-1">https://your-apiarium.example.com</span>/v1/videos/generations"</span> \
-H <span class="tk-str">"Authorization: Bearer api-xxxxxxxxxxxxxxxx"</span> \
-H <span class="tk-str">"Content-Type: application/json"</span> \
-d <span class="tk-str">'{
"model": "veo-3",
"prompt": "a red apple rotating on white, studio lighting",
"duration_seconds": "8",
"resolution": "1080p",
"size": "16:9"
}'</span></pre>
</div>
</section>
<!-- AUTH -->
<section id="auth">
<h2 class="text-2xl font-semibold text-white mb-2">Authentication</h2>
<p class="text-gray-400 mb-4">Every request to <code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">/v1/*</code> needs a Bearer token.</p>
<div class="bg-gray-900 border border-gray-800 rounded-xl p-4 mb-4">
<pre><span class="tk-kw">Authorization:</span> Bearer <span class="tk-str">api-xxxxxxxxxxxxxxxx</span></pre>
</div>
<ul class="text-sm text-gray-400 space-y-2 leading-relaxed">
<li>π Each key is <strong class="text-white font-medium">bound to one IP address</strong>. Requests from a different network are rejected with HTTP 401.</li>
<li>β±οΈ Default rate limit: <strong class="text-white font-medium">4 RPM</strong> per key. The master key bypasses limits.</li>
<li>πͺͺ Lose your key? Visit <a class="text-amber-300 hover:underline" href="/">the homepage</a> again β your IP will get the same key back.</li>
</ul>
</section>
<!-- BASE URL -->
<section id="base-url">
<h2 class="text-2xl font-semibold text-white mb-2">Base URL</h2>
<p class="text-gray-400 mb-4">All endpoints below are relative to:</p>
<div class="bg-gray-900 border border-gray-800 rounded-xl p-4 flex items-center justify-between">
<code class="font-mono text-sm text-amber-300" id="base-url-display">https://your-apiarium.example.com</code>
<button id="copy-base-url" class="text-[10px] font-mono uppercase tracking-wider text-gray-500 hover:text-white transition-colors px-2 py-1 rounded border border-gray-800">Copy</button>
</div>
<p class="text-xs text-gray-500 mt-2 font-mono">β this page auto-detects the running host</p>
</section>
<!-- ENDPOINTS -->
<section id="endpoints">
<h2 class="text-2xl font-semibold text-white mb-6">Endpoints</h2>
<div class="bg-gray-900 border border-gray-800 rounded-xl overflow-hidden">
<table class="w-full text-sm">
<thead class="bg-gray-900/50 border-b border-gray-800 text-[10px] font-mono uppercase tracking-wider text-gray-500">
<tr>
<th class="text-left px-4 py-3 w-16">Method</th>
<th class="text-left px-4 py-3">Path</th>
<th class="text-left px-4 py-3">Purpose</th>
</tr>
</thead>
<tbody class="divide-y divide-gray-800">
<tr><td class="px-4 py-3"><span class="px-1.5 py-0.5 text-[10px] font-mono font-bold bg-blue-500/10 text-blue-400 rounded">GET</span></td> <td class="px-4 py-3 font-mono text-gray-300">/v1/models</td> <td class="px-4 py-3 text-gray-400">List all available model aliases</td></tr>
<tr><td class="px-4 py-3"><span class="px-1.5 py-0.5 text-[10px] font-mono font-bold bg-amber-500/10 text-amber-400 rounded">POST</span></td><td class="px-4 py-3 font-mono text-gray-300">/v1/chat/completions</td> <td class="px-4 py-3 text-gray-400">Chat with any text/image/video model</td></tr>
<tr><td class="px-4 py-3"><span class="px-1.5 py-0.5 text-[10px] font-mono font-bold bg-amber-500/10 text-amber-400 rounded">POST</span></td><td class="px-4 py-3 font-mono text-gray-300">/v1/completions</td> <td class="px-4 py-3 text-gray-400">Legacy text completions</td></tr>
<tr><td class="px-4 py-3"><span class="px-1.5 py-0.5 text-[10px] font-mono font-bold bg-amber-500/10 text-amber-400 rounded">POST</span></td><td class="px-4 py-3 font-mono text-gray-300">/v1/images/generations</td><td class="px-4 py-3 text-gray-400">Image generation (gpt-image-*, gemini-3-image*)</td></tr>
<tr><td class="px-4 py-3"><span class="px-1.5 py-0.5 text-[10px] font-mono font-bold bg-amber-500/10 text-amber-400 rounded">POST</span></td><td class="px-4 py-3 font-mono text-gray-300">/v1/videos/generations</td><td class="px-4 py-3 text-gray-400">Video generation (veo-3, veo-3-fast, veo-3.1-fast)</td></tr>
<tr><td class="px-4 py-3"><span class="px-1.5 py-0.5 text-[10px] font-mono font-bold bg-blue-500/10 text-blue-400 rounded">GET</span></td> <td class="px-4 py-3 font-mono text-gray-300">/v1/keys/me</td> <td class="px-4 py-3 text-gray-400">Get / auto-generate the key bound to your IP</td></tr>
<tr><td class="px-4 py-3"><span class="px-1.5 py-0.5 text-[10px] font-mono font-bold bg-blue-500/10 text-blue-400 rounded">GET</span></td> <td class="px-4 py-3 font-mono text-gray-300">/health</td> <td class="px-4 py-3 text-gray-400">Health check</td></tr>
</tbody>
</table>
</div>
</section>
<!-- MODELS -->
<section id="models">
<h2 class="text-2xl font-semibold text-white mb-2">Models catalog</h2>
<p class="text-gray-400 mb-6">Live snapshot from <code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">GET /v1/models</code>. Click any tile to copy the model id.</p>
<div class="mb-4 flex items-center justify-between">
<div class="flex flex-wrap gap-2 text-xs font-mono">
<button data-filter="all" class="model-filter px-3 py-1.5 rounded-md border border-gray-700 bg-gray-900 text-gray-200 hover:border-amber-500/50 transition-colors active-filter">All</button>
<button data-filter="chat" class="model-filter px-3 py-1.5 rounded-md border border-gray-800 bg-gray-900/50 text-gray-400 hover:border-gray-600 hover:text-white transition-colors">Chat / text</button>
<button data-filter="image" class="model-filter px-3 py-1.5 rounded-md border border-gray-800 bg-gray-900/50 text-gray-400 hover:border-gray-600 hover:text-white transition-colors">Image</button>
<button data-filter="video" class="model-filter px-3 py-1.5 rounded-md border border-gray-800 bg-gray-900/50 text-gray-400 hover:border-gray-600 hover:text-white transition-colors">Video</button>
</div>
<span id="docs-models-badge" class="text-xs text-gray-500 font-mono">Loadingβ¦</span>
</div>
<div id="docs-models-grid" class="grid grid-cols-1 sm:grid-cols-2 md:grid-cols-3 gap-3">
<div class="col-span-full py-10 text-center text-gray-500 text-sm font-mono">Loading model registryβ¦</div>
</div>
</section>
<!-- CHAT -->
<section id="chat">
<h2 class="text-2xl font-semibold text-white mb-2">Chat completions</h2>
<p class="text-gray-400 mb-6">Drop-in replacement for <code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">POST https://api.openai.com/v1/chat/completions</code>. Streaming via <code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">"stream": true</code> works out of the box.</p>
<div class="grid grid-cols-1 md:grid-cols-2 gap-4">
<div class="bg-gray-900 border border-gray-800 rounded-xl overflow-hidden">
<div class="px-4 py-2.5 border-b border-gray-800 text-[10px] font-mono uppercase tracking-wider text-gray-500">Request body</div>
<pre class="px-4 py-4">{
<span class="tk-key">"model"</span>: <span class="tk-str">"gpt-5"</span>,
<span class="tk-key">"messages"</span>: [
{<span class="tk-key">"role"</span>: <span class="tk-str">"user"</span>, <span class="tk-key">"content"</span>: <span class="tk-str">"Hello"</span>}
],
<span class="tk-key">"stream"</span>: <span class="tk-bool">true</span>,
<span class="tk-key">"temperature"</span>: <span class="tk-num">0.7</span>
}</pre>
</div>
<div class="bg-gray-900 border border-gray-800 rounded-xl overflow-hidden">
<div class="px-4 py-2.5 border-b border-gray-800 text-[10px] font-mono uppercase tracking-wider text-gray-500">Response (non-stream)</div>
<pre class="px-4 py-4">{
<span class="tk-key">"id"</span>: <span class="tk-str">"chatcmpl-β¦"</span>,
<span class="tk-key">"object"</span>: <span class="tk-str">"chat.completion"</span>,
<span class="tk-key">"model"</span>: <span class="tk-str">"gpt-5"</span>,
<span class="tk-key">"choices"</span>: [{
<span class="tk-key">"index"</span>: <span class="tk-num">0</span>,
<span class="tk-key">"message"</span>: {
<span class="tk-key">"role"</span>: <span class="tk-str">"assistant"</span>,
<span class="tk-key">"content"</span>: <span class="tk-str">"Hi! How can I help?"</span>
},
<span class="tk-key">"finish_reason"</span>: <span class="tk-str">"stop"</span>
}]
}</pre>
</div>
</div>
</section>
<!-- VEO 3 -->
<section id="veo3">
<div class="flex items-center gap-2 text-xs font-mono uppercase tracking-wider text-amber-400 mb-2">
<span class="w-1.5 h-1.5 rounded-full bg-amber-400"></span>
Video generation
</div>
<h2 class="text-2xl font-semibold text-white mb-2">Veo 3 β video</h2>
<p class="text-gray-400 mb-6">
Dedicated endpoint:
<code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">POST /v1/videos/generations</code>.
Models:
<code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">veo-3</code>,
<code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">veo-3-fast</code>,
<code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">veo-3.1-fast</code>.
Returns an OpenAI-style payload: <code class="font-mono">{"data": [{"url": "https://β¦/video.mp4"}]}</code>.
</p>
<p class="text-sm text-gray-500 mb-6">
You can also send <code class="font-mono text-amber-300">model: "veo-3"</code> to
<code class="font-mono text-amber-300">/v1/chat/completions</code> β the assistant message will then
contain the bare MP4 URL β but the dedicated endpoint is more ergonomic.
</p>
<h3 class="text-sm font-medium text-white uppercase tracking-wider mb-3">Supported parameters</h3>
<div class="bg-gray-900 border border-gray-800 rounded-xl overflow-hidden mb-6">
<table class="w-full text-sm">
<thead class="bg-gray-900/50 border-b border-gray-800 text-[10px] font-mono uppercase tracking-wider text-gray-500">
<tr>
<th class="text-left px-4 py-3">Field</th>
<th class="text-left px-4 py-3">Type</th>
<th class="text-left px-4 py-3">Default</th>
<th class="text-left px-4 py-3">Notes</th>
</tr>
</thead>
<tbody class="divide-y divide-gray-800 text-gray-300">
<tr>
<td class="px-4 py-3 font-mono text-amber-300">messages[].content</td>
<td class="px-4 py-3 text-gray-400 font-mono">string</td>
<td class="px-4 py-3 text-gray-500 font-mono">β</td>
<td class="px-4 py-3 text-gray-400">The video prompt. We flatten all user/system turns into one string.</td>
</tr>
<tr>
<td class="px-4 py-3 font-mono text-amber-300">duration_seconds</td>
<td class="px-4 py-3 text-gray-400 font-mono">"4" | "6" | "8"</td>
<td class="px-4 py-3 text-gray-500 font-mono">"8"</td>
<td class="px-4 py-3 text-gray-400">Even seconds only. Longer = more credits.</td>
</tr>
<tr>
<td class="px-4 py-3 font-mono text-amber-300">resolution</td>
<td class="px-4 py-3 text-gray-400 font-mono">"720p" | "1080p"</td>
<td class="px-4 py-3 text-gray-500 font-mono">"720p"</td>
<td class="px-4 py-3 text-gray-400">1080p costs more.</td>
</tr>
<tr>
<td class="px-4 py-3 font-mono text-amber-300">aspect_ratio</td>
<td class="px-4 py-3 text-gray-400 font-mono">"16:9" | "9:16"</td>
<td class="px-4 py-3 text-gray-500 font-mono">"16:9"</td>
<td class="px-4 py-3 text-gray-400">Landscape or portrait.</td>
</tr>
<tr>
<td class="px-4 py-3 font-mono text-amber-300">image_url</td>
<td class="px-4 py-3 text-gray-400 font-mono">string</td>
<td class="px-4 py-3 text-gray-500 font-mono">β</td>
<td class="px-4 py-3 text-gray-400">Image-to-video: seed frame that gets animated.</td>
</tr>
</tbody>
</table>
</div>
<div class="grid grid-cols-1 md:grid-cols-2 gap-4">
<div class="bg-gray-900 border border-gray-800 rounded-xl overflow-hidden">
<div class="px-4 py-2.5 border-b border-gray-800 text-[10px] font-mono uppercase tracking-wider text-gray-500">POST /v1/videos/generations Β· request</div>
<pre class="px-4 py-4">{
<span class="tk-key">"model"</span>: <span class="tk-str">"veo-3"</span>,
<span class="tk-key">"prompt"</span>: <span class="tk-str">"a red apple rotating on white, studio lighting"</span>,
<span class="tk-key">"duration_seconds"</span>: <span class="tk-str">"8"</span>,
<span class="tk-key">"resolution"</span>: <span class="tk-str">"1080p"</span>,
<span class="tk-key">"size"</span>: <span class="tk-str">"16:9"</span>
}</pre>
</div>
<div class="bg-gray-900 border border-gray-800 rounded-xl overflow-hidden">
<div class="px-4 py-2.5 border-b border-gray-800 text-[10px] font-mono uppercase tracking-wider text-gray-500">Response</div>
<pre class="px-4 py-4">{
<span class="tk-key">"created"</span>: <span class="tk-num">1779570172</span>,
<span class="tk-key">"data"</span>: [{
<span class="tk-key">"url"</span>: <span class="tk-str">"https://β¦/video.mp4"</span>,
<span class="tk-key">"revised_prompt"</span>: <span class="tk-str">"a red apple rotating on whiteβ¦"</span>
}]
}</pre>
</div>
</div>
<div class="mt-4 p-4 rounded-xl border border-amber-500/20 bg-amber-500/5 text-sm text-amber-200">
β οΈ Video generation takes <strong>30 s β 2 min</strong>. Set an HTTP timeout of at least <strong>10 minutes</strong> client-side. Veo 3's safety filter may reject some prompts β you'll get a <code class="font-mono bg-amber-500/10 px-1 rounded">400</code> with a clear error.
</div>
</section>
<!-- GEMINI 3 IMAGE -->
<section id="gemini3-image">
<div class="flex items-center gap-2 text-xs font-mono uppercase tracking-wider text-fuchsia-300 mb-2">
<span class="w-1.5 h-1.5 rounded-full bg-fuchsia-300"></span>
Image generation
</div>
<h2 class="text-2xl font-semibold text-white mb-2">Gemini 3 β image</h2>
<p class="text-gray-400 mb-6">
Dedicated endpoint:
<code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">POST /v1/images/generations</code>.
Models:
<code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">gemini-3-image</code>,
<code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">gemini-3-flash-image</code>,
<code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">gemini-3.1-flash-image</code>.
Append <code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">-pro</code> to any of them for the higher-quality variant (~2 min).
</p>
<h3 class="text-sm font-medium text-white uppercase tracking-wider mb-3">Supported parameters</h3>
<div class="bg-gray-900 border border-gray-800 rounded-xl overflow-hidden mb-6">
<table class="w-full text-sm">
<thead class="bg-gray-900/50 border-b border-gray-800 text-[10px] font-mono uppercase tracking-wider text-gray-500">
<tr>
<th class="text-left px-4 py-3">Field</th>
<th class="text-left px-4 py-3">Type</th>
<th class="text-left px-4 py-3">Default</th>
<th class="text-left px-4 py-3">Notes</th>
</tr>
</thead>
<tbody class="divide-y divide-gray-800 text-gray-300">
<tr><td class="px-4 py-3 font-mono text-amber-300">prompt</td> <td class="px-4 py-3 text-gray-400 font-mono">string</td><td class="px-4 py-3 text-gray-500 font-mono">β</td> <td class="px-4 py-3 text-gray-400">Image description.</td></tr>
<tr><td class="px-4 py-3 font-mono text-amber-300">size</td> <td class="px-4 py-3 text-gray-400 font-mono">aspect or WxH</td><td class="px-4 py-3 text-gray-500 font-mono">"1024x1024"</td><td class="px-4 py-3 text-gray-400">Accepts ratios (1:1, 16:9, 9:16, 4:3, 3:4) or OpenAI sizes (1024x1024, 1792x1024, β¦).</td></tr>
<tr><td class="px-4 py-3 font-mono text-amber-300">n</td> <td class="px-4 py-3 text-gray-400 font-mono">integer</td><td class="px-4 py-3 text-gray-500 font-mono">1</td> <td class="px-4 py-3 text-gray-400">Repeated entries in <code class="font-mono">data[]</code>; upstream still produces one URL.</td></tr>
</tbody>
</table>
</div>
<div class="grid grid-cols-1 md:grid-cols-2 gap-4">
<div class="bg-gray-900 border border-gray-800 rounded-xl overflow-hidden">
<div class="px-4 py-2.5 border-b border-gray-800 text-[10px] font-mono uppercase tracking-wider text-gray-500">POST /v1/images/generations Β· request</div>
<pre class="px-4 py-4">{
<span class="tk-key">"model"</span>: <span class="tk-str">"gemini-3-image"</span>,
<span class="tk-key">"prompt"</span>: <span class="tk-str">"a glass of orange juice on a sunny kitchen counter"</span>,
<span class="tk-key">"size"</span>: <span class="tk-str">"1:1"</span>
}</pre>
</div>
<div class="bg-gray-900 border border-gray-800 rounded-xl overflow-hidden">
<div class="px-4 py-2.5 border-b border-gray-800 text-[10px] font-mono uppercase tracking-wider text-gray-500">Response</div>
<pre class="px-4 py-4">{
<span class="tk-key">"created"</span>: <span class="tk-num">1779570172</span>,
<span class="tk-key">"data"</span>: [{
<span class="tk-key">"url"</span>: <span class="tk-str">"https://β¦/image.png"</span>,
<span class="tk-key">"revised_prompt"</span>: <span class="tk-str">"a glass of orange juiceβ¦"</span>
}]
}</pre>
</div>
</div>
</section>
<!-- GEMINI 3 TEXT -->
<section id="gemini3-text">
<h2 class="text-2xl font-semibold text-white mb-2">Gemini 3 β text (RAG)</h2>
<p class="text-gray-400 mb-4">
Models: <code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">gemini-3</code>,
<code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">gemini-3-flash</code>,
<code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">gemini-3-pro</code>.
</p>
<p class="text-sm text-gray-500 mb-6">
These route to Gemini Hub's RAG-grounded <code class="font-mono">/query</code> endpoint. For free-form chat without a knowledge base, prefer
<code class="font-mono text-amber-300">gemini-2.5-pro</code>, <code class="font-mono text-amber-300">gemini-3.1-pro</code> or one of the GPT/Claude aliases.
</p>
</section>
<!-- gpt-image-* -->
<section id="gpt-image">
<h2 class="text-2xl font-semibold text-white mb-2">gpt-image-1 / gpt-image-2</h2>
<p class="text-gray-400 mb-6">
Same endpoint as Gemini 3 image:
<code class="font-mono bg-gray-900 px-1.5 py-0.5 rounded text-amber-300">POST /v1/images/generations</code>.
Just swap the <code class="font-mono text-amber-300">model</code> id.
</p>
<div class="bg-gray-900 border border-gray-800 rounded-xl overflow-hidden">
<div class="px-4 py-2.5 border-b border-gray-800 text-[10px] font-mono uppercase tracking-wider text-gray-500">Request</div>
<pre class="px-4 py-4">{
<span class="tk-key">"model"</span>: <span class="tk-str">"gpt-image-1"</span>,
<span class="tk-key">"prompt"</span>: <span class="tk-str">"a watercolor of Istanbul rooftops"</span>,
<span class="tk-key">"n"</span>: <span class="tk-num">1</span>,
<span class="tk-key">"size"</span>: <span class="tk-str">"1024x1024"</span>
}</pre>
</div>
</section>
<!-- ERRORS -->
<section id="errors">
<h2 class="text-2xl font-semibold text-white mb-2">Errors & limits</h2>
<div class="bg-gray-900 border border-gray-800 rounded-xl overflow-hidden">
<table class="w-full text-sm">
<thead class="bg-gray-900/50 border-b border-gray-800 text-[10px] font-mono uppercase tracking-wider text-gray-500">
<tr>
<th class="text-left px-4 py-3 w-20">Status</th>
<th class="text-left px-4 py-3">Meaning</th>
<th class="text-left px-4 py-3">Fix</th>
</tr>
</thead>
<tbody class="divide-y divide-gray-800 text-gray-300">
<tr><td class="px-4 py-3 font-mono text-red-400">401</td> <td class="px-4 py-3">IP mismatch or missing/invalid key</td><td class="px-4 py-3 text-gray-400">Hit <a class="text-amber-300 hover:underline" href="/v1/keys/me">/v1/keys/me</a> from your real IP.</td></tr>
<tr><td class="px-4 py-3 font-mono text-amber-400">403</td><td class="px-4 py-3">VPN / proxy detected</td> <td class="px-4 py-3 text-gray-400">Disable VPN, retry.</td></tr>
<tr><td class="px-4 py-3 font-mono text-amber-400">429</td><td class="px-4 py-3">Rate limit exceeded (4 RPM)</td> <td class="px-4 py-3 text-gray-400">Back off & retry; <code class="font-mono">content</code> field shows wait time.</td></tr>
<tr><td class="px-4 py-3 font-mono text-red-400">502</td> <td class="px-4 py-3">Upstream provider unreachable</td> <td class="px-4 py-3 text-gray-400">Try again or pick another model.</td></tr>
</tbody>
</table>
</div>
</section>
<!-- SDK EXAMPLES -->
<section id="sdks">
<h2 class="text-2xl font-semibold text-white mb-6">SDK examples</h2>
<div class="grid grid-cols-1 lg:grid-cols-2 gap-4">
<div class="bg-gray-900 border border-gray-800 rounded-xl overflow-hidden">
<div class="px-4 py-2.5 border-b border-gray-800 text-[10px] font-mono uppercase tracking-wider text-gray-500 flex items-center justify-between">
<span>π Python Β· openai</span>
<button class="copy-btn text-[10px] font-mono uppercase tracking-wider text-gray-500 hover:text-white transition-colors px-2 py-1 rounded border border-gray-800">Copy</button>
</div>
<pre class="px-4 py-4"><span class="tk-kw">from</span> openai <span class="tk-kw">import</span> OpenAI
client = <span class="tk-fn">OpenAI</span>(
base_url=<span class="tk-str">"<span class="base-url-inline">https://your-apiarium.example.com</span>/v1"</span>,
api_key=<span class="tk-str">"api-xxxxxxxxxxxxxxxx"</span>,
)
<span class="tk-cmt"># 1) chat</span>
chat = client.chat.completions.<span class="tk-fn">create</span>(
model=<span class="tk-str">"gpt-5"</span>,
messages=[{<span class="tk-str">"role"</span>: <span class="tk-str">"user"</span>, <span class="tk-str">"content"</span>: <span class="tk-str">"hi"</span>}],
)
<span class="tk-fn">print</span>(chat.choices[<span class="tk-num">0</span>].message.content)
<span class="tk-cmt"># 2) image (Gemini 3 or gpt-image)</span>
img = client.images.<span class="tk-fn">generate</span>(
model=<span class="tk-str">"gemini-3-image"</span>,
prompt=<span class="tk-str">"a glass of orange juice on a sunny kitchen counter"</span>,
size=<span class="tk-str">"1:1"</span>,
)
<span class="tk-fn">print</span>(img.data[<span class="tk-num">0</span>].url)
<span class="tk-cmt"># 3) video (Veo 3) β /v1/videos/generations</span>
<span class="tk-kw">import</span> httpx
vid = httpx.<span class="tk-fn">post</span>(
<span class="tk-str">"<span class="base-url-inline">https://your-apiarium.example.com</span>/v1/videos/generations"</span>,
headers={<span class="tk-str">"Authorization"</span>: <span class="tk-str">"Bearer api-xxxxxxxxxxxxxxxx"</span>},
json={<span class="tk-str">"model"</span>: <span class="tk-str">"veo-3"</span>,
<span class="tk-str">"prompt"</span>: <span class="tk-str">"a red apple rotating on white"</span>,
<span class="tk-str">"duration_seconds"</span>: <span class="tk-str">"8"</span>,
<span class="tk-str">"resolution"</span>: <span class="tk-str">"1080p"</span>,
<span class="tk-str">"size"</span>: <span class="tk-str">"16:9"</span>},
timeout=<span class="tk-num">600</span>,
).<span class="tk-fn">json</span>()
<span class="tk-fn">print</span>(vid[<span class="tk-str">"data"</span>][<span class="tk-num">0</span>][<span class="tk-str">"url"</span>])</pre>
</div>
<div class="bg-gray-900 border border-gray-800 rounded-xl overflow-hidden">
<div class="px-4 py-2.5 border-b border-gray-800 text-[10px] font-mono uppercase tracking-wider text-gray-500 flex items-center justify-between">
<span>π¨ JavaScript Β· openai</span>
<button class="copy-btn text-[10px] font-mono uppercase tracking-wider text-gray-500 hover:text-white transition-colors px-2 py-1 rounded border border-gray-800">Copy</button>
</div>
<pre class="px-4 py-4"><span class="tk-kw">import</span> OpenAI <span class="tk-kw">from</span> <span class="tk-str">"openai"</span>;
<span class="tk-kw">const</span> BASE_URL = <span class="tk-str">"<span class="base-url-inline">https://your-apiarium.example.com</span>"</span>;
<span class="tk-kw">const</span> API_KEY = <span class="tk-str">"api-xxxxxxxxxxxxxxxx"</span>;
<span class="tk-kw">const</span> client = <span class="tk-kw">new</span> <span class="tk-fn">OpenAI</span>({
baseURL: <span class="tk-str">`${BASE_URL}/v1`</span>,
apiKey: API_KEY,
});
<span class="tk-cmt">// 1) image β uses the OpenAI SDK's images.generate</span>
<span class="tk-kw">const</span> img = <span class="tk-kw">await</span> client.images.<span class="tk-fn">generate</span>({
model: <span class="tk-str">"gemini-3-image"</span>,
prompt: <span class="tk-str">"a glass of orange juice on a sunny kitchen counter"</span>,
size: <span class="tk-str">"1:1"</span>,
});
<span class="tk-fn">console.log</span>(img.data[<span class="tk-num">0</span>].url);
<span class="tk-cmt">// 2) video β bypass the SDK, hit /v1/videos/generations directly</span>
<span class="tk-kw">const</span> vid = <span class="tk-kw">await</span> <span class="tk-fn">fetch</span>(<span class="tk-str">`${BASE_URL}/v1/videos/generations`</span>, {
method: <span class="tk-str">"POST"</span>,
headers: {
<span class="tk-str">"Authorization"</span>: <span class="tk-str">`Bearer ${API_KEY}`</span>,
<span class="tk-str">"Content-Type"</span>: <span class="tk-str">"application/json"</span>,
},
body: <span class="tk-fn">JSON.stringify</span>({
model: <span class="tk-str">"veo-3"</span>,
prompt: <span class="tk-str">"a serene mountain sunset timelapse"</span>,
duration_seconds: <span class="tk-str">"8"</span>,
resolution: <span class="tk-str">"1080p"</span>,
size: <span class="tk-str">"16:9"</span>,
}),
}).<span class="tk-fn">then</span>(r => r.<span class="tk-fn">json</span>());
<span class="tk-fn">console.log</span>(vid.data[<span class="tk-num">0</span>].url);</pre>
</div>
</div>
</section>
</article>
</div>
</main>
<!-- Footer -->
<footer class="border-t border-gray-900 bg-black mt-20 relative z-10">
<div class="max-w-7xl mx-auto px-6 py-8 flex flex-col sm:flex-row justify-between items-center gap-4">
<div class="flex items-center gap-2 text-gray-500 text-sm">
<span class="text-base">π</span>
© 2026 APIarium Systems. All rights reserved.
</div>
<div class="flex items-center gap-4 text-sm text-gray-500">
<a href="/" class="hover:text-gray-300 transition-colors">Home</a>
<a href="/openapi-docs" class="hover:text-gray-300 transition-colors">Swagger</a>
<a href="/openapi.json" class="hover:text-gray-300 transition-colors">OpenAPI JSON</a>
</div>
</div>
</footer>
<div id="toast" class="fixed bottom-8 left-1/2 -translate-x-1/2 z-50 bg-white text-black px-4 py-3 rounded-lg shadow-2xl font-medium text-sm flex items-center gap-2 hidden">
<svg class="w-5 h-5 text-emerald-600" fill="none" viewBox="0 0 24 24" stroke="currentColor"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M5 13l4 4L19 7"/></svg>
<span id="toast-text">Copied to clipboard</span>
</div>
<script>
</script>
</body>
</html>
|