For assistants

Use this page when building AI-driven integrations or internal copilots for Mirqam.

Best source order

/openapi.json
/docs.json
Human docs pages under /docs

Policy

search: yes
ai-input: yes
ai-train: no

Note

Mirqam rendering is server-side and raster-only. Return PNG/JPG bytes (or a 1-page PDF wrapper around raster output) from the backend renderer, never browser screenshot rendering.

Stable contracts

Auth

Machine/API workflows: Authorization: Bearer ak_... (Clerk API key)
Dashboard session workflows: Authorization: Bearer <Clerk JWT>

Error envelope

All API errors follow this stable shape:

json

{
  "error": {
    "code": "...",
    "message": "...",
    "details": []
  },
  "request_id": "..."
}

Key docs

Authentication
Render API
Schema
Prompt templates