فضاهای کاری

ساخت، خواندن، ویرایش و حذف مجموعه‌هایی که سندهایتان را نگه می‌دارند.

فضای کاری سندهایی را نگه می‌دارد که با هم پاسخ می‌دهند. واحد جداسازی در این API همین است: بازیابی هرگز از یک فضای کاری به فضای دیگر سرریز نمی‌کند.

فهرست فضاهای کاری

همهٔ فضاهای کاری زیر اپی که کلید محرمانه‌تان به آن تعلق دارد را برمی‌گرداند، از جدیدترین.

GET/workspaces/

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

cURL

JavaScript

Python

curl "https://api.daneshyar.info/api/v1/workspaces/?page_size=50" \
  -H "X-API-Key: sk_9f3aC2xQ7mB1vT8sE4nK6pR0jY5wZ2hL"

پاسخ

{
  "status": "ok",
  "data": {
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
      {
        "id": "8f14e45f-ceea-467a-9f4c-1a2b3c4d5e6f",
        "title": "Cardiology intake",
        "description": "Patient handbooks and discharge protocols",
        "created_at": "2026-08-05T09:14:22.118Z",
        "updated_at": "2026-08-05T09:14:22.118Z"
      }
    ]
  }
}

ساخت فضای کاری

یک فضای کاری می‌سازد. فقط title الزامی است؛ description متن آزادی است که هرطور خواستید از آن استفاده می‌کنید.

POST/workspaces/

فیلد	نوع	توضیح
`title` (الزامی)	`string`	نام خوانای فضای کاری.
`description`	`string`	توضیح بلندتر، اختیاری.

cURL

JavaScript

Python

curl -X POST "https://api.daneshyar.info/api/v1/workspaces/" \
  -H "X-API-Key: sk_9f3aC2xQ7mB1vT8sE4nK6pR0jY5wZ2hL" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Cardiology intake",
    "description": "Patient handbooks and discharge protocols"
  }'

پاسخ

{
  "status": "ok",
  "data": {
    "id": "8f14e45f-ceea-467a-9f4c-1a2b3c4d5e6f",
    "title": "Cardiology intake",
    "description": "Patient handbooks and discharge protocols",
    "created_at": "2026-08-05T09:14:22.118Z",
    "updated_at": "2026-08-05T09:14:22.118Z"
  }
}

خواندن یک فضای کاری

یک فضای کاری را برمی‌گرداند. فضای کاری متعلق به اپ دیگر خطای ۴۰۴ می‌دهد، نه ۴۰۳ — این API تأیید نمی‌کند که شناسه‌های بیرون از اپ شما اصلاً وجود دارند.

GET/workspaces/{workspace_id}/

فیلد	نوع	توضیح
`id`	`uuid`	شناسهٔ یکتا که سرور تولید می‌کند.
`title`	`string`	نام خوانای فضای کاری.
`description`	`string`	توضیح بلندتر، اختیاری.
`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/" \
  -H "X-API-Key: sk_9f3aC2xQ7mB1vT8sE4nK6pR0jY5wZ2hL"

ویرایش فضای کاری

فضای کاری را ویرایش می‌کند. بدنه جزئی است: فقط فیلدهایی را که تغییر می‌دهید بفرستید.

PUT/workspaces/{workspace_id}/

cURL

JavaScript

Python

curl -X PUT "https://api.daneshyar.info/api/v1/workspaces/8f14e45f-ceea-467a-9f4c-1a2b3c4d5e6f/" \
  -H "X-API-Key: sk_9f3aC2xQ7mB1vT8sE4nK6pR0jY5wZ2hL" \
  -H "Content-Type: application/json" \
  -d '{ "title": "Cardiology intake (2026)" }'

حذف فضای کاری

فضای کاری، سندها و تاریخچهٔ گفت‌وگویش را حذف می‌کند. برگشت‌پذیر نیست و حذف نرم یا سطل بازیافتی وجود ندارد.

حذف یک فضای کاری همهٔ سندهای داخلش و همهٔ گفت‌وگوهای دربارهٔ آن را از بین می‌برد. هیچ چیزی در این API نمی‌تواند این کار را برگرداند.

DELETE/workspaces/{workspace_id}/

cURL

JavaScript

Python

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

پاسخ

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

page

integer

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

page_size

integer

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

{ "status": "ok", "data": { "count": 2, "next": null, "previous": null, "results": [ { "id": "8f14e45f-ceea-467a-9f4c-1a2b3c4d5e6f", "title": "Cardiology intake", "description": "Patient handbooks and discharge protocols", "created_at": "2026-08-05T09:14:22.118Z", "updated_at": "2026-08-05T09:14:22.118Z" } ] } }

title

string

نام خوانای فضای کاری.

description

string

توضیح بلندتر، اختیاری.

curl -X POST "https://api.daneshyar.info/api/v1/workspaces/" \ -H "X-API-Key: sk_9f3aC2xQ7mB1vT8sE4nK6pR0jY5wZ2hL" \ -H "Content-Type: application/json" \ -d '{ "title": "Cardiology intake", "description": "Patient handbooks and discharge protocols" }'

{ "status": "ok", "data": { "id": "8f14e45f-ceea-467a-9f4c-1a2b3c4d5e6f", "title": "Cardiology intake", "description": "Patient handbooks and discharge protocols", "created_at": "2026-08-05T09:14:22.118Z", "updated_at": "2026-08-05T09:14:22.118Z" } }

id

uuid

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

title

string

نام خوانای فضای کاری.

description

string

توضیح بلندتر، اختیاری.

created_at

datetime

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

updated_at

datetime

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

curl -X PUT "https://api.daneshyar.info/api/v1/workspaces/8f14e45f-ceea-467a-9f4c-1a2b3c4d5e6f/" \ -H "X-API-Key: sk_9f3aC2xQ7mB1vT8sE4nK6pR0jY5wZ2hL" \ -H "Content-Type: application/json" \ -d '{ "title": "Cardiology intake (2026)" }'

حذف فضای کاری

فضای کاری، سندها و تاریخچهٔ گفت‌وگویش را حذف می‌کند. برگشت‌پذیر نیست و حذف نرم یا سطل بازیافتی وجود ندارد.