فایل‌ها

ایجاد پوشه جدید

POSThttps://api.parsget.com/api/v1/files/folder
OAuth یا Personal API Key

برای ساخت پوشه، نام آن را در name بفرستید. اگر parent_id را نفرستید یا null بگذارید، پوشه در سطح اول حساب ایجاد می‌شود. برای ساخت پوشه داخل پوشه‌ای دیگر، شناسه آن را در parent_id بفرستید. نام خالی یا تکراری در همان پوشه، با خطای اعتبارسنجی رد می‌شود.

Request body

application/jsonrequired
name
stringrequired
parent_id
stringoptional

Response schema

201پوشه با موفقیت ایجاد شد
Payloadobject
id
string
parent_id
string
شناسه پوشه‌ای که فایل یا پوشه فعلی داخل آن قرار دارد. برای مواردی که داخل هیچ پوشه‌ای نیستند، null است.
download_id
string
شناسه دانلود مرتبط با فایل یا پوشه؛ اگر دانلود مرتبطی نداشته باشد null است.
name
string
type
string
filefolder
kind
string
foldervideoaudioimagedocumentarchivesubtitleother
media
object | null
مشخصات صوتی و تصویری ویدیو؛ فقط با include_media=true در پاسخ می‌آید و برای فایل‌های غیر ویدیویی null است. GET /files خلاصه مشخصات و GET /files/{file} جزئیات کامل را برمی‌گرداند.
status
string
pendingreadyunavailable
وضعیت آماده‌سازی مشخصات رسانه: pending یعنی در انتظار آماده‌سازی، ready یعنی آماده و unavailable یعنی در دسترس نیست. وضعیت دانلود را جداگانه از status دانلود بخوانید.
title
string
عنوان ثبت‌شده در متادیتای فایل رسانه.
description
string
creation_time
string
زمان ایجاد رسانه که در متادیتای فایل ثبت شده است.
format_names
string[]
duration_ms
integerint64
مدت پخش بر حسب میلی‌ثانیه.
bitrate
integerint64
width
integer
height
integer
chapters
object[]
start_ms
integerint64
min 0
end_ms
integerint64
min 1
title
string
video_streams
object[]
index
integer
codec
string
codec_tag
string
profile
string
level
integer
width
integer
height
integer
display_aspect_ratio
string
sample_aspect_ratio
string
pixel_format
string
frame_rate
string
bitrate
integer
color_range
string
color_space
string
color_transfer
string
color_primaries
string
hdr
boolean
اگر true باشد، ویدیو HDR است.
rotation
integer
default
boolean
audio_streams
object[]
index
integer
codec
string
profile
string
channels
integer
channel_layout
string
sample_rate
integer
bitrate
integer
language
string
title
string
default
boolean
original
boolean
commentary
boolean
hearing_impaired
boolean
visual_impaired
boolean
subtitle_streams
object[]
مشخصات زیرنویس‌های داخل فایل ویدیو.
index
integer
codec
string
language
string
title
string
default
boolean
forced
boolean
original
boolean
commentary
boolean
hearing_impaired
boolean
poster
object | null
آدرس و مشخصات پوستر برای نمایش پیش‌نمایش ویدیو؛ فقط با include_poster=true در پاسخ می‌آید. اگر پوستر در دسترس نباشد، مقدار آن null است.
url
stringuri
expires_at
null
پوستر انقضای زمانی ندارد
width
integer
max 640
height
integer
mime_type
string
image/webp
dominant_color
string
رنگ غالب پوستر به‌صورت کد Hex، برای مثال برای رنگ پس‌زمینه پیش‌نمایش.
size_bytes
integerint64
min 0
mime_type
string
locked
boolean
اگر true باشد، فایل قفل است و نمی‌توانید برای آن لینک دانلود یا پخش بگیرید.
expires_at
stringdate-time
زمان انقضای فایل در حساب؛ با زمان انقضای لینک دانلود متفاوت است.
created_at
stringdate-time
updated_at
stringdate-time
app_state
object | null
داده‌هایی که برنامه شما برای این کاربر و فایل یا پوشه ذخیره کرده است، مانند موقعیت پخش ویدیو. فقط با include_state=true در پاسخ می‌آید. اگر هنوز داده‌ای ذخیره نکرده باشید، مقدار آن null است.
value
Record<string, any>
داده‌های دلخواه برنامه در قالب یک شیء JSON با حداکثر حجم ۶۴ KiB. فیلدهای داخل این شیء را خودتان تعیین می‌کنید.
version
integer
min 1
etag
string
برای ارسال If-Match، این مقدار را کامل و همراه با علامت نقل‌قول کپی کنید. ETag را از روی version نسازید.
created_at
stringdate-time
updated_at
stringdate-time