پرش به مطلب اصلی

مرجع توانایی‌ها

توانایی‌ها کنش‌های اتمی هستند که Gratis AI Agent می‌تواند روی نصب WordPress شما فراخوانی کند. هر توانایی یک کلاس PHP ثبت‌شده است که یک شِمای JSON را ارائه می‌دهد — عامل این شِما را در زمان اجرا می‌خواند تا بفهمد چه پارامترهایی لازم‌اند و توانایی چه چیزی را برمی‌گرداند.

این صفحه همه توانایی‌هایی را مستند می‌کند که همراه با Gratis AI Agent v1.9.0 ارائه می‌شوند.


انواع نوشته سفارشی

این توانایی‌ها انواع نوشته سفارشی (CPTها) را که از طریق عامل ثبت شده‌اند مدیریت می‌کنند. ثبت‌ها در جدول گزینه‌های WordPress پایدار می‌شوند تا پس از غیرفعال‌سازی و فعال‌سازی دوباره plugin نیز باقی بمانند.

register_post_type

یک نوع نوشته سفارشی جدید ثبت می‌کند.

پارامترها

پارامترنوعالزامیتوضیح
slugstringبلهکلید نوع نوشته (حداکثر ۲۰ نویسه، بدون حروف بزرگ، بدون فاصله)
singular_labelstringبلهنام مفرد قابل‌خواندن برای انسان، برای مثال Portfolio Item
plural_labelstringبلهنام جمع قابل‌خواندن برای انسان، برای مثال Portfolio Items
publicbooleanخیراینکه آیا نوع نوشته به‌صورت عمومی قابل دسترسی است یا نه. پیش‌فرض true
supportsarrayخیرقابلیت‌هایی برای پشتیبانی: title، editor، thumbnail، excerpt، comments، revisions، custom-fields. پیش‌فرض ["title","editor"]
has_archivebooleanخیراینکه آیا صفحه بایگانی نوع نوشته فعال است یا نه. پیش‌فرض false
menu_iconstringخیرکلاس Dashicons یا URL برای آیکن منوی مدیریت. پیش‌فرض "dashicons-admin-post"
rewrite_slugstringخیرslug نشانی اینترنتی برای نوع نوشته. به‌طور پیش‌فرض برابر با slug است

مثال

{
"slug": "portfolio",
"singular_label": "Portfolio Item",
"plural_label": "Portfolio Items",
"public": true,
"supports": ["title", "editor", "thumbnail"],
"has_archive": true,
"menu_icon": "dashicons-portfolio"
}

برمی‌گرداند { "success": true, "slug": "portfolio" }


list_post_types

همه انواع نوشته سفارشی ثبت‌شده توسط عامل را برمی‌گرداند.

پارامترها — هیچ‌کدام

برمی‌گرداند

{
"post_types": [
{
"slug": "portfolio",
"singular_label": "Portfolio Item",
"plural_label": "Portfolio Items",
"public": true
}
]
}

delete_post_type

یک نوع نوشته سفارشی را که قبلاً توسط عامل ثبت شده لغو ثبت می‌کند. نوشته‌های موجود از آن نوع در پایگاه داده باقی می‌مانند اما دیگر از طریق نوع نوشته قابل دسترسی نیستند.

پارامترها

پارامترنوعالزامیتوضیح
slugstringبلهکلید نوع نوشته برای حذف

برمی‌گرداند { "success": true, "slug": "portfolio" }


رده‌بندی‌های سفارشی

این توانایی‌ها رده‌بندی‌های سفارشی را مدیریت می‌کنند. مانند CPTها، ثبت‌های رده‌بندی پایدار می‌شوند.

register_taxonomy

یک رده‌بندی سفارشی جدید ثبت می‌کند.

پارامترها

پارامترنوعالزامیتوضیح
slugstringبلهکلید رده‌بندی (حداکثر ۳۲ نویسه)
singular_labelstringبلهنام مفرد قابل‌خواندن برای انسان، برای مثال Project Category
plural_labelstringبلهنام جمع قابل‌خواندن برای انسان، برای مثال Project Categories
post_typesarrayبلهslugهای نوع نوشته که این رده‌بندی باید به آن‌ها متصل شود
hierarchicalbooleanخیرtrue برای سبک دسته‌بندی، false برای سبک برچسب. پیش‌فرض true
publicbooleanخیراینکه آیا اصطلاح‌ها به‌صورت عمومی قابل دسترسی هستند یا نه. پیش‌فرض true
rewrite_slugstringخیرslug نشانی اینترنتی برای رده‌بندی. به‌طور پیش‌فرض برابر با slug است

مثال

{
"slug": "project-category",
"singular_label": "Project Category",
"plural_label": "Project Categories",
"post_types": ["portfolio"],
"hierarchical": true
}

برمی‌گرداند { "success": true, "slug": "project-category" }


list_taxonomies

همه رده‌بندی‌های سفارشی ثبت‌شده توسط عامل را برمی‌گرداند.

پارامترها — هیچ‌کدام

برمی‌گرداند

{
"taxonomies": [
{
"slug": "project-category",
"singular_label": "Project Category",
"post_types": ["portfolio"],
"hierarchical": true
}
]
}

delete_taxonomy

یک رده‌بندی سفارشی را که قبلاً توسط عامل ثبت شده لغو ثبت می‌کند.

پارامترها

پارامترنوعالزامیتوضیح
slugstringبلهکلید رده‌بندی برای حذف

برمی‌گرداند { "success": true, "slug": "project-category" }


سیستم طراحی

توانایی‌های سیستم طراحی ارائه بصری سایت WordPress را تغییر می‌دهند — از CSS سفارشی تا الگوهای بلوکی و لوگوی سایت.

inject_custom_css

CSS را از طریق wp_add_inline_style به <head> سایت اضافه می‌کند. CSS در گزینه gratis_ai_agent_custom_css ذخیره می‌شود و وقتی توانایی بازنشانی شود، به‌طور تمیز از صف خارج می‌شود.

پارامترها

پارامترنوعالزامیتوضیح
cssstringبلهCSS معتبر برای تزریق
labelstringخیربرچسب قابل‌خواندن برای انسان برای این بلوک CSS، مورد استفاده در گزارش‌های اشکال‌زدایی. پیش‌فرض "agent-injected"
replacebooleanخیراگر true باشد، همه CSSهای تزریق‌شده قبلی را جایگزین می‌کند. پیش‌فرض false (الحاق می‌کند)

مثال

{
"css": ":root { --primary: #1a1a2e; --accent: #e94560; } body { font-family: 'Inter', sans-serif; }",
"label": "brand-colours",
"replace": false
}

برمی‌گرداند { "success": true, "bytes": 96 }


add_block_pattern

یک الگوی بلوکی قابل استفاده مجدد را در کتابخانه الگوهای WordPress ثبت می‌کند.

پارامترها

پارامترنوعالزامیتوضیح
slugstringبلهشناسه الگو، برای مثال gratis/hero-dark
titlestringبلهنام الگوی قابل‌خواندن برای انسان که در ویرایشگر نمایش داده می‌شود
contentstringبلهنشانه‌گذاری بلوکی سریال‌شده (HTML) برای الگو
categoriesarrayخیرslugهای دسته الگو، برای مثال ["featured", "hero"]
descriptionstringخیرتوضیح کوتاهی که در انتخاب‌گر الگو نمایش داده می‌شود
keywordsarrayخیرکلیدواژه‌های جست‌وجو

برمی‌گرداند { "success": true, "slug": "gratis/hero-dark" }


list_block_patterns

همه الگوهای بلوکی ثبت‌شده توسط عامل را فهرست می‌کند.

پارامترها — هیچ‌کدام

بازمی‌گرداند

{
"patterns": [
{
"slug": "gratis/hero-dark",
"title": "Dark Hero",
"categories": ["hero"]
}
]
}

لوگوی سایت WordPress را روی یک شناسه پیوست مشخص یا یک URL تصویر راه دور تنظیم می‌کند. وقتی یک URL ارائه شود، تصویر دانلود و به کتابخانه رسانه وارد می‌شود.

پارامترها

پارامترنوعالزامیتوضیحات
attachment_idintegerخیرشناسه یک پیوست موجود در کتابخانه رسانه
urlstringخیرURL تصویر راه دور برای وارد کردن و تنظیم به‌عنوان لوگو

یکی از attachment_id یا url باید ارائه شود.

بازمی‌گرداند { "success": true, "attachment_id": 42 }


apply_theme_json_preset

یک پیش‌تنظیم نام‌گذاری‌شده رنگ/تایپوگرافی را روی theme.json (یا global-styles) پوسته فعال اعمال می‌کند. پیش‌تنظیم‌ها بسته‌های گزینش‌شده‌ای هستند که توسط تیم Gratis AI Agent نگهداری می‌شوند.

پارامترها

پارامترنوعالزامیتوضیحات
presetstringبلهنام پیش‌تنظیم، مثلاً minimal-dark، warm-editorial، corporate-blue
mergebooleanخیراگر true باشد، به‌جای جایگزینی، با مقادیر موجود ادغام می‌کند. پیش‌فرض false

پیش‌تنظیم‌های موجود

پیش‌تنظیمتوضیحات
minimal-darkپس‌زمینه نزدیک به مشکی، متن سفید، یک رنگ تأکیدی
warm-editorialپس‌زمینه گرم مایل به سفید، تیترهای سریف، رنگ‌های تأکیدی خاکی
corporate-blueپالت سرمه‌ای و سفید با تایپوگرافی حرفه‌ای
vibrant-startupگرادیان‌های روشن، گوشه‌های گرد، نوع sans-serif مدرن
classic-blogخاکستری‌های خنثی، ارتفاع خط راحت، فاصله‌گذاری چیدمان سنتی

بازمی‌گرداند { "success": true, "preset": "minimal-dark" }


استایل‌های سراسری

توانایی‌های استایل‌های سراسری، مقادیر theme.json را از طریق API استایل‌های سراسری WordPress می‌خوانند و می‌نویسند و بر همه بلوک‌ها و قالب‌ها در سراسر سایت اثر می‌گذارند.

get_global_styles

پیکربندی فعلی استایل‌های سراسری را بازمی‌گرداند.

پارامترها

پارامترنوعالزامیتوضیحات
pathstringخیراشاره‌گر JSON به یک مقدار مشخص، مثلاً /color/palette یا /typography/fontSizes. اگر حذف شود، کل شیء را بازمی‌گرداند.

بازمی‌گرداند شیء کامل استایل‌های سراسری یا مقدار موجود در path.


set_global_styles

یک یا چند مقدار را در پیکربندی استایل‌های سراسری به‌روزرسانی می‌کند.

پارامترها

پارامترنوعالزامیتوضیحات
pathstringبلهاشاره‌گر JSON به مقداری که باید تنظیم شود، مثلاً /color/palette
valueanyبلهمقدار جدید

مثال — افزودن یک رنگ به پالت

{
"path": "/color/palette",
"value": [
{ "slug": "primary", "color": "#1a1a2e", "name": "Primary" },
{ "slug": "accent", "color": "#e94560", "name": "Accent" }
]
}

بازمی‌گرداند { "success": true, "path": "/color/palette" }


reset_global_styles

همه تغییرات استایل‌های سراسری اعمال‌شده توسط agent را بازنشانی می‌کند و پیش‌فرض‌های پوسته را بازیابی می‌کند.

پارامترها — هیچ‌کدام

بازمی‌گرداند { "success": true }


توانایی‌های فهرست ناوبری، فهرست‌های ناوبری WordPress و آیتم‌های آن‌ها را ایجاد و مدیریت می‌کنند.

create_menu

یک فهرست ناوبری جدید WordPress ایجاد می‌کند.

پارامترها

پارامترنوعالزامیتوضیحات
namestringبلهنام فهرست، مثلاً Primary Navigation
locationstringخیرمکان پوسته برای اختصاص این فهرست به آن، مثلاً primary

بازمی‌گرداند { "success": true, "menu_id": 7 }


update_menu

نام یک فهرست را تغییر می‌دهد یا آن را دوباره به یک مکان پوسته اختصاص می‌دهد.

پارامترها

پارامترنوعالزامیتوضیحات
menu_idintegerبلهشناسه فهرستی که باید به‌روزرسانی شود
namestringخیرنام جدید فهرست
locationstringخیرمکان پوسته برای اختصاص یا اختصاص دوباره

بازمی‌گرداند { "success": true, "menu_id": 7 }


add_menu_item

یک آیتم به یک فهرست ناوبری موجود اضافه می‌کند.

پارامترها

پارامترنوعالزامیتوضیحات
menu_idintegerبلهشناسه فهرست هدف
typestringبلهنوع آیتم: custom، post_type، یا taxonomy
titlestringخیربرچسب برای آیتم فهرست (برای نوع custom الزامی است)
urlstringخیرURL برای آیتم‌های custom
object_idintegerخیرشناسه نوشته یا شناسه اصطلاح برای آیتم‌های post_type/taxonomy
parent_idintegerخیرشناسه آیتم فهرست برای قرار دادن این آیتم زیر آن
positionintegerخیرجایگاه مبتنی بر صفر در فهرست

بازمی‌گرداند { "success": true, "item_id": 12 }


remove_menu_item

یک آیتم را از یک فهرست ناوبری حذف می‌کند.

پارامترها

پارامترنوعالزامیتوضیحات
item_idintegerبلهشناسه آیتم فهرست برای حذف

بازمی‌گرداند { "success": true, "item_id": 12 }


list_menus

همه فهرست‌های ناوبری WordPress را همراه با مکان‌های پوسته اختصاص‌یافته آن‌ها فهرست می‌کند.

پارامترها — هیچ‌کدام

بازمی‌گرداند

{
"menus": [
{
"menu_id": 7,
"name": "Primary Navigation",
"location": "primary",
"item_count": 5
}
]
}

مدیریت گزینه‌ها

توانایی‌های گزینه‌ها، گزینه‌های WordPress را از طریق get_option / update_option می‌خوانند و می‌نویسند. یک فهرست مسدودی ایمنی داخلی از تغییر تصادفی تنظیمات حیاتی جلوگیری می‌کند.

get_option

یک گزینه WordPress را می‌خواند.

پارامترها

پارامترنوعالزامیتوضیحات
option_namestringبلهکلید گزینه، مثلاً blogname

بازمی‌گرداند { "option_name": "blogname", "value": "My Site" }

اگر option_name در فهرست مسدودی ایمنی باشد، خطا بازمی‌گرداند.


set_option

یک گزینه WordPress را می‌نویسد.

پارامترها

پارامترنوعالزامیتوضیحات
option_namestringبلهکلید گزینه
valueanyبلهمقدار جدید (برای آرایه‌ها/اشیا به‌صورت خودکار سریال‌سازی می‌شود)
autoloadstringخیر"yes" یا "no". پیش‌فرض، تنظیم موجود autoload را حفظ می‌کند

اگر option_name در فهرست مسدودی ایمنی باشد، خطا برمی‌گرداند.

برمی‌گرداند { "success": true, "option_name": "blogname" }


delete_option

یک گزینه WordPress را حذف می‌کند.

پارامترها

پارامترنوعالزامیتوضیح
option_namestringبلهکلید گزینه برای حذف

اگر option_name در فهرست مسدودی ایمنی باشد، خطا برمی‌گرداند.

برمی‌گرداند { "success": true, "option_name": "my_custom_option" }


list_options

گزینه‌های WordPress مطابق با یک الگو را فهرست می‌کند.

پارامترها

پارامترنوعالزامیتوضیح
patternstringخیرالگوی SQL LIKE برای فیلتر کردن نام‌های گزینه، مانند gratis_%. اگر حذف شود همه گزینه‌ها را برمی‌گرداند (در پایگاه‌های داده بزرگ با احتیاط استفاده کنید).
limitintegerخیرحداکثر تعداد نتایج. پیش‌فرض 50، حداکثر 500

برمی‌گرداند

{
"options": [
{ "option_name": "gratis_ai_agent_version", "autoload": "yes" }
],
"total": 1
}

مدیریت محتوا

قابلیت‌های مدیریت محتوا نوشته‌ها و برگه‌های WordPress را ایجاد و ویرایش می‌کنند. شناسه‌های نوشته برگردانده می‌شوند تا مراحل بعدی در planهای چندقابلیتی بتوانند به محتوای ایجادشده ارجاع دهند.

create_post

یک نوشته، برگه، یا ورودی نوع نوشته سفارشی جدید در WordPress ایجاد می‌کند.

پارامترها

پارامترنوعالزامیتوضیح
titlestringبلهعنوان نوشته
contentstringخیربدنه نوشته — متن ساده، HTML، یا نشانه‌گذاری بلوک سریال‌شده را می‌پذیرد
statusstringخیرdraft، publish، pending، private. پیش‌فرض draft
post_typestringخیرslug نوع نوشته، مانند post، page، یا هر CPT ثبت‌شده. پیش‌فرض post
excerptstringخیرخلاصه کوتاه که در بایگانی‌ها و نتایج جست‌وجو نمایش داده می‌شود
categoriesarrayخیرآرایه‌ای از نام‌ها یا شناسه‌های دسته برای اختصاص دادن
tagsarrayخیرآرایه‌ای از نام‌ها یا شناسه‌های برچسب برای اختصاص دادن
authorintegerخیرشناسه کاربر WordPress برای تنظیم به‌عنوان نویسنده نوشته. به‌طور پیش‌فرض کاربر فعلی است
datestringخیرتاریخ انتشار در قالب ISO 8601، مانند 2026-05-01T09:00:00
page_templatestringخیرفایل قالب برای اختصاص دادن به این نوشته یا برگه، مانند page-full-width.php. فقط زمانی معنادار است که post_type برابر page باشد یا یک CPT که از قالب‌های برگه پشتیبانی می‌کند.

مثال

{
"title": "Welcome to Our New Site",
"content": "<!-- wp:paragraph --><p>Hello world!</p><!-- /wp:paragraph -->",
"status": "publish",
"post_type": "page",
"page_template": "page-full-width.php"
}

برمی‌گرداند { "success": true, "post_id": 42, "permalink": "https://example.com/welcome/" }


update_post

یک نوشته یا برگه موجود WordPress را به‌روزرسانی می‌کند.

پارامترها

پارامترنوعالزامیتوضیح
post_idintegerبلهشناسه نوشته‌ای که باید به‌روزرسانی شود
titlestringخیرعنوان جدید نوشته
contentstringخیربدنه جدید نوشته
statusstringخیروضعیت جدید: draft، publish، pending، private
excerptstringخیرچکیده جدید
categoriesarrayخیرفهرست کامل دسته‌ها را با این آرایه از نام‌ها یا شناسه‌ها جایگزین کنید
tagsarrayخیرفهرست کامل برچسب‌ها را با این آرایه از نام‌ها یا شناسه‌ها جایگزین کنید
page_templatestringخیرفایل قالب جدید برای اختصاص دادن به این نوشته یا برگه، مانند page-full-width.php. برای حذف انتساب قالب و بازگشت به پیش‌فرض theme، یک رشته خالی ارسال کنید.

مثال — تغییر قالب پس از ایجاد

{
"post_id": 42,
"page_template": "page-full-width.php"
}

برمی‌گرداند { "success": true, "post_id": 42 }


batch_create_posts

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

پارامترها

پارامترنوعالزامیتوضیح
postsarrayبلهآرایه‌ای از اشیای نوشته، که هرکدام همان پارامترهای create_post را می‌پذیرند
stop_on_errorbooleanخیراگر true باشد، پردازش پس از نخستین شکست متوقف می‌شود. پیش‌فرض false

مثال

{
"posts": [
{
"title": "About Us",
"post_type": "page",
"status": "publish",
"page_template": "page-full-width.php"
},
{
"title": "Services",
"post_type": "page",
"status": "publish"
},
{
"title": "Contact",
"post_type": "page",
"status": "publish"
}
]
}

برمی‌گرداند

{
"created": 3,
"failed": 0,
"results": [
{ "success": true, "post_id": 42, "title": "About Us" },
{ "success": true, "post_id": 43, "title": "Services" },
{ "success": true, "post_id": 44, "title": "Contact" }
]
}

set_featured_image

یک تصویر شاخص (تصویر بندانگشتی نوشته) را به یک نوشته یا برگه موجود اختصاص می‌دهد. شناسه پیوست موجود در Media Library یا URL تصویر راه‌دور را می‌پذیرد؛ وقتی URL ارائه شود، تصویر به‌طور خودکار دانلود و وارد می‌شود.

پارامترها

پارامترنوعالزامیتوضیح
post_idintegerبلهشناسه نوشته یا برگه‌ای که باید به‌روزرسانی شود
attachment_idintegerخیرشناسه یک پیوست موجود در Media Library
urlstringخیرURL تصویر راه‌دور برای وارد کردن و تنظیم به‌عنوان تصویر شاخص
alt_textstringخیرمتن جایگزین برای اعمال به پیوست اگر از یک URL وارد شده باشد

یکی از attachment_id یا url باید ارائه شود.

برمی‌گرداند { "success": true, "post_id": 42, "attachment_id": 17 }


create_contact_form

یک فرم تماس با استفاده از plugin فرم فعال ایجاد می‌کند (Contact Form 7، WPForms، Fluent Forms، یا Gravity Forms، بسته به این‌که کدام نصب شده باشد). یک shortcode برمی‌گرداند که می‌تواند در هر نوشته یا برگه‌ای جاسازی شود.

پارامترها

پارامترنوعضروریتوضیحات
titlestringبلهنام فرم که در مدیریت plugin فرم نمایش داده می‌شود
fieldsarrayبلهفهرست مرتب فیلدهای فرم (شیء فیلد را در پایین ببینید)
recipientstringخیرنشانی ایمیل برای دریافت ارسال‌ها. به‌طور پیش‌فرض ایمیل مدیر WordPress است
subjectstringخیرخط موضوع ایمیل. هنگام استفاده از Contact Form 7 از جای‌نگهدارهای [your-name] و [your-subject] پشتیبانی می‌کند
confirmation_messagestringخیرپیامی که پس از ارسال موفق نمایش داده می‌شود. پیش‌فرض: "Thank you for your message. We'll be in touch soon."

شیء فیلد

کلیدنوعضروریتوضیحات
namestringبلهنام داخلی فیلد / کلید ماشینی
labelstringبلهبرچسب قابل‌فهم برای انسان که روی فرم نمایش داده می‌شود
typestringبلهtext, email, tel, textarea, select, checkbox, radio, file, date
requiredbooleanخیرآیا فیلد باید پیش از ارسال پر شود یا نه. پیش‌فرض false
optionsarrayخیرگزینه‌ها برای فیلدهای select، checkbox و radio
placeholderstringخیرمتن جای‌نگهدار برای ورودی‌های نوع متن

مثال

{
"title": "Restaurant Booking Enquiry",
"fields": [
{ "name": "your-name", "label": "Name", "type": "text", "required": true },
{ "name": "your-email", "label": "Email", "type": "email", "required": true },
{ "name": "party-size", "label": "Party size", "type": "select", "options": ["1–2", "3–5", "6–10", "10+"] },
{ "name": "your-message", "label": "Special requests", "type": "textarea", "required": false }
],
"recipient": "[email protected]",
"subject": "New booking enquiry from [your-name]"
}

بازمی‌گرداند

{
"success": true,
"form_id": 3,
"shortcode": "[contact-form-7 id=\"3\" title=\"Restaurant Booking Enquiry\"]"
}

بازبینی بصری

قابلیت‌های بازبینی بصری به agent اجازه می‌دهد از برگه‌های زنده اسکرین‌شات بگیرد و آن‌ها را تحلیل کند؛ در نتیجه بازبینی طراحی خودکار، مقایسه‌های قبل/بعد، و بررسی‌های رگرسیون بصری بدون نیاز به هیچ افزونه مرورگری امکان‌پذیر می‌شود.

capture_screenshot

از یک برگه WordPress در URL مشخص، با استفاده از مرورگر headless سمت سرور، اسکرین‌شات می‌گیرد. تصویر در Media Library ذخیره می‌شود و یک URL مربوط به CDN بازگردانده می‌شود.

پارامترها

پارامترنوعضروریتوضیحات
urlstringبلهURL کامل برگه‌ای که باید از آن اسکرین‌شات گرفته شود، مانند https://example.com/about/
widthintegerخیرعرض viewport بر حسب پیکسل. پیش‌فرض 1280
heightintegerخیرارتفاع viewport بر حسب پیکسل. پیش‌فرض 800
full_pagebooleanخیربه‌جای فقط viewport، کل برگه قابل پیمایش را ثبت می‌کند. پیش‌فرض false
delay_msintegerخیرمدت انتظار بر حسب میلی‌ثانیه پس از بارگذاری برگه پیش از ثبت، که برای محتوای متحرک مفید است. پیش‌فرض 500
labelstringخیربرچسب قابل‌فهم برای انسان که همراه با پیوست در Media Library ذخیره می‌شود

بازمی‌گرداند

{
"success": true,
"attachment_id": 88,
"url": "https://example.com/wp-content/uploads/2026/04/screenshot-about.png",
"width": 1280,
"height": 800
}

compare_screenshots

دو اسکرین‌شات را می‌گیرد و یک امتیاز تفاوت بصری به‌همراه تصویری از تفاوت‌ها که نواحی تغییرکرده را برجسته می‌کند بازمی‌گرداند. برای تأیید اینکه یک تغییر طراحی نتیجه مورد انتظار را ایجاد کرده یا برای شناسایی رگرسیون‌های ناخواسته مفید است.

پارامترها

پارامترنوعضروریتوضیحات
before_urlstringبلهURL برگه‌ای که باید به‌عنوان وضعیت «قبل» ثبت شود
after_urlstringبلهURL برگه‌ای که باید به‌عنوان وضعیت «بعد» ثبت شود. اگر مقایسه در طول زمان انجام می‌شود، می‌تواند همان URL باشد
widthintegerخیرعرض viewport برای هر دو ثبت. پیش‌فرض 1280
thresholdfloatخیرآستانه تفاوت پیکسلی (0.0–1.0). پیکسل‌های درون این میزان تحمل، بدون تغییر در نظر گرفته می‌شوند. پیش‌فرض 0.1

بازمی‌گرداند

{
"success": true,
"diff_score": 0.04,
"changed_pixels": 2340,
"total_pixels": 1024000,
"diff_attachment_id": 91,
"diff_url": "https://example.com/wp-content/uploads/2026/04/diff-about.png"
}

diff_score برابر با 0.0 یعنی هیچ تغییر قابل‌مشاهده‌ای وجود ندارد؛ 1.0 یعنی هر پیکسل تغییر کرده است.


review_page_design

از یک برگه اسکرین‌شات می‌گیرد و آن را برای تحلیل بصری به مدل زبانی ارسال می‌کند. یک ارزیابی ساختاریافته را بازمی‌گرداند که چیدمان، تایپوگرافی، استفاده از رنگ، و نگرانی‌های دسترس‌پذیری را پوشش می‌دهد.

پارامترها

پارامترنوعضروریتوضیحات
urlstringبلهURL کامل برگه‌ای که باید بازبینی شود
focusstringخیرفهرست جداشده با ویرگول از حوزه‌های بازبینی برای تأکید: layout، typography، colour، accessibility، mobile. پیش‌فرض: همه حوزه‌ها
widthintegerخیرعرض viewport. پیش‌فرض 1280

بازمی‌گرداند

{
"success": true,
"screenshot_url": "https://example.com/wp-content/uploads/2026/04/review-about.png",
"assessment": {
"overall": "The page structure is clean and readable. Two accessibility issues detected.",
"layout": "Good visual hierarchy. Hero section is prominent.",
"typography": "Body text is 15px — consider increasing to 16px for readability.",
"colour": "Contrast ratio on the CTA button (#fff on #4a90e2) is 3.1:1 — below the WCAG AA threshold of 4.5:1.",
"accessibility": ["Low contrast on CTA button", "Missing alt text on hero image"],
"suggestions": ["Darken the CTA button to #1a5cb0 to pass WCAG AA", "Add descriptive alt text to the hero image"]
}
}

قابلیت‌های قابل نصب

Installable Abilities Registry به شما اجازه می‌دهد agent را با بسته‌های قابلیت اضافی که به‌صورت pluginهای WordPress توزیع می‌شوند گسترش دهید. هر بسته با استفاده از API استاندارد قابلیت، یک یا چند قابلیت را ثبت می‌کند.

list_available_abilities

کاتالوگ بسته‌های قابلیت موجود برای نصب از رجیستری را بازمی‌گرداند.

پارامترها

پارامترنوعالزامیتوضیح
categorystringخیرفیلتر بر اساس دسته‌بندی: ecommerce, seo, media, social, developer

برمی‌گرداند

{
"packs": [
{
"slug": "gratis-ai-agent-woocommerce",
"name": "WooCommerce Abilities",
"category": "ecommerce",
"version": "1.0.0",
"abilities": ["create_product", "update_pricing", "manage_inventory"],
"installed": false
}
]
}

install_ability

یک بسته توانایی را از رجیستری دانلود و فعال می‌کند.

پارامترها

پارامترنوعالزامیتوضیح
slugstringبلهslug پلاگین بسته توانایی

برمی‌گرداند { "success": true, "slug": "gratis-ai-agent-woocommerce", "abilities_added": 3 }


recommend_plugin

از رجیستری توانایی پرس‌وجو می‌کند تا بهترین پلاگین را برای یک مورد استفاده توصیف‌شده پیدا کند و، در صورت تمایل، آن را نصب کند.

پارامترها

پارامترنوعالزامیتوضیح
descriptionstringبلهتوضیح به زبان طبیعی درباره قابلیت موردنظر
installbooleanخیراگر true باشد، پلاگین پیشنهادی را فوراً نصب می‌کند. پیش‌فرض false است

مثال

{
"description": "I need a contact form with file upload support and spam protection",
"install": false
}

برمی‌گرداند

{
"recommendation": {
"slug": "contact-form-7",
"name": "Contact Form 7",
"reason": "Widely adopted, supports file uploads, and integrates with Akismet for spam filtering.",
"alternatives": ["wpforms-lite", "fluent-forms"]
}
}