محتوای هوش مصنوعی

یادداشت‌ها
سطح تخصصی
کلید API باید به عنوان توکن Bearer در هدر Authorization درخواست ارسال شود. کلید API خود را دریافت کنید.
بررسی ویژگی

نقطه پایانی API:

GET 
https://checkmysite.ir/api/v1/ai/feature-check

مثال درخواست: 

curl --location --request GET 'https://checkmysite.ir/api/v1/ai/feature-check' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
موجودی

نقطه پایانی API:

GET 
https://checkmysite.ir/api/v1/ai/balance

مثال درخواست: 

curl --location --request GET 'https://checkmysite.ir/api/v1/ai/balance' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
تخمین

نقطه پایانی API:

POST 
https://checkmysite.ir/api/v1/ai/estimate

مثال درخواست: 

curl --location --request POST 'https://checkmysite.ir/api/v1/ai/estimate' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}' \
--data-raw '{"type": "text", "options": {}}'

پارامترها:

پارامتر
نوع
توضیحات
type
ضروری string
نوع محتوا: text، article، image، meta، title، description، other.
options
اختیاری array
اختیاری. گزینه‌های اضافی برای نوع محتوا.
تولید

نقطه پایانی API:

POST 
https://checkmysite.ir/api/v1/ai/generate

مثال درخواست: 

curl --location --request POST 'https://checkmysite.ir/api/v1/ai/generate' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}' \
--data-raw '{"type": "text", "prompt": "Write a short poem", "confirm_cost": true}'

پارامترها:

پارامتر
نوع
توضیحات
type
ضروری string
نوع محتوا: text، article، image، meta، title، description.
prompt
ضروری string
پرامپت یا دستورالعمل برای تولید محتوا. برای انواع متن، مقاله و تصویر ضروری است.
options
اختیاری array
اختیاری. گزینه‌های اختصاصی نوع:
confirm_cost
اختیاری boolean
برای تأیید هزینه تخمینی و ادامه تولید روی true تنظیم شود. اگر تنظیم نشود، API هزینه تخمینی را بدون تولید برمی‌گرداند.
یادداشت: اولین درخواست بدون confirm_cost اعتبار تخمینی را برمی‌گرداند. درخواست دوم با confirm_cost: true برای ادامه ارسال کنید.
بسته‌ها

نقطه پایانی API:

GET 
https://checkmysite.ir/api/v1/ai/packages

مثال درخواست: 

curl --location --request GET 'https://checkmysite.ir/api/v1/ai/packages' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
خرید

نقطه پایانی API:

POST 
https://checkmysite.ir/api/v1/ai/purchase

مثال درخواست: 

curl --location --request POST 'https://checkmysite.ir/api/v1/ai/purchase' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}' \
--data-raw '{"package_id": 1}'

پارامترها:

پارامتر
نوع
توضیحات
package_id
ضروری integer
شناسه بسته اعتباری برای خرید.
یادداشت: این نقطه پایانی یک سفارش پرداخت ایجاد می‌کند. پاسخ شامل payment_url است که کاربر باید برای تکمیل پرداخت به آن هدایت شود.
تراکنش‌ها

نقطه پایانی API:

GET 
https://checkmysite.ir/api/v1/ai/transactions

مثال درخواست: 

curl --location --request GET 'https://checkmysite.ir/api/v1/ai/transactions' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

پارامترها:

پارامتر
نوع
توضیحات
type
اختیاری string
فیلتر بر اساس نوع: purchase، usage، plan_reset، refund، admin_adjustment.
limit
اختیاری integer
تعداد نتایج در هر صفحه. پیش‌فرض: 20.
page
اختیاری integer
شماره صفحه. پیش‌فرض: 1.
تاریخچه تولید

نقطه پایانی API:

GET 
https://checkmysite.ir/api/v1/ai/history

مثال درخواست: 

curl --location --request GET 'https://checkmysite.ir/api/v1/ai/history' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

پارامترها:

پارامتر
نوع
توضیحات
type
اختیاری string
فیلتر بر اساس نوع: text، article، image، meta، title، description.
limit
اختیاری integer
تعداد نتایج در هر صفحه. پیش‌فرض: 20.
page
اختیاری integer
شماره صفحه. پیش‌فرض: 1.