Mirqam Docs

Mirqam مِرقم is an Arabic-first image templating platform. You design a PNG/JPG template (or upload a 1-page PDF which will be rasterized), define fields, then render real images on the backend (no HTML screenshots) with correct Arabic shaping and RTL layout.

Where to start

• New to Mirqam? Start with Getting started.
• Building a template? Read Template editor.
• Integrating the API? Jump to Authentication and Render.
• Working with AI assistants? Read For assistants and use Prompt templates.

OpenAPI (Swagger)

The service also exposes OpenAPI / Swagger UI at:

https://api.mirqam.net/docs

Local dev default:

http://localhost:8000/docs

What you can do

Author templates

1. Upload a template image in the editor.
2. Add text fields (Arabic-safe) and image fields (square/circle placeholders).
3. Press Save to store the template in your library and get a template_id.

Render images

Send only:

{
  "template_id": "<TEMPLATE_ID>",
  "data": {
    "title": "مرحبًا بكم"
  }
}

If your schema includes image fields, also include images:

{
  "template_id": "<TEMPLATE_ID>",
  "data": {},
  "images": {
    "avatar": "data:image/png;base64,..."
  }
}