دستیارها

آدرس پایه: https://api.plexit.ir/v1/assistants. نیازمند هدر Authorization: Bearer <raw_key> — به احراز هویت مراجعه کنید.

فهرست دستیارها


GET /v1/assistants

تمام دستیارهای متعلق به حسابی که کلید API شما زیر آن ساخته شده را برمی‌گرداند. هیچ صفحه‌بندی‌ای وجود ندارد — این Endpoint کل فهرست را برمی‌گرداند.

پاسخ 200


{
  "data": {
    "list": [
      {
        "id": "3f9a2c1e5b7d4a6f8c0e2b4d6f8a1c3e",
        "name": "Support Bot",
        "instruction": "Answer questions about our product using the knowledge base.",
        "model": "sol",
        "reasoning": "low",
        "status": "active",
        "description": "Customer support assistant",
        "personality": "friendly",
        "language": "en",
        "identitySettings": { "fields": ["mobile"], "otp": false },
        "ragK": null,
        "maxOutputTokens": null,
        "imageDetail": null,
        "operatorsCanViewCustomerFiles": true,
        "avatarUrl": "https://api.plexit.ir/avatars/3f9a2c1e.png",
        "planLimits": null,
        "createdAt": "2026-05-01T09:00:00.000Z"
      }
    ],
    "count": 1
  },
  "response": { "status": "success", "message": "..." }
}

فیلدهای `AssistantResponse`

فیلد	نوع	توضیح
`id`	`string`	همین مقدار را به‌عنوان `:assistantCode` در تمام Endpointهای دیگر استفاده کنید (همان `code` دستیار است).
`name`	`string`
`instruction`	`string \| null`	دستورالعمل/Prompt سیستمی پیکربندی‌شده برای این دستیار.
`model`	`string`	یک `key` از `GET /v1/models`؛ فهرست مدل‌ها بزرگ‌تر می‌شود، پس آن را ثابت ننویسید.
`reasoning`	`string`	یکی از `none`، `low`، `medium`، `high`.
`status`	`string`	یکی از `provisioning`، `active`، `provisioning_failed`، `deleting`. یک دستیار تازه‌ساخته با `provisioning` شروع می‌شود؛ فقط دستیارهای `active` قابل گفتگو هستند.
`description`	`string \| null`
`personality`	`string \| null`	یکی از `friendly`، `professional`، `playful`، `technical`، `formal`، `custom` (مقدار `custom` یعنی «بدون قالب از پیش‌تعیین‌شده — اتکا به `instruction`» و خودش یک مقدار معنادار است، نه جایگزینی برای `null`).
`language`	`string \| null`	زبان پیکربندی‌شده برای پاسخ‌های دستیار.
`identitySettings`	`object`	روش تأیید هویت بازدیدکننده برای ابزارهایی که لازم دارند: `fields` (زیرمجموعه‌ای از `mobile`، `userId`، `email`) و `otp` (آیا کد یک‌بارمصرف لازم است).
`ragK`	`number \| null`	تعداد تکه‌های دانشی که در هر نوبت بازیابی می‌شود؛ `null` یعنی پیش‌فرض.
`maxOutputTokens`	`number \| null`	سقف طول پاسخ؛ `null` یعنی پیش‌فرض.
`imageDetail`	`string \| null`	دقت خواندن تصویر پیوست‌شده؛ `null` یعنی پیش‌فرض.
`operatorsCanViewCustomerFiles`	`boolean`	آیا اپراتورهای صندوق گفتگوی تیم شما می‌توانند فایل‌های ارسالی مشتریان را باز کنند.
`avatarUrl`	`string \| null`
`planLimits`	`object \| null`	در این Endpoint همیشه `null` است.
`createdAt`	`string` (ISO 8601)

فیلدهای identitySettings تا operatorsCanViewCustomerFiles پیکربندی دستیار همان‌طور که در کنسول دیده می‌شود هستند و برای کامل بودن برگردانده می‌شوند؛ کار خود را روی id، name، status، model و reasoning بنا کنید و بقیه را اطلاعات فقط‌خواندنی‌ای بدانید که ممکن است زیاد شود.

این تنها Endpoint خواندنیِ مرتبط با دستیارها در API عمومی است — هیچ Endpoint GET /v1/assistants/:assistantCode برای یک منبع تکی وجود ندارد. فهرست را دریافت کنید و دستیار موردنظر را با id پیدا کنید.

دستیارها

فهرست دستیارها

فیلدهای AssistantResponse

مرحله‌ی بعدی

فیلدهای `AssistantResponse`