تخطَّ إلى المحتوى

هذه الوثائق متاحة حاليًا باللغة الإنجليزية فقط.

وثائق المطورينAPI referenceAccount

Get limits

The limits that apply to your organization and the rate card new jobs are priced with.

GEThttps://runner.cargoduo.com/v1/limits

المصادقة

مفتاح API من نوع Bearer بالصلاحيةaccount:readاعرف المزيد

مثال على الطلب

curl -X GET "https://runner.cargoduo.com/v1/limits" \
  -H "Authorization: Bearer $CARGODUO_API_KEY"

مثال على الاستجابة

200 OK · Limits
{
  "max_items_per_request": 2000,
  "max_vehicles_per_request": 20,
  "max_time_limit_seconds": 90,
  "allowed_vehicle_types": [
    "truck",
    "trailer",
    "container",
    "pallet"
  ],
  "concurrency": 1,
  "max_queued_jobs": 20,
  "rate_limits": {
    "per_minute": 60,
    "per_hour": 1000,
    "per_day": 5000
  },
  "retention_days": 14,
  "rate_card": {
    "version": 1,
    "per_job": 0.06,
    "per_vehicle": 0.2,
    "per_compute_second": 0.005,
    "large_load_threshold": 500,
    "per_hundred_items_over": 0.02
  }
}

الاستجابات

  • 200OKLimits and rate card.
    الاسمالنوعمطلوبالوصف
    max_items_per_requestinteger
    integer
    لا

    Most item units (sum of quantities) per job.

    max_vehicles_per_requestinteger
    integer
    لا

    Most vehicles a job may list and load (auto-added ones included).

    max_time_limit_secondsinteger
    integer
    لا

    Compute budget ceiling per job.

    allowed_vehicle_typesstring[]
    string[]
    لا

    Vehicle types the API accepts.

    concurrencyinteger
    integer
    لا

    Jobs of your organization computing at the same time; more wait in the queue.

    max_queued_jobsinteger
    integer
    لا

    Queued + running jobs per organization.

    rate_limitsRateLimits
    RateLimits
    لا

    Requests per window, per key and per organization.

    retention_daysinteger
    integer
    لا

    Days request/result bodies and PDF links are kept.

    rate_cardRateCard
    RateCard
    لا

    Prices in credits (1 credit = 1 USD).

  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedMissing, malformed or unknown API key.
    • key_revokedThe key was revoked.
    • key_expiredThe key passed its expiry date.
    الاسمالنوعمطلوبالوصف
    errorErrorBodyمطلوب
    ErrorBody
    نعم
    كل رموز الأخطاء
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_not_allowedThe calling IP is not on the key's allowlist.
    • subscription_inactiveThe organization has no active subscription that includes the API.
    • account_inactiveThe organization is suspended, or has no owner whose account is active.
    • scope_missingThe key lacks a scope this endpoint needs.
    الاسمالنوعمطلوبالوصف
    errorErrorBodyمطلوب
    ErrorBody
    نعم
    كل رموز الأخطاء
  • 429Too many requestsrate_limited
    • rate_limitedToo many requests in the current minute, hour or day (per key or per organization), or more than 60 failed authentications per minute from your IP address.
    الاسمالنوعمطلوبالوصف
    errorErrorBodyمطلوب
    ErrorBody
    نعم
    كل رموز الأخطاء
  • 500Internal server errorinternal_error
    • internal_errorSomething failed on our side.
    الاسمالنوعمطلوبالوصف
    errorErrorBodyمطلوب
    ErrorBody
    نعم
    كل رموز الأخطاء
  • 503Service unavailableapi_disabled
    • api_disabledThe API is temporarily disabled (maintenance) or switched off for the organization.
    الاسمالنوعمطلوبالوصف
    errorErrorBodyمطلوب
    ErrorBody
    نعم
    كل رموز الأخطاء