سندها

بارگذاری سند در یک فضای کاری و دنبال کردن روند پردازشش.

سند همان فایلی است که بارگذاری می‌کنید. بارگذاری، خط پردازش ناهم‌زمانی را شروع می‌کند؛ تنها وقتی می‌شود از آن پاسخ گرفت که این خط به وضعیت ready برسد.

فهرست سندها

سندهای فضای کاری را از جدیدترین فهرست می‌کند. پیش از آن‌که فرض کنید سندی قابل پرسش است، status را ببینید.

GET/workspaces/{workspace_id}/resources/

فیلد	نوع	توضیح
`page`	`integer`	شمارهٔ صفحه، از ۱ شروع می‌شود. پیش‌فرض ۱ است.
`page_size`	`integer`	تعداد نتیجه در هر صفحه. پیش‌فرض ۳۰ و حداکثر ۲۰۰.

cURL

JavaScript

Python

curl "https://api.daneshyar.info/api/v1/workspaces/8f14e45f-ceea-467a-9f4c-1a2b3c4d5e6f/resources/" \
  -H "X-API-Key: dk_live_9f3aC2xQ7mB1vT8sE4nK6pR0jY5wZ2hL"

بارگذاری سند

فایل را بارگذاری و برای پردازش صف می‌کند. درخواست از نوع multipart است و پاسخ بی‌درنگ با وضعیت queued برمی‌گردد — پردازش هنوز اجرا نشده است.

POST/workspaces/{workspace_id}/resources/

فیلد	نوع	توضیح
`file` (الزامی)	`file`	سندی که باید پردازش شود. PDF، JPG/PNG، MP3/WAV یا MP4/MOV، تا ۱۰۰ مگابایت.
`title`	`string`	نام نمایشی. اگر ندهید، نام خود فایل استفاده می‌شود.

فایل‌های پذیرفته‌شده:

نوع	پسوندها	توضیح
`pdf`	PDF	سند. متن صفحه‌به‌صفحه استخراج می‌شود.
`image`	JPG · JPEG · PNG	تصویر. مدل توصیفش می‌کند و بخش خواندنی تولید نمی‌کند.
`voice`	MP3 · WAV	صوت. رونویسی می‌شود و زمان هر بخش نگه داشته می‌شود.
`video`	MP4 · MOV	ویدیو. باند صوتی‌اش به همان روش رونویسی می‌شود.

cURL

JavaScript

Python

curl -X POST "https://api.daneshyar.info/api/v1/workspaces/8f14e45f-ceea-467a-9f4c-1a2b3c4d5e6f/resources/" \
  -H "X-API-Key: dk_live_9f3aC2xQ7mB1vT8sE4nK6pR0jY5wZ2hL" \
  -F "file=@discharge-protocol-2026.pdf" \
  -F "title=Discharge protocol 2026"

پاسخ

{
  "status": "ok",
  "data": {
    "id": "3c9a1b77-0d24-4e8b-b0f1-7a5e9c2d4b81",
    "title": "Discharge protocol 2026.pdf",
    "type": "pdf",
    "file_url": "https://api.daneshyar.info/media/resources/discharge-protocol-2026.pdf",
    "extension": "pdf",
    "size": 482913,
    "status": "queued",
    "summary": "",
    "key_notes": [],
    "error_message": "",
    "workspace_id": "8f14e45f-ceea-467a-9f4c-1a2b3c4d5e6f",
    "created_at": "2026-08-05T09:20:41.702Z",
    "updated_at": "2026-08-05T09:20:41.702Z"
  }
}

نوع فایل از پسوندش تشخیص داده می‌شود، پس هرگز خودتان نمی‌فرستیدش. پسوند پشتیبانی‌نشده یا فایل بزرگ‌تر از ۱۰۰ مگابایت، پیش از صف شدن با خطای ۴۰۰ رد می‌شود.

خواندن یک سند

یک سند را همراه با وضعیت فعلی‌اش برمی‌گرداند. همین مسیر را در انتظار پایان پردازش می‌خوانید.

GET/workspaces/{workspace_id}/resources/{resource_id}/

فیلد	نوع	توضیح
`id`	`uuid`	شناسهٔ یکتا که سرور تولید می‌کند.
`title`	`string`	نام نمایشی. اگر ندهید، نام خود فایل استفاده می‌شود.
`type`	`pdf \| image \| voice \| video \| text`	از پسوند فایل تشخیص داده می‌شود؛ خودتان تعیینش نمی‌کنید.
`file_url`	`string`	نشانی مستقیم فایل اصلی ذخیره‌شده.
`extension`	`string`	پسوند فایل با حروف کوچک، بدون نقطه.
`size`	`integer`	حجم فایل بر حسب بایت.
`status`	`queued \| vectorizing \| ready \| limited \| failed`	جای سند در خط پردازش. فقط از سندی که ready است می‌شود پاسخ گرفت.
`summary`	`string`	خلاصه‌ای که مدل از سند می‌نویسد. تا پایان پردازش خالی است.
`key_notes`	`object[]`	نکته‌های استخراج‌شده؛ هر کدام یک شیء شامل متن نکته و — به‌جز برای تصویرها — اطلاعات منبع آن.
`error_message`	`string`	دلیل شکست پردازش. تا وقتی وضعیت failed نشده خالی است.
`workspace_id`	`uuid`	فضای کاری‌ای که این سند به آن تعلق دارد.
`created_at`	`datetime`	زمان ساخت، با قالب ISO 8601.
`updated_at`	`datetime`	زمان آخرین تغییر، با قالب ISO 8601.

cURL

JavaScript

Python

curl "https://api.daneshyar.info/api/v1/workspaces/8f14e45f-ceea-467a-9f4c-1a2b3c4d5e6f/resources/3c9a1b77-0d24-4e8b-b0f1-7a5e9c2d4b81/" \
  -H "X-API-Key: dk_live_9f3aC2xQ7mB1vT8sE4nK6pR0jY5wZ2hL"

پاسخ

{
  "status": "ok",
  "data": {
    "id": "3c9a1b77-0d24-4e8b-b0f1-7a5e9c2d4b81",
    "title": "Discharge protocol 2026.pdf",
    "type": "pdf",
    "file_url": "https://api.daneshyar.info/media/resources/discharge-protocol-2026.pdf",
    "extension": "pdf",
    "size": 482913,
    "status": "ready",
    "summary": "A twelve-page protocol covering post-operative discharge criteria...",
    "key_notes": [
      {
        "note": "Patients on anticoagulants require a 48-hour observation window.",
        "metadata": { "source_type": "pdf", "page": 4, "line": 112 }
      }
    ],
    "error_message": "",
    "workspace_id": "8f14e45f-ceea-467a-9f4c-1a2b3c4d5e6f",
    "created_at": "2026-08-05T09:20:41.702Z",
    "updated_at": "2026-08-05T09:23:07.884Z"
  }
}

پردازش دوبارهٔ یک سند

سندی را که پردازشش متوقف شده دوباره وارد خط پردازش می‌کند. فقط از وضعیت limited (سرویس هوش مصنوعی وسط کار محدودمان کرده) یا failed پذیرفته می‌شود و هر وضعیت دیگری خطای ۴۰۰ می‌گیرد. پشت این درخواست هیچ تلاش خودکاری وجود ندارد؛ پس برای سند limited تنها راه به‌سرانجام‌رسیدن، همین فراخوانی است.

پردازش از سر گرفته می‌شود، نه از صفر: اگر متن استخراج‌شده از قبل ذخیره شده باشد، استخراج و خلاصه‌سازی رد می‌شوند و فقط نمایه‌سازی دوباره اجرا می‌شود. پاسخ، همان سند با وضعیت queued است؛ پس دقیقاً مثل بعد از بارگذاری، همان مسیر را تا پایان پردازش بخوانید.

POST/workspaces/{workspace_id}/resources/{resource_id}/retry/

cURL

JavaScript

Python

curl -X POST "https://api.daneshyar.info/api/v1/workspaces/8f14e45f-ceea-467a-9f4c-1a2b3c4d5e6f/resources/3c9a1b77-0d24-4e8b-b0f1-7a5e9c2d4b81/retry/" \
  -H "X-API-Key: dk_live_9f3aC2xQ7mB1vT8sE4nK6pR0jY5wZ2hL"

حذف سند

سند و بخش‌های پردازش‌شده‌اش را حذف می‌کند. پاسخ‌هایی که قبلاً داده شده‌اند ارجاع‌هایشان را نگه می‌دارند، اما آن سند دیگر بازیابی نمی‌شود.

DELETE/workspaces/{workspace_id}/resources/{resource_id}/

cURL

JavaScript

Python

curl -X DELETE "https://api.daneshyar.info/api/v1/workspaces/8f14e45f-ceea-467a-9f4c-1a2b3c4d5e6f/resources/3c9a1b77-0d24-4e8b-b0f1-7a5e9c2d4b81/" \
  -H "X-API-Key: dk_live_9f3aC2xQ7mB1vT8sE4nK6pR0jY5wZ2hL"

پاسخ

{
  "status": "ok",
  "data": { "message": "Resource deleted" }
}

page

integer

شمارهٔ صفحه، از ۱ شروع می‌شود. پیش‌فرض ۱ است.

page_size

integer

تعداد نتیجه در هر صفحه. پیش‌فرض ۳۰ و حداکثر ۲۰۰.

file

سندی که باید پردازش شود. PDF، JPG/PNG، MP3/WAV یا MP4/MOV، تا ۱۰۰ مگابایت.

title

string

نام نمایشی. اگر ندهید، نام خود فایل استفاده می‌شود.

pdf

PDF

سند. متن صفحه‌به‌صفحه استخراج می‌شود.

image

JPG · JPEG · PNG

تصویر. مدل توصیفش می‌کند و بخش خواندنی تولید نمی‌کند.

voice

MP3 · WAV

صوت. رونویسی می‌شود و زمان هر بخش نگه داشته می‌شود.

video

MP4 · MOV

ویدیو. باند صوتی‌اش به همان روش رونویسی می‌شود.

curl -X POST "https://api.daneshyar.info/api/v1/workspaces/8f14e45f-ceea-467a-9f4c-1a2b3c4d5e6f/resources/" \ -H "X-API-Key: dk_live_9f3aC2xQ7mB1vT8sE4nK6pR0jY5wZ2hL" \ -F "file=@discharge-protocol-2026.pdf" \ -F "title=Discharge protocol 2026"

{ "status": "ok", "data": { "id": "3c9a1b77-0d24-4e8b-b0f1-7a5e9c2d4b81", "title": "Discharge protocol 2026.pdf", "type": "pdf", "file_url": "https://api.daneshyar.info/media/resources/discharge-protocol-2026.pdf", "extension": "pdf", "size": 482913, "status": "queued", "summary": "", "key_notes": [], "error_message": "", "workspace_id": "8f14e45f-ceea-467a-9f4c-1a2b3c4d5e6f", "created_at": "2026-08-05T09:20:41.702Z", "updated_at": "2026-08-05T09:20:41.702Z" } }

id

uuid

شناسهٔ یکتا که سرور تولید می‌کند.

title

string

نام نمایشی. اگر ندهید، نام خود فایل استفاده می‌شود.

type

pdf | image | voice | video | text

از پسوند فایل تشخیص داده می‌شود؛ خودتان تعیینش نمی‌کنید.

file_url

string

نشانی مستقیم فایل اصلی ذخیره‌شده.

extension

string

پسوند فایل با حروف کوچک، بدون نقطه.

size

integer

حجم فایل بر حسب بایت.

status

queued | vectorizing | ready | limited | failed

جای سند در خط پردازش. فقط از سندی که ready است می‌شود پاسخ گرفت.

summary

string

خلاصه‌ای که مدل از سند می‌نویسد. تا پایان پردازش خالی است.

key_notes

object[]

نکته‌های استخراج‌شده؛ هر کدام یک شیء شامل متن نکته و — به‌جز برای تصویرها — اطلاعات منبع آن.

error_message

string

دلیل شکست پردازش. تا وقتی وضعیت failed نشده خالی است.

workspace_id

uuid

فضای کاری‌ای که این سند به آن تعلق دارد.

created_at

datetime

زمان ساخت، با قالب ISO 8601.

updated_at

datetime

زمان آخرین تغییر، با قالب ISO 8601.

{ "status": "ok", "data": { "id": "3c9a1b77-0d24-4e8b-b0f1-7a5e9c2d4b81", "title": "Discharge protocol 2026.pdf", "type": "pdf", "file_url": "https://api.daneshyar.info/media/resources/discharge-protocol-2026.pdf", "extension": "pdf", "size": 482913, "status": "ready", "summary": "A twelve-page protocol covering post-operative discharge criteria...", "key_notes": [ { "note": "Patients on anticoagulants require a 48-hour observation window.", "metadata": { "source_type": "pdf", "page": 4, "line": 112 } } ], "error_message": "", "workspace_id": "8f14e45f-ceea-467a-9f4c-1a2b3c4d5e6f", "created_at": "2026-08-05T09:20:41.702Z", "updated_at": "2026-08-05T09:23:07.884Z" } }

پردازش دوبارهٔ یک سند

curl -X POST "https://api.daneshyar.info/api/v1/workspaces/8f14e45f-ceea-467a-9f4c-1a2b3c4d5e6f/resources/3c9a1b77-0d24-4e8b-b0f1-7a5e9c2d4b81/retry/" \ -H "X-API-Key: dk_live_9f3aC2xQ7mB1vT8sE4nK6pR0jY5wZ2hL"

curl -X DELETE "https://api.daneshyar.info/api/v1/workspaces/8f14e45f-ceea-467a-9f4c-1a2b3c4d5e6f/resources/3c9a1b77-0d24-4e8b-b0f1-7a5e9c2d4b81/" \ -H "X-API-Key: dk_live_9f3aC2xQ7mB1vT8sE4nK6pR0jY5wZ2hL"