دليل API

الاستخدام والطلبات

اقرأ الرصيد المشترك للحساب، وطابق الاستخدام الأخير مع طلباتك، واستعد النتائج المخزنة بعد انتهاء مهلة العميل دون توليد جديد.

GET/usage

اقرأ الرصيد والاستخدام

تعيد الرصيد المشترك وملخص آخر 50 محاولة. استخدم next_cursor مع GET /usage?cursor=...&limit=20 لقراءة جميع المحاولات المحفوظة.

curl --request GET \
  --url https://www.lahjty.com/api/v1/usage \
  --header "Authorization: Bearer $LAHJTY_API_KEY"

Example response

response.json
{
  "object": "usage_summary",
  "plan": "business",
  "balance": 500,
  "recent_requests": 1,
  "successful_requests": 0,
  "credits_used": 0,
  "net_credits_used": 0,
  "summary_scope": "latest_50_attempts",
  "summary_limit": 50,
  "summary_truncated": false,
  "credits_used_basis": "gross_successful_generation_credits",
  "retention_days": 30,
  "is_done": true,
  "next_cursor": null,
  "requests": [
    {
      "id": "req_01jexample",
      "operation": "copy.ad_copy",
      "status": "failed",
      "credits": 2,
      "net_credits": 0,
      "partial_refund_credits": 0,
      "credits_charged": true,
      "credits_refunded": true,
      "refund_pending": false,
      "created_at": "2026-09-05T00:00:00.000Z"
    }
  ]
}
GET/requests/req_01jexample

استعد طلباً بعد انتهاء المهلة

تُحفظ سجلات الطلبات النهائية ونتائجها 30 يوماً. استخدم request_id المعاد سابقاً.

curl --request GET \
  --url https://www.lahjty.com/api/v1/requests/req_01jexample \
  --header "Authorization: Bearer $LAHJTY_API_KEY"

Example response

response.json
{
  "id": "req_01jexample",
  "object": "api_request",
  "operation": "copy.ad_copy",
  "status": "failed",
  "credits": 2,
  "net_credits": 0,
  "partial_refund_credits": 0,
  "credits_charged": true,
  "credits_refunded": true,
  "refund_pending": false,
  "status_code": 502,
  "error_code": "provider_unavailable",
  "created_at": "2026-09-05T00:00:00.000Z",
  "updated_at": "2026-09-05T00:00:05.000Z",
  "result": {
    "type": "https://www.lahjty.com/problems/provider-unavailable",
    "title": "Request failed",
    "status": 502,
    "code": "provider_unavailable",
    "detail": "The generation could not complete. Retry with the same key.",
    "request_id": "req_01jexample"
  }
}

حقول المطابقة

  • خزّن request_id من كل استجابة ناجحة أو خطأ.
  • استخدم external_id للحملة وexternal_customer_id للتاجر.
  • يحسب credits_used العملات الإجمالية للتوليد الناجح في آخر 50 محاولة، ولا يمثل صافي السجل المالي ولا يشمل استردادات نتائج القوالب اللاحقة. راجع credits_charged وcredits_refunded وrefund_pending لكل محاولة وحالة استرداد نتيجة القالب بشكل منفصل.