OpenQCoreAI
Get Started

Resources · Iris API

Iris API Documentation

Enterprise-grade multimodal reference for image generation, video flows, OCR, verification paths, routing rules, and unified output contracts.

Back to DocsJump to Model Catalog

Model Catalog

iris-orbit

Auto-route mode across multimodal lanes.

iris-genesis

Primary image generation model.

iris-edit

Image editing path (availability depends on runtime).

iris-lens

Image analysis and visual interpretation.

iris-video

Video generation workflow.

iris-ocr

Document OCR extraction pipeline.

iris-verify

Identity verification flow.

iris-guard

Fraud detection path (runtime-dependent).

iris-face

Face verification path (runtime-dependent).

Endpoints

POST /api/v1/iris/generate-image
POST /api/v1/iris/edit-image
POST /api/v1/iris/analyze-image
POST /api/v1/iris/generate-video
POST /api/v1/iris/ocr
POST /api/v1/iris/verify

Routing Logic

  • Prompt intent determines image, video, OCR, or verification lane.
  • Provider fallback chains are applied when primary path fails.
  • Timeout budgets vary by task type (image/video/OCR/verify).
  • Streaming and non-streaming paths share the same response envelope.
  • Usage and metadata are normalized regardless of provider.

Request Example

json
{
  "model": "iris-genesis",
  "prompt": "A futuristic city skyline at sunrise, cinematic lighting",
  "size": "1024x1024",
  "quality": "high",
  "stream": false,
  "metadata": {
    "workspace_id": "[workspace_uuid]",
    "trace_id": "[trace_id]"
  }
}

Response Contract

json
{
  "success": true,
  "content": "Generation completed",
  "provider": "openai",
  "images": [
    { "url": "https://...", "mime_type": "image/png" }
  ],
  "files": [],
  "videos": [],
  "usage": {
    "input_tokens": 0,
    "output_tokens": 0
  },
  "metadata": {
    "model": "iris-genesis",
    "duration_ms": 1542
  }
}

Unified Output Fields

  • success: operation status flag.
  • content: summary/status text.
  • images/files/videos: modality-specific artifacts.
  • usage: normalized accounting payload.
  • metadata: model/provider/timing diagnostics.

Error Models

400

Invalid payload or unsupported request shape.

401

Missing or invalid authentication.

413

Input payload too large.

415

Unsupported file/media type.

422

Validation failure in schema or context headers.

429

Rate limit exceeded.

503

Provider unavailable, timeout, or system overload.

Examples

bash
curl -X POST "/api/v1/iris/generate-image" \
  -H "Authorization: Bearer [token]" \
  -H "Content-Type: application/json" \
  -H "X-Scope-Type: workspace" \
  -H "X-Workspace-ID: [workspace_uuid]" \
  -d '{
    "model":"iris-genesis",
    "prompt":"A modern AI control room dashboard",
    "stream":false
  }'