دانلودها

لغو دانلود

POSThttps://api.parsget.com/api/v1/downloads/{download}/cancel

OAuth یا Personal API Key

فرایند دانلود در حال اجرا را لغو می‌کند. قبل از نمایش دکمه، فیلد can_cancel را بررسی کنید.

OAuth Scope: downloads:write

Parameters

Field	Type	Description
`download`	`string · path`required	شناسه یکتای دانلود

Response schema

200مشخصات دانلود پس از لغو

Payloadobject

Field	Type	Description
`id`	`string`	—
`client_reference`	`string`	برچسب دلخواه برای ارتباط دانلود با داده‌های برنامه شما، مثلاً شناسه قسمت یک مجموعه. چند دانلود می‌توانند برچسب یکسان داشته باشند.
`name`	`string`	—
`status`	`string` `queuedprocessingdownloadingfinalizingcompletedblockedfailedcanceled`	وضعیت دانلود. queued یعنی در صف، processing یعنی در حال بررسی و آماده‌سازی دانلود، downloading یعنی دریافت فایل و finalizing یعنی آماده‌سازی نهایی. completed یعنی تکمیل شده، blocked یعنی نیازمند پرداخت، failed یعنی ناموفق و canceled یعنی لغوشده.
`activity`	`string` `seedingnull`	پس از تکمیل تورنت، ممکن است ارسال فایل به دیگر کاربران تورنت ادامه داشته باشد. در این حالت، activity برابر seeding و status برابر completed است.
`source`	`object`
`type`	`string` `urltorrentusenet`	—
`hash`	`string`	هش تورنت (فقط برای دانلودهای تورنت مقدار دارد)
`host`	`string`	کد سرویس دانلود؛ برای اطلاعات سرویس آن را با code در GET /services تطبیق دهید.
`file_id`	`string`	شناسه فایل ایجادشده پس از تکمیل موفق دانلود
`mime_type`	`string`	—
`size_bytes`	`integer`int64	—
`progress`	`object`
`percent`	`number`float min 0max 100	درصد پیشرفت دانلود از ۰ تا ۱۰۰.
`bytes_completed`	`integer`int64 min 0	حجم دریافت‌شده بر حسب بایت.
`speed_bytes_per_second`	`number` min 0	سرعت دریافت بر حسب بایت بر ثانیه؛ اگر مشخص نباشد null است.
`eta_seconds`	`number` min 0	زمان تخمینی باقی‌مانده بر حسب ثانیه؛ اگر مشخص نباشد null است.
`can_cancel`	`boolean`	اگر true باشد، می‌توانید دانلود را لغو کنید. دکمه لغو را بر اساس این مقدار نمایش دهید.
`can_retry`	`boolean`	اگر true باشد، می‌توانید دانلود را دوباره شروع کنید. دکمه تلاش مجدد را بر اساس این مقدار نمایش دهید.
`error`	`object \| null`
`code`	`string` `source_unavailabledownload_expiredquota_exceededdownload_failed`	—
`message`	`string`	—
`created_at`	`string`date-time	—
`updated_at`	`string`date-time	—
`completed_at`	`string`date-time	—
`attempt`	`integer` min 1	شماره تلاش دانلود، از ۱. با شروع موفق یک تلاش جدید از طریق endpoint retry افزایش می‌یابد.

پاسخ‌های خطاساختار استاندارد error

Example

{
  "data": {
    "id": "01M1BDA500B4A6D9K3N5R7T8VC",
    "client_reference": "episode-42",
    "name": "big-buck-bunny.mp4",
    "status": "canceled",
    "activity": null,
    "source": {
      "type": "url",
      "hash": null
    },
    "host": "youtube",
    "file_id": null,
    "mime_type": "video/mp4",
    "size_bytes": 1073741824,
    "progress": {
      "percent": 42.5,
      "bytes_completed": 456130560,
      "speed_bytes_per_second": 0,
      "eta_seconds": null
    },
    "can_cancel": false,
    "can_retry": true,
    "error": null,
    "created_at": "2026-08-31T08:00:00.000000Z",
    "updated_at": "2026-08-31T08:05:00.000000Z",
    "completed_at": null,
    "attempt": 1
  }
}