رفتن به محتوا
راهنمای API

تغییرات

آنچه برای کسی که با API لُب کار می‌کند تغییر کرده است، از تازه‌ترین. این‌که درون v1 چه چیزی ممکن است تغییر کند، در نسخه‌های API آمده است. تاریخ‌ها به تقویم خورشیدی‌اند.

۲۷ مهر ۱۴۰۵

Section titled “۲۷ مهر ۱۴۰۵”

سایت مستندات

Section titled “سایت مستندات”
  • همین مستندات، در docs.lobbe.ai، به انگلیسی و فارسی. مرجع API از روی همان فهرست مسیرهایی ساخته می‌شود که خود API از آن ساخته شده است.
  • برای دستیارها: llms.txt، llms-full.txt، نسخهٔ Markdown هر صفحه، و نسخه‌ای از سند OpenAPI در /openapi.json. اتصال یک دستیار هوش مصنوعی را ببینید.
  • openapi.json حالا همهٔ فیلدها و پارامترها را توضیح می‌دهد، به انگلیسی (description) و به فارسی (x-lobbe-description-fa). x-lobbe-rate-limit دستهٔ سقف درخواست‌های مسیر را هم نام می‌برد (class)، و بدنهٔ PATCH /series/{id} و PATCH /account/settings هر دو می‌گویند دست‌کم یک فیلد لازم دارند (minProperties: 1).
  • نسخهٔ Markdown جلسهٔ کامل عنوان، زیرعنوان، نام سری و نام هر گوینده را در یک سطر می‌نویسد: هر رشته از فاصله‌ها و شکست‌های سطر در آن‌ها یک فاصله می‌شود.

حالت توسعه‌دهنده

Section titled “حالت توسعه‌دهنده”
  • توکن‌ها حالا به «حالت توسعه‌دهنده» نیاز دارند، در برنامه: «حساب» › «توسعه‌دهندگان». این حالت برای حساب تازه خاموش است، و برای هر حسابی که توکنِ باطل‌نشده‌ای داشت روشن شد.
  • تا وقتی خاموش است، هر درخواستی که با توکن فرستاده شود پاسخ 403 DEVELOPER_MODE_OFF می‌گیرد. توکن‌ها متوقف می‌شوند، نه باطل: وقتی دوباره روشن شود، همان توکن‌ها دوباره کار می‌کنند. به شخص خبر بدهید و پشت سر هم دوباره امتحان نکنید؛ خطاها را ببینید.
  • توکن باطل‌شده یا منقضی همچنان پاسخ 401 TOKEN_INVALID می‌گیرد، چون توکن پیش از این حالت بررسی می‌شود.

اتصال‌ها

Section titled “اتصال‌ها”
  • توکن‌ها در «اتصال‌ها» ساخته و مدیریت می‌شوند، که جای صفحهٔ توکن‌ها در تنظیمات را گرفته است. آن‌جا از میان دسترسی‌هایی که فرم نشان می‌دهد انتخاب می‌کنید، سقف روزانه می‌گذارید، مصرف و درخواست‌های هر توکن را دنبال می‌کنید، و راه‌اندازی یک دستیار هوش مصنوعی، n8n یا curl را کپی می‌کنید.
  • naming.url حالا مستقیم نام‌گذاری گوینده‌های جلسه را برای صاحب جلسه، وقتی وارد حساب شده، باز می‌کند.
  • جلسه‌ای که توکنی فرستاده، نام آن توکن را در آرشیو و در صفحهٔ جلسه نشان می‌دهد.

۲۶ مهر ۱۴۰۵

Section titled “۲۶ مهر ۱۴۰۵”

هشت دسترسی: فرستادن، دنبال کردن، جست‌وجو، پرسش، رویدادها، سری و حساب

Section titled “هشت دسترسی: فرستادن، دنبال کردن، جست‌وجو، پرسش، رویدادها، سری و حساب”
  • هشت دسترسی، که هنگام ساختن توکن ثابت می‌شوند: recordings:read، recordings:write، recordings:query، series:read، series:write، series:query، account:read و account:write؛ توکن‌ها و دسترسی‌ها را ببینید. GET /series/readable به series:read منتقل شد، و هر توکنی که recordings:read داشت series:read را هم گرفت.
  • GET /whoami: این‌که توکن متعلق به کیست، چه دسترسی‌ها و چه سقفی دارد، و محدودیت‌های ارسال فایل. به هر توکنی پاسخ می‌دهد.
  • سقف‌های هر توکن: هر توکن برای هر دسته از مسیرها سقف درخواست جداگانه‌ای در هر ۱۰ دقیقه دارد (429 RATE_LIMITED همراه Retry-After)، و می‌تواند سقف روزانهٔ دقیقه داشته باشد (429 TOKEN_DAILY_CAP)؛ دقیقه‌ها، سقف‌ها و محدودیت‌ها را ببینید.
  • فرستادن جلسه و دنبال کردن آن (recordings:write): POST /recordings با Idempotency-Key اختیاری، و بعد GET /recordings/{id}/status، رد شدن از نام‌گذاری و اجرای دوباره؛ چرخهٔ یک جلسه را ببینید.
  • زمان برگزاری جلسه: جلسه را می‌توان همراه recordedAt فرستاد، و فهرست و جلسهٔ کامل حالا آن را دارند.
  • جست‌وجو و پرسش: GET /recordings/search، و گرفتن قیمت پرسش و خود پرسش، از یک جلسه (recordings:query) و از یک سری (series:query)؛ جست‌وجو و پرسش را ببینید.
  • فید رویدادها، GET /events: آنچه برای جلسه‌های شما رخ داده، از قدیمی‌ترین. از همین نسخه به بعد را دارد و چیزی از پیش از آن را نه؛ پرس‌وجوی دوره‌ای و فید رویدادها را ببینید.
  • قالب‌ها: جلسهٔ کامل به‌صورت Markdown، با ?format=markdown، و سند OpenAPI در https://app.lobbe.ai/api/v1/openapi.json.
  • سری و حساب: خواندن، ساختن و ویرایش سری‌ها و واژگانشان (series:read و series:write)؛ خواندن حساب، تغییر سه تنظیم آن، و خواندن و تغییر واژگان و حافظهٔ آن (account:read و account:write). سری جلسات و حساب، واژگان و حافظه را ببینید.

۷ مهر ۱۴۰۵

Section titled “۷ مهر ۱۴۰۵”

سری‌ها با توکن

Section titled “سری‌ها با توکن”
  • GET /series/readable: سری‌هایی که ساخته‌اید و سری‌هایی که عضوشان شده‌اید. آن زمان به recordings:read نیاز داشت؛ از ۲۶ مهر ۱۴۰۵ به series:read.
  • GET /recordings/ready پارامتر seriesId را می‌پذیرد، برای جلسه‌های آمادهٔ یک سری، و هر آیتم فهرست series را دارد.
  • جلسهٔ کامل، جلسه‌ای از سری‌ای را که عضوش شده‌اید هم می‌خواند، با recording.access برابر member.
  • cursor فهرست تغییر کرد. صفحهٔ بعد حالا درست پس از آخرین جلسه‌ای که گرفته‌اید شروع می‌شود، پس اگر جلسه‌ای میان دو صفحه از فهرست بیرون برود، دیگر جلسهٔ بعد از آن از قلم نمی‌افتد. cursorی که پیش از این تغییر گرفته شده باشد پاسخ 400 VALIDATION می‌گیرد.

عنوان جلسه‌های سری

Section titled “عنوان جلسه‌های سری”
  • آیتم‌های فهرست و جلسهٔ کامل displayTitle را گرفتند، یعنی عنوان همان‌طور که برنامه نشان می‌دهد، و جلسهٔ کامل subtitle را هم. در سری‌ای که عنوان جلسه‌هایش «نام سری + تاریخ» است، displayTitle نام سری و تاریخ جلسه است و عنوان خود جلسه به subtitle می‌رود. title تغییری نمی‌کند.

۲۸ شهریور ۱۴۰۵

Section titled “۲۸ شهریور ۱۴۰۵”

فهرست جلسه‌های آماده

Section titled “فهرست جلسه‌های آماده”
  • GET /recordings/ready: جلسه‌های آمادهٔ شما، از تازه‌ترین، هر بار به تعداد limit (از ۱ تا ۱۰۰، به‌طور پیش‌فرض ۲۰)، صفحه به صفحه با cursor. هر آیتم id، title، kind، createdAt، durationSeconds، url و bundleUrl خود را دارد.
  • مثل جلسهٔ کامل به recordings:read نیاز دارد، پس هر توکنی از همان اول می‌توانست آن را بخواند.

۲۲ شهریور ۱۴۰۵

Section titled “۲۲ شهریور ۱۴۰۵”

توکن‌های شخصی API و جلسهٔ کامل

Section titled “توکن‌های شخصی API و جلسهٔ کامل”
  • توکن‌های شخصی API که در برنامه ساخته می‌شوند: lobbe_…، که فقط یک بار نمایش داده می‌شوند، هم‌زمان تا ۱۰ توکن فعال، با انقضا پس از ۳۰، ۹۰ یا ۳۶۵ روز یا بدون انقضا، و هر وقت بخواهید می‌توانید باطلشان کنید.
  • GET /recordings/{id}/bundle: یک جلسهٔ آماده، با مشخصاتش، رونوشتش همراه نام گوینده‌ها، آخرین لُب آن و آمارش. جلسه‌ای که هنوز آماده نیست پاسخ 409 NOT_READY را همراه details.status می‌گیرد.
  • این تنها مسیری بود که توکن به آن دسترسی داشت.