📚 مستندات API

راهنمای کامل استفاده از APIهای Mia با مثال‌ها و پارامترهای کامل

🔗 Base URL: https://api.miahub.live

مدیریت ابزار

Tools Manager /api/tools.php GET / POST
▼

روتر هوشمند تشخیص نیت کاربر و هدایت به ابزار مناسب. از regex پیشرفته برای تشخیص زبان فارسی/انگلیسی استفاده می‌کند و امتیاز هر ابزار را محاسبه می‌کند.

✓ تشخیص نیت با regex پیشرفته فارسی/انگلیسی ✓ امتیازدهی به ابزارها (0-1) و رتبه‌بندی ✓ حالت detect_only برای فقط تشخیص بدون اجرا ✓ فوروارد خودکار به ابزار انتخاب‌شده ✓ ذخیره task در جدول mia_tasks

ابزارهای پشتیبانی شده

ocr
تشخیص متن از تصویر (آپلود فایل یا URL)
ipwhois
اطلاعات IP (آدرس IPv4/IPv6)
calendar
تاریخ شمسی/میلادی، امروز، فردا
crypto
قیمت رمزارز (بیت‌کوین، اتریوم، ...)
calc
محاسبات، تبدیل واحد، درصد، BMI، رنگ تصادفی
search
جستجوی گوگل (خبر/عکس/ویدئو)
wiki
سوالات دانشنامه‌ای
scrape
استخراج محتوای وب‌سایت
template
ساخت قالب HTML (فاکتور/گزارش/مقاله/کتاب)

پارامترها

نام نوع الزامی توضیحات
text string بله متن ورودی کاربر (فارسی یا انگلیسی)
q string خیر جایگزین text
mode string خیر detect_only = فقط تشخیص، بدون فوروارد
detect_only boolean خیر 1 = فقط تشخیص
user_id string خیر شناسه کاربر برای لاگ
channel string خیر کانال درخواست (web/telegram/api)
source string خیر منبع درخواست

فیلدهای پاسخ

فیلد توضیحات
ok boolean - موفقیت
selected_tool string - ابزار انتخاب‌شده
tools_ranked array - لیست ابزارها با امتیاز
reasons array - دلایل انتخاب
forward_url string - URL فوروارد
response mixed - پاسخ ابزار (در حالت عادی)
error string - خطا (در صورت وجود)

نمونه‌ها

تشخیص نیت بدون اجرا
https://api.miahub.live/api/tools.php?text=قیمت بیت‌کوین چنده؟&mode=detect_only
{"ok":true,"selected_tool":"crypto","tools_ranked":[{"tool":"crypto","score":0.95},{"tool":"wiki","score":0.3}]}
جستجوی گوگل
https://api.miahub.live/api/tools.php?text=سرچ کن ایران
{"ok":true,"selected_tool":"search","response":{...}}
تاریخ امروز
https://api.miahub.live/api/tools.php?text=امروز چندمه؟
{"ok":true,"selected_tool":"calendar","response":{...}}

تمپلیت و خروجی

Templates API /api/templates.php GET / POST
▼

ساخت قالب‌های HTML زیبا (فاکتور، گزارش، مقاله، کتاب) با ۴ تم مختلف. قابلیت Wizard مرحله‌ای برای پر کردن تدریجی اطلاعات.

✓ ۴ نوع قالب: فاکتور، گزارش، مقاله، کتاب ✓ ۴ تم: کلاسیک، مدرن، خلاق، حرفه‌ای ✓ Wizard مرحله‌ای با session ✓ ذخیره خودکار در DB و فایل ✓ نمایش مستقیم HTML یا JSON ✓ فونت Vazirmatn برای فارسی

پارامترها

نام نوع الزامی توضیحات
type string بله نوع قالب: invoice, report, article, book
theme int (1-4) خیر 1=کلاسیک, 2=مدرن, 3=خلاق, 4=حرفه‌ای
sample boolean خیر 1=داده نمونه, 0=بدون داده پیش‌فرض
view boolean خیر 1=نمایش HTML مستقیم
data JSON خیر داده‌های قالب به صورت JSON
title string خیر عنوان سند
author string خیر نویسنده
user_id string خیر شناسه کاربر

پارامترهای فاکتور

نام نوع توضیحات
seller_name string نام فروشنده
buyer_name string نام خریدار
invoice_number string شماره فاکتور
issue_date string تاریخ صدور
due_date string تاریخ سررسید
currency string واحد پول
tax_percent number درصد مالیات
item1_name, item1_qty, item1_price string/number آیتم‌های فاکتور
notes string توضیحات
header_title string عنوان هدر
contact_phone, contact_email string اطلاعات تماس

Wizard Actions

start شروع session جدید type, theme, user_id
answer پاسخ به سوال فعلی session_id, value
add_item افزودن آیتم چندتایی session_id, name, qty, unit_price
next رفتن به مرحله بعد session_id
status وضعیت session session_id
render رندر نهایی HTML session_id, view

نمونه‌ها

فاکتور با داده دستی
https://api.miahub.live/api/templates.php?type=invoice&sample=0&view=1&theme=2&seller_name=فروشگاه&buyer_name=مشتری&invoice_number=INV-001&issue_date=1404/01/15&item1_name=محصول&item1_qty=2&item1_price=500000
گزارش نمونه
https://api.miahub.live/api/templates.php?type=report&sample=1&view=1&theme=1
شروع Wizard فاکتور
https://api.miahub.live/api/templates.php?action=start&type=invoice&theme=2

برنامه‌ریزی

Planner API /api/planner.php GET / POST
▼

تشخیص intent، action و entities از متن کاربر و ذخیره به عنوان task در دیتابیس.

✓ تشخیص زمان‌بندی (امروز، فردا، ساعت خاص) ✓ استخراج entities (تاریخ، مکان، شخص) ✓ ذخیره در جدول mia_tasks ✓ پشتیبانی از timezone

پارامترها

نام نوع الزامی توضیحات
text string بله متن کاربر
lang string خیر زبان (fa/en)
user_id string خیر شناسه کاربر
source string خیر منبع درخواست
channel string خیر کانال
tz string خیر timezone (مثل Asia/Tehran)

فیلدهای پاسخ

فیلد توضیحات
intent string - نیت تشخیص داده شده
action string - عمل پیشنهادی
entities object - موجودیت‌های استخراج شده
parsed_datetime string - زمان پارس شده
task_saved boolean - آیا task ذخیره شد
task_id int - شناسه task

نمونه‌ها

ثبت یادآور
https://api.miahub.live/api/planner.php?text=فردا ساعت ۱۰ جلسه دارم&user_id=123
Tasklist API /api/tasklist.php GET / POST
▼

ساخت لیست چندمرحله‌ای، فعال‌سازی مرحله، complete/next، افزودن آیتم و حالت create_auto برای تولید مراحل.

✓ action=create/manual: title + items[] ✓ action=create_auto: prompt + steps (۳-۱۲) ✓ status: full یا active_only ✓ complete/next: جلو بردن مرحله و progress ✓ add_item / cancel

پارامترها

نام نوع الزامی توضیحات
action string بله create | create_auto | status | complete | next | add_item | cancel
mode string خیر manual | auto (برای create)
title string خیر عنوان لیست (برای manual اجباری، در auto اختیاری)
items array خیر لیست آیتم‌ها در حالت manual
prompt string خیر ورودی LLM در create_auto
steps int خیر تعداد مراحل auto (۳ تا ۱۲)
list_id int خیر شناسه لیست برای status/complete/next/add_item/cancel
step_index int خیر شماره مرحله در complete (اختیاری، پیش‌فرض current)
status string خیر done | skipped (در complete)
user_id string خیر شناسه کاربر
source string خیر planner | ...
channel string خیر cli | web | telegram
meta_json JSON خیر متادیتا اختیاری

فیلدهای پاسخ

فیلد توضیحات
list_status active | done | cancelled
current_step شماره مرحله جاری
next_item آیتم فعال بعدی (اگر موجود باشد)
progress درصد پیشرفت
finished آیا لیست تمام شده است

نمونه‌ها

ساخت دستی
https://api.miahub.live/api/tasklist.php
{"action":"create","mode":"manual","title":"راه‌اندازی سرور","items":["نصب OS","فایروال","Nginx"],"user_id":1}
ساخت خودکار
https://api.miahub.live/api/tasklist.php
{"action":"create_auto","prompt":"پیاده‌سازی سیستم ایمیل","steps":7,"user_id":1}
next مرحله فعال
https://api.miahub.live/api/tasklist.php
{"action":"next","list_id":12}

جستجو

Options/Search API /api/options.php GET / POST
▼

جستجوی گوگل با BrightData SERP. پشتیبانی از جستجوی عادی، خبر، عکس و ویدئو.

✓ جستجوی گوگل بدون API Key ✓ چندین IP fallback برای پایداری ✓ پشتیبانی از tbm (نوع جستجو) ✓ کش غیرفعال برای نتایج تازه

پارامترها

نام نوع الزامی توضیحات
q string بله عبارت جستجو
connector string خیر google_search
tbm string خیر nws=خبر, isch=عکس, vid=ویدئو
gl string خیر کشور (IR, US, ...)

نمونه‌ها

جستجوی عادی
https://api.miahub.live/api/options.php?q=هوش مصنوعی&connector=google_search
جستجوی اخبار
https://api.miahub.live/api/options.php?q=ایران&connector=google_search&tbm=nws

ابزارهای محاسباتی

Calculator API /api/calc.php GET / POST
▼

محاسبات ریاضی، تبدیل واحد، درصد، BMI، آمار، هندسه، رنگ تصادفی و رمز تصادفی.

✓ محاسبات پایه (+, -, *, /, ^) ✓ تبدیل واحد (طول، وزن، دما، سرعت، ...) ✓ محاسبه درصد و حاشیه سود ✓ BMI و شاخص‌های سلامت ✓ آمار (میانگین، واریانس، انحراف معیار) ✓ هندسه (مساحت، محیط) ✓ تولید رمز و عدد تصادفی ✓ تولید رنگ تصادفی (hex, rgba, name)

پارامترها

نام نوع الزامی توضیحات
mode string بله حالت: convert, percent, margin, bmi, stats, geometry, finance, time, random, arithmetic
value number خیر مقدار ورودی
from string خیر واحد مبدا (برای convert)
to string خیر واحد مقصد (برای convert)
op string خیر عملگر: add, sub, mul, div, pow
x number خیر عدد اول (arithmetic)
y number خیر عدد دوم (arithmetic)
type string خیر نوع تصادفی: password, int, float, color
length int خیر طول رمز
color_format string خیر فرمت رنگ: hex, rgba, name

نمونه‌ها

تبدیل کیلومتر به متر
https://api.miahub.live/api/calc.php?mode=convert&value=5&from=km&to=m
محاسبه BMI
https://api.miahub.live/api/calc.php?mode=bmi&weight=70&height=175
رنگ تصادفی
https://api.miahub.live/api/calc.php?mode=random&type=color&color_format=hex
جمع دو عدد
https://api.miahub.live/api/calc.php?mode=arithmetic&op=add&x=10&y=5
Crypto API /api/crypto.php GET
▼

دریافت قیمت رمزارزها از Coingecko.

پارامترها

نام نوع الزامی توضیحات
q string خیر نام رمزارز (bitcoin, ethereum, ...)
ids string خیر شناسه‌های رمزارز (جدا با کاما)
vs_currency string خیر ارز مقایسه (usd, eur, ...)

نمونه‌ها

قیمت بیت‌کوین
https://api.miahub.live/api/crypto.php?q=bitcoin
Calendar API /api/calendar.php GET
▼

تقویم شمسی، تبدیل تاریخ، مناسبت‌ها.

پارامترها

نام نوع الزامی توضیحات
year int خیر سال شمسی
month int خیر ماه شمسی
day int خیر روز
today boolean خیر 1=تاریخ امروز

نمونه‌ها

تاریخ امروز
https://api.miahub.live/api/calendar.php?today=1
تقویم ماه جاری
https://api.miahub.live/api/calendar.php?year=1404&month=1

داده پایه

Colors Base /api/colors.php INCLUDE / GET
▼

لیست رنگ‌های پایه با نام فارسی/انگلیسی و کد هگز (آرایه PHP).

پارامترها

نام نوع الزامی توضیحات
- - خیر فایل include؛ در صورت فراخوانی مستقیم، آرایه را برمی‌گرداند.

نمونه‌ها

خروجی رنگ‌ها
https://api.miahub.live/api/colors.php

پردازش تصویر

OCR API /api/ocr.php POST
▼

تشخیص متن از تصویر با Azure Vision.

پارامترها

نام نوع الزامی توضیحات
file file خیر فایل تصویر (multipart)
url string خیر URL تصویر
image_url string خیر جایگزین url

نمونه‌ها

OCR از URL
https://api.miahub.live/api/ocr.php?url=https://example.com/image.jpg
Image Generator /api/image_gen.php GET / POST
▼

تولید تصویر با Pollinations بر اساس prompt و سبک؛ خروجی JSON یا نمایش HTML/IMG.

✓ سبک‌ها: photo | sticker | product | minimalist ✓ حمایت از prompt فارسی با ترجمه خودکار ✓ seed/width/height قابل تنظیم ✓ نمایش مستقیم تصویر (view=img/html) ✓ پیش‌نمایش base64 در پاسخ JSON

پارامترها

نام نوع الزامی توضیحات
prompt string بله توضیح تصویر
style string خیر photo | sticker | product | minimalist
view string خیر 1|img برای خروجی باینری، html برای صفحه
seed int خیر بذر تصادفی
width int خیر پهنای تصویر (حداکثر 2048)
height int خیر ارتفاع تصویر (حداکثر 2048)

نمونه‌ها

تصویر محصول
https://api.miahub.live/api/image_gen.php?prompt=minimal%20black%20mug&style=product&view=img
راهنمای سبک
https://api.miahub.live/api/image_gen.php?guide=1

استخراج داده

Scrape API /api/scrape.php GET / POST
▼

استخراج محتوای صفحات وب، متن، لینک‌ها و فایل‌های قابل دانلود.

پارامترها

نام نوع الزامی توضیحات
url string بله آدرس صفحه
result_index int خیر شماره نتیجه از آخرین جستجو
download boolean خیر 1=استخراج لینک‌های دانلود
selector string خیر CSS selector برای بخش خاص

نمونه‌ها

استخراج محتوا
https://api.miahub.live/api/scrape.php?url=https://example.com
نتیجه دوم جستجو
https://api.miahub.live/api/scrape.php?result_index=2

دانشنامه

Wiki API /api/wiki.php GET
▼

جستجو و دریافت اطلاعات از ویکی‌پدیا.

پارامترها

نام نوع الزامی توضیحات
q string بله عبارت جستجو
lang string خیر زبان (fa, en)

نمونه‌ها

جستجوی ویکی
https://api.miahub.live/api/wiki.php?q=هوش مصنوعی&lang=fa

شبکه

IP Whois API /api/ipwhois.php GET
▼

دریافت اطلاعات جغرافیایی و شبکه‌ای یک آدرس IP.

پارامترها

نام نوع الزامی توضیحات
ip string بله آدرس IP (IPv4 یا IPv6)

نمونه‌ها

اطلاعات IP
https://api.miahub.live/api/ipwhois.php?ip=8.8.8.8
Domain WHOIS (RDAP) /api/security/whois.php GET / POST
▼

پروکسی RDAP برای دامنه‌های com/net (ورایزن). ورودی domain و خروجی JSON کامل RDAP.

پارامترها

نام نوع الزامی توضیحات
domain string بله مثال: google.com

نمونه‌ها

RDAP دامنه
https://api.miahub.live/api/security/whois.php?domain=google.com

ابزارهای توسعه

cURL Snippet Builder /api/snippet_curl.php GET / POST
▼

تولید دستور cURL چندخطی بر اساس ورودی پویا (URL، متد، هدرها، کوئری، بدنه، فایل‌ها، احراز هویت). برای تست API و نمایش در UI.

✓ پشتیبانی body_mode: json, form, raw, json_pretty, none ✓ هدرهای Bearer و Basic، اضافه شدن خودکار Content-Type منطقی ✓ فلگ‌های curl: follow_redirects(-L), silent(-sS), insecure(-k), compressed, timeout ✓ multipart: ارسال هم‌زمان فیلدهای فرم و فایل‌ها با -F ✓ هشدار URL نامعتبر + normalized خروجی برای مصرف در UI

پارامترها

نام نوع الزامی توضیحات
url string بله آدرس کامل Endpoint (http/https)
method string خیر GET/POST/PUT/PATCH/DELETE (پیش‌فرض GET)
headers object|array خیر کلید/مقدار یا [{name,value}]
params|query object خیر پارامترهای کوئری
body object|string خیر بدنه درخواست
body_mode string خیر json|form|raw|json_pretty|none
files array خیر [{name, path|filename}] برای multipart
auth_bearer string خیر توکن Bearer
auth_basic.user/pass string خیر نام‌کاربری/رمز برای Basic
follow_redirects bool خیر -L
silent bool خیر -sS
insecure bool خیر -k
compressed bool خیر --compressed
timeout int خیر --max-time بر ثانیه

نمونه‌ها

POST JSON با Bearer
https://api.miahub.live/api/snippet_curl.php
POST JSON: {"url":"https://api.example.com/items","method":"POST","headers":{"Authorization":"Bearer 123"},"body":{"title":"Sample"},"body_mode":"json"}
Multipart با فایل و فیلد فرم
https://api.miahub.live/api/snippet_curl.php
POST multipart: {"url":"https://api.example.com/upload","method":"POST","files":[{"name":"file","path":"/tmp/a.png"}],"body":{"note":"hello"}}
Python Snippet Builder (requests) /api/snippet_python.php GET / POST
▼

تولید کد Python با کتابخانه requests بر اساس ورودی پویا (URL، متد، هدرها، کوئری، بدنه، فایل، احراز هویت).

✓ پشتیبانی body_mode: json, form, raw, none ✓ auth Bearer (هدر) و Basic به‌صورت auth tuple ✓ timeout, verify, allow_redirects, proxies ✓ multipart: فایل + فیلد فرم در files/data ✓ normalized و warnings در خروجی JSON

پارامترها

نام نوع الزامی توضیحات
url string بله آدرس کامل Endpoint (http/https)
method string خیر GET/POST/PUT/PATCH/DELETE
headers object|array خیر کلید/مقدار یا [{name,value}]
params|query object خیر پارامترهای کوئری
body object|string خیر بدنه درخواست
body_mode string خیر json|form|raw|none
files array خیر [{name, path|filename}]
auth_bearer string خیر هدر Bearer
auth_basic.user/pass string خیر auth tuple برای requests
timeout number خیر timeout ثانیه
verify bool خیر verify=False برای گواهی نامعتبر
allow_redirects bool خیر دنبال کردن ریدایرکت
proxies object خیر مثل {"http":"http://proxy:8080"}

نمونه‌ها

POST JSON با Basic Auth
https://api.miahub.live/api/snippet_python.php
POST JSON: {"url":"https://api.example.com/items","method":"POST","auth_basic":{"user":"u","pass":"p"},"body":{"title":"Sample"},"body_mode":"json"}
Upload فایل با timeout و verify=false
https://api.miahub.live/api/snippet_python.php
Multipart: {"url":"https://api.example.com/upload","method":"POST","files":[{"name":"file","path":"/tmp/a.png"}],"timeout":15,"verify":false}
JSONify /api/jsonify.php GET / POST
▼

نرمال‌سازی ورودی متن به JSON: تلاش برای decode، یا key:value، یا wrap. حالت passthrough برای فرم.

✓ mode: auto | raw | kv | passthrough ✓ خروجی شامل parsed, raw, mode, error ✓ پشتیبانی بدنه خام یا GET/POST

پارامترها

نام نوع الزامی توضیحات
text|data string خیر متن ورودی (بدنه یا پارامتر)
mode string خیر auto (پیش‌فرض) | raw | kv | passthrough

نمونه‌ها

حالت auto
https://api.miahub.live/api/jsonify.php
{"text":"key: value","mode":"auto"}
حالت kv
https://api.miahub.live/api/jsonify.php
{"mode":"kv","text":"a:1\nb:2"}

امنیت و اسکن

Security Scanner /api/security/scanner.php GET / POST
▼

اسکن سبک استاتیک با regex برای PHP/HTML/CSS/JS جهت یافتن الگوهای ناامن یا مشکوک. خروجی JSON شامل issues، ریسک و خلاصه.

✓ mode: fast | full | deep ✓ فیلتر severity و confidence، پشتیبانی chunk برای ورودی بزرگ ✓ backup اختیاری از ورودی، sha256 و risk score ✓ profiles فریم‌ورک (wordpress/laravel/...) از rules.php

پارامترها

نام نوع الزامی توضیحات
code string بله متن کد برای اسکن
lang string خیر php|html|css|auto (پیش‌فرض auto)
mode string خیر fast|full|deep
chunk int خیر حجم هر chunk (پیش‌فرض 8000)
overlap int خیر هم‌پوشانی chunk (پیش‌فرض 200)
profile string خیر مثلاً wordpress | laravel | ...
disable string خیر لیست rule id با کاما برای غیرفعال‌سازی
min_severity string خیر high|medium|info
min_confidence string خیر high|medium|low
backup bool خیر بازگرداندن نسخه ورودی در خروجی
verbose bool خیر نمایش reason و suggestion

نمونه‌ها

اسکن PHP سریع
https://api.miahub.live/api/security/scanner.php?mode=fast&lang=php
{"ok":true,"issues":[...],"risk_score":30}
اسکن HTML با پروفایل وردپرس
https://api.miahub.live/api/security/scanner.php?mode=full&profile=wordpress
{"ok":true,"issues":[...],"profile":"wordpress"}
Security Rules (config) /api/security/rules.php INCLUDE
▼

فایل پیکربندی ruleها برای scanner شامل regexها، severity، confidence و پروفایل‌های فریم‌ورکی.

✓ تعریف rule به‌صورت id, severity, pattern, msg, suggestion ✓ mode: fast/full/deep و فیلتر min_severity/min_confidence ✓ پروفایل‌های آماده: wordpress, laravel, codeigniter, symfony, yii, drupal ✓ گروه‌بندی برای php/html/css/js و structure

پارامترها

نام نوع الزامی توضیحات
- - خیر فایل تنظیمات است؛ به‌صورت include در scanner استفاده می‌شود.

نمونه‌ها

نمونه ساختار rule
https://api.miahub.live/api/security/rules.php
['id'=>'php.eval','severity'=>'high','pattern'=>'/eval\(/i','msg'=>'dangerous function']