مستندات API

هر ورک‌فلوی منتشرشده یک endpoint دارد. ورودی‌ها همان کلیدهای نودهای «ورودی» و خروجی‌ها کلیدهای نودهای «خروجی» هستند.

آدرس پایه: https://api.mlgrid.com

احراز هویت

از صفحه‌ی «کلیدهای API» یک کلید بسازید و در هدر Authorization بفرستید.

headerhttp
Authorization: Bearer mlg_xxxxxxxxxxxxxxxx

اجرای ورک‌فلو

درخواست هم‌زمان است و پس از پایان اجرا، نتیجه را برمی‌گرداند.

requesthttp
POST https://api.mlgrid.com/v1/workflows/{slug}/run
Content-Type: application/json

{ "input": { "text": "..." } }
200 OKjson
{
  "id": "cm...",
  "status": "succeeded",
  "output": { "summary": "..." },
  "usage": { "tokensIn": 812, "tokensOut": 164, "cost": "38.2", "currency": "IRT" }
}

فایل‌های خروجی

خروجی‌هایی مثل تصویر، صدا، ویدیو، PDF، Word و اکسل به‌صورت آدرس (URL) برگردانده می‌شوند. این فایل‌ها ۲۴ ساعت پس از ساخت حذف می‌شوند؛ اگر لازمشان دارید همان موقع دانلود و ذخیره کنید.

دریافت قرارداد ورودی/خروجی

requesthttp
GET https://api.mlgrid.com/v1/workflows/{slug}

وضعیت یک اجرا

requesthttp
GET https://api.mlgrid.com/v1/runs/{id}

حافظه و session

اگر ورک‌فلو نود «خواندن حافظه» و «ذخیره در حافظه» داشته باشد، هر فراخوانی با یک session یکسان ادامه‌ی همان گفتگو حساب می‌شود. حافظه برای هر کاربر (کلید API) جداست؛ کاربران مختلف یک ورک‌فلوی عمومی هرگز حافظه‌ی هم را نمی‌بینند. پیام‌های قدیمی‌تر از پنجره‌ی تنظیم‌شده به نودی که برای خلاصه‌سازی وصل کرده‌اید داده می‌شوند و خلاصه جایگزینشان می‌شود.

requesthttp
POST https://api.mlgrid.com/v1/workflows/{slug}/run
Authorization: Bearer mlg_xxxxxxxx
Content-Type: application/json

{ "input": { "message": "اسم من سارا است" }, "session": "user-42" }
پاک کردن حافظهhttp
DELETE https://api.mlgrid.com/v1/workflows/{slug}/memory?session=user-42

محاسبه‌ی هزینه

هزینه‌ی هر نود = (توکن ورودی × نرخ ورودی + توکن خروجی × نرخ خروجی) ÷ ۱٬۰۰۰٬۰۰۰ + هزینه‌ی ثابت هر فراخوانی. هزینه‌ی کل اجرا جمع همه‌ی نودها به‌اضافه‌ی کارمزد سازنده (در صورت وجود) است و از کیف پول فراخواننده کسر می‌شود.

توکن‌ها مستقیماً از گزارش ارائه‌دهنده‌ی مدل خوانده می‌شوند. اگر اجرا وسط کار شکست بخورد، فقط هزینه‌ی نودهایی که اجرا شده‌اند محاسبه می‌شود.

خطاها

400بدنه‌ی درخواست نامعتبر است (مثلاً فیلد input ارسال نشده).
401کلید API ارسال نشده یا باطل شده است.
402موجودی کیف پول کافی نیست.
404ورک‌فلو وجود ندارد، منتشر نشده یا خصوصی است.
422اجرای یکی از نودها ناموفق بود؛ nodeId در پاسخ مشخص است.
429تعداد درخواست بیش از حد مجاز (۶۰ درخواست در دقیقه برای هر کاربر).

ساخت مدل اختصاصی

فایل main.py باید تابع execute را تعریف کند. مقدار بازگشتی یا مستقیماً دیکشنری خروجی‌هاست یا شامل outputs و usage برای گزارش توکن.

main.pypython
def execute(inputs, params):
    text = inputs.get("text", "")
    return {
        "outputs": {"text": text[::-1]},
        "usage": {"tokensIn": len(text), "tokensOut": len(text)},
    }